FrontendScriptApi.html 83 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: FrontendScriptApi</title>
  6. <script src="scripts/prettify/prettify.js"> </script>
  7. <script src="scripts/prettify/lang-css.js"> </script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  12. <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">Class: FrontendScriptApi</h1>
  17. <section>
  18. <header>
  19. <h2><span class="attribs"><span class="type-signature"></span></span>FrontendScriptApi</h2>
  20. </header>
  21. <article>
  22. <div class="container-overview">
  23. <dl class="details">
  24. <dt class="tag-source">Source:</dt>
  25. <dd class="tag-source"><ul class="dummy"><li>
  26. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line23">line 23</a>
  27. </li></ul></dd>
  28. </dl>
  29. </div>
  30. <h3 class="subsection-title">Members</h3>
  31. <h4 class="name" id="$container"><span class="type-signature"></span>$container<span class="type-signature"></span></h4>
  32. <h5 class="subsection-title">Properties:</h5>
  33. <table class="props">
  34. <thead>
  35. <tr>
  36. <th>Name</th>
  37. <th>Type</th>
  38. <th class="last">Description</th>
  39. </tr>
  40. </thead>
  41. <tbody>
  42. <tr>
  43. <td class="name"><code>container</code></td>
  44. <td class="type">
  45. <span class="param-type">jQuery</span>
  46. </td>
  47. <td class="description last">of all the rendered script content</td>
  48. </tr>
  49. </tbody>
  50. </table>
  51. <dl class="details">
  52. <dt class="tag-source">Source:</dt>
  53. <dd class="tag-source"><ul class="dummy"><li>
  54. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line27">line 27</a>
  55. </li></ul></dd>
  56. </dl>
  57. <h4 class="name" id="BasicWidget"><span class="type-signature"></span>BasicWidget<span class="type-signature"></span></h4>
  58. <h5 class="subsection-title">Properties:</h5>
  59. <table class="props">
  60. <thead>
  61. <tr>
  62. <th>Type</th>
  63. <th class="last">Description</th>
  64. </tr>
  65. </thead>
  66. <tbody>
  67. <tr>
  68. <td class="type">
  69. <span class="param-type">BasicWidget</span>
  70. </td>
  71. <td class="description last"></td>
  72. </tr>
  73. </tbody>
  74. </table>
  75. <dl class="details">
  76. <dt class="tag-source">Source:</dt>
  77. <dd class="tag-source"><ul class="dummy"><li>
  78. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line61">line 61</a>
  79. </li></ul></dd>
  80. </dl>
  81. <h4 class="name" id="CollapsibleWidget"><span class="type-signature"></span>CollapsibleWidget<span class="type-signature"></span></h4>
  82. <h5 class="subsection-title">Properties:</h5>
  83. <table class="props">
  84. <thead>
  85. <tr>
  86. <th>Type</th>
  87. <th class="last">Description</th>
  88. </tr>
  89. </thead>
  90. <tbody>
  91. <tr>
  92. <td class="type">
  93. <span class="param-type">CollapsibleWidget</span>
  94. </td>
  95. <td class="description last"></td>
  96. </tr>
  97. </tbody>
  98. </table>
  99. <dl class="details">
  100. <dt class="tag-source">Source:</dt>
  101. <dd class="tag-source"><ul class="dummy"><li>
  102. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line40">line 40</a>
  103. </li></ul></dd>
  104. </dl>
  105. <h4 class="name" id="currentNote"><span class="type-signature"></span>currentNote<span class="type-signature"></span></h4>
  106. <h5 class="subsection-title">Properties:</h5>
  107. <table class="props">
  108. <thead>
  109. <tr>
  110. <th>Name</th>
  111. <th>Type</th>
  112. <th class="last">Description</th>
  113. </tr>
  114. </thead>
  115. <tbody>
  116. <tr>
  117. <td class="name"><code>note</code></td>
  118. <td class="type">
  119. <span class="param-type">object</span>
  120. </td>
  121. <td class="description last">where script is currently executing</td>
  122. </tr>
  123. </tbody>
  124. </table>
  125. <dl class="details">
  126. <dt class="tag-source">Source:</dt>
  127. <dd class="tag-source"><ul class="dummy"><li>
  128. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line32">line 32</a>
  129. </li></ul></dd>
  130. </dl>
  131. <h4 class="name" id="NoteContextAwareWidget"><span class="type-signature"></span>NoteContextAwareWidget<span class="type-signature"></span></h4>
  132. <h5 class="subsection-title">Properties:</h5>
  133. <table class="props">
  134. <thead>
  135. <tr>
  136. <th>Type</th>
  137. <th class="last">Description</th>
  138. </tr>
  139. </thead>
  140. <tbody>
  141. <tr>
  142. <td class="type">
  143. <span class="param-type">NoteContextAwareWidget</span>
  144. </td>
  145. <td class="description last"></td>
  146. </tr>
  147. </tbody>
  148. </table>
  149. <dl class="details">
  150. <dt class="tag-source">Source:</dt>
  151. <dd class="tag-source"><ul class="dummy"><li>
  152. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line49">line 49</a>
  153. </li></ul></dd>
  154. </dl>
  155. <h4 class="name" id="NoteContextCachingWidget"><span class="type-signature"></span>NoteContextCachingWidget<span class="type-signature"></span></h4>
  156. <h5 class="subsection-title">Properties:</h5>
  157. <table class="props">
  158. <thead>
  159. <tr>
  160. <th>Type</th>
  161. <th class="last">Description</th>
  162. </tr>
  163. </thead>
  164. <tbody>
  165. <tr>
  166. <td class="type">
  167. <span class="param-type">NoteContextAwareWidget</span>
  168. </td>
  169. <td class="description last"></td>
  170. </tr>
  171. </tbody>
  172. </table>
  173. <dl class="details">
  174. <dt class="tag-source">Source:</dt>
  175. <dd class="tag-source"><ul class="dummy"><li>
  176. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line58">line 58</a>
  177. </li></ul></dd>
  178. </dl>
  179. <h4 class="name" id="originEntity"><span class="type-signature"></span>originEntity<span class="type-signature"></span></h4>
  180. <h5 class="subsection-title">Properties:</h5>
  181. <table class="props">
  182. <thead>
  183. <tr>
  184. <th>Name</th>
  185. <th>Type</th>
  186. <th class="last">Description</th>
  187. </tr>
  188. </thead>
  189. <tbody>
  190. <tr>
  191. <td class="name"><code>entity</code></td>
  192. <td class="type">
  193. <span class="param-type">object</span>
  194. |
  195. <span class="param-type">null</span>
  196. </td>
  197. <td class="description last">whose event triggered this execution</td>
  198. </tr>
  199. </tbody>
  200. </table>
  201. <dl class="details">
  202. <dt class="tag-source">Source:</dt>
  203. <dd class="tag-source"><ul class="dummy"><li>
  204. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line34">line 34</a>
  205. </li></ul></dd>
  206. </dl>
  207. <h4 class="name" id="startNote"><span class="type-signature"></span>startNote<span class="type-signature"></span></h4>
  208. <h5 class="subsection-title">Properties:</h5>
  209. <table class="props">
  210. <thead>
  211. <tr>
  212. <th>Name</th>
  213. <th>Type</th>
  214. <th class="last">Description</th>
  215. </tr>
  216. </thead>
  217. <tbody>
  218. <tr>
  219. <td class="name"><code>note</code></td>
  220. <td class="type">
  221. <span class="param-type">object</span>
  222. </td>
  223. <td class="description last">where script started executing</td>
  224. </tr>
  225. </tbody>
  226. </table>
  227. <dl class="details">
  228. <dt class="tag-source">Source:</dt>
  229. <dd class="tag-source"><ul class="dummy"><li>
  230. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line30">line 30</a>
  231. </li></ul></dd>
  232. </dl>
  233. <h4 class="name" id="TabAwareWidget"><span class="type-signature"></span>TabAwareWidget<span class="type-signature"></span></h4>
  234. <h5 class="subsection-title">Properties:</h5>
  235. <table class="props">
  236. <thead>
  237. <tr>
  238. <th>Type</th>
  239. <th class="last">Description</th>
  240. </tr>
  241. </thead>
  242. <tbody>
  243. <tr>
  244. <td class="type">
  245. <span class="param-type">NoteContextAwareWidget</span>
  246. </td>
  247. <td class="description last"></td>
  248. </tr>
  249. </tbody>
  250. </table>
  251. <dl class="details">
  252. <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>use NoteContextAwareWidget instead</li></ul></dd>
  253. <dt class="tag-source">Source:</dt>
  254. <dd class="tag-source"><ul class="dummy"><li>
  255. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line46">line 46</a>
  256. </li></ul></dd>
  257. </dl>
  258. <h4 class="name" id="TabCachingWidget"><span class="type-signature"></span>TabCachingWidget<span class="type-signature"></span></h4>
  259. <h5 class="subsection-title">Properties:</h5>
  260. <table class="props">
  261. <thead>
  262. <tr>
  263. <th>Type</th>
  264. <th class="last">Description</th>
  265. </tr>
  266. </thead>
  267. <tbody>
  268. <tr>
  269. <td class="type">
  270. <span class="param-type">NoteContextCachingWidget</span>
  271. </td>
  272. <td class="description last"></td>
  273. </tr>
  274. </tbody>
  275. </table>
  276. <dl class="details">
  277. <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>use NoteContextCachingWidget instead</li></ul></dd>
  278. <dt class="tag-source">Source:</dt>
  279. <dd class="tag-source"><ul class="dummy"><li>
  280. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line55">line 55</a>
  281. </li></ul></dd>
  282. </dl>
  283. <h3 class="subsection-title">Methods</h3>
  284. <h4 class="name" id="activateNewNote"><span class="type-signature"></span>activateNewNote<span class="signature">(notePath)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
  285. <div class="description">
  286. Activates newly created note. Compared to this.activateNote() also makes sure that frontend has been fully synced.
  287. </div>
  288. <h5>Parameters:</h5>
  289. <table class="params">
  290. <thead>
  291. <tr>
  292. <th>Name</th>
  293. <th>Type</th>
  294. <th class="last">Description</th>
  295. </tr>
  296. </thead>
  297. <tbody>
  298. <tr>
  299. <td class="name"><code>notePath</code></td>
  300. <td class="type">
  301. <span class="param-type">string</span>
  302. </td>
  303. <td class="description last">(or noteId)</td>
  304. </tr>
  305. </tbody>
  306. </table>
  307. <dl class="details">
  308. <dt class="tag-source">Source:</dt>
  309. <dd class="tag-source"><ul class="dummy"><li>
  310. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line80">line 80</a>
  311. </li></ul></dd>
  312. </dl>
  313. <h5>Returns:</h5>
  314. <dl>
  315. <dt>
  316. Type
  317. </dt>
  318. <dd>
  319. <span class="param-type">Promise.&lt;void></span>
  320. </dd>
  321. </dl>
  322. <h4 class="name" id="activateNote"><span class="type-signature"></span>activateNote<span class="signature">(notePath)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
  323. <div class="description">
  324. Activates note in the tree and in the note detail.
  325. </div>
  326. <h5>Parameters:</h5>
  327. <table class="params">
  328. <thead>
  329. <tr>
  330. <th>Name</th>
  331. <th>Type</th>
  332. <th class="last">Description</th>
  333. </tr>
  334. </thead>
  335. <tbody>
  336. <tr>
  337. <td class="name"><code>notePath</code></td>
  338. <td class="type">
  339. <span class="param-type">string</span>
  340. </td>
  341. <td class="description last">(or noteId)</td>
  342. </tr>
  343. </tbody>
  344. </table>
  345. <dl class="details">
  346. <dt class="tag-source">Source:</dt>
  347. <dd class="tag-source"><ul class="dummy"><li>
  348. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line70">line 70</a>
  349. </li></ul></dd>
  350. </dl>
  351. <h5>Returns:</h5>
  352. <dl>
  353. <dt>
  354. Type
  355. </dt>
  356. <dd>
  357. <span class="param-type">Promise.&lt;void></span>
  358. </dd>
  359. </dl>
  360. <h4 class="name" id="addButtonToToolbar"><span class="type-signature"></span>addButtonToToolbar<span class="signature">(opts)</span><span class="type-signature"></span></h4>
  361. <div class="description">
  362. Adds new button the the plugin area.
  363. </div>
  364. <h5>Parameters:</h5>
  365. <table class="params">
  366. <thead>
  367. <tr>
  368. <th>Name</th>
  369. <th>Type</th>
  370. <th class="last">Description</th>
  371. </tr>
  372. </thead>
  373. <tbody>
  374. <tr>
  375. <td class="name"><code>opts</code></td>
  376. <td class="type">
  377. <span class="param-type"><a href="global.html#ToolbarButtonOptions">ToolbarButtonOptions</a></span>
  378. </td>
  379. <td class="description last"></td>
  380. </tr>
  381. </tbody>
  382. </table>
  383. <dl class="details">
  384. <dt class="tag-source">Source:</dt>
  385. <dd class="tag-source"><ul class="dummy"><li>
  386. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line137">line 137</a>
  387. </li></ul></dd>
  388. </dl>
  389. <h4 class="name" id="addTextToActiveContextEditor"><span class="type-signature"></span>addTextToActiveContextEditor<span class="signature">(text)</span><span class="type-signature"></span></h4>
  390. <div class="description">
  391. Adds given text to the editor cursor
  392. </div>
  393. <h5>Parameters:</h5>
  394. <table class="params">
  395. <thead>
  396. <tr>
  397. <th>Name</th>
  398. <th>Type</th>
  399. <th class="last">Description</th>
  400. </tr>
  401. </thead>
  402. <tbody>
  403. <tr>
  404. <td class="name"><code>text</code></td>
  405. <td class="type">
  406. <span class="param-type">string</span>
  407. </td>
  408. <td class="description last">this must be clear text, HTML is not supported.</td>
  409. </tr>
  410. </tbody>
  411. </table>
  412. <dl class="details">
  413. <dt class="tag-source">Source:</dt>
  414. <dd class="tag-source"><ul class="dummy"><li>
  415. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line378">line 378</a>
  416. </li></ul></dd>
  417. </dl>
  418. <h4 class="name" id="addTextToActiveTabEditor"><span class="type-signature"></span>addTextToActiveTabEditor<span class="signature">(text)</span><span class="type-signature"></span></h4>
  419. <div class="description">
  420. Adds given text to the editor cursor
  421. </div>
  422. <h5>Parameters:</h5>
  423. <table class="params">
  424. <thead>
  425. <tr>
  426. <th>Name</th>
  427. <th>Type</th>
  428. <th class="last">Description</th>
  429. </tr>
  430. </thead>
  431. <tbody>
  432. <tr>
  433. <td class="name"><code>text</code></td>
  434. <td class="type">
  435. <span class="param-type">string</span>
  436. </td>
  437. <td class="description last">this must be clear text, HTML is not supported.</td>
  438. </tr>
  439. </tbody>
  440. </table>
  441. <dl class="details">
  442. <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>use addTextToActiveContextEditor() instead</li></ul></dd>
  443. <dt class="tag-source">Source:</dt>
  444. <dd class="tag-source"><ul class="dummy"><li>
  445. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line366">line 366</a>
  446. </li></ul></dd>
  447. </dl>
  448. <h4 class="name" id="bindGlobalShortcut"><span class="type-signature"></span>bindGlobalShortcut<span class="signature">(keyboardShortcut, handler)</span><span class="type-signature"></span></h4>
  449. <h5>Parameters:</h5>
  450. <table class="params">
  451. <thead>
  452. <tr>
  453. <th>Name</th>
  454. <th>Type</th>
  455. <th class="last">Description</th>
  456. </tr>
  457. </thead>
  458. <tbody>
  459. <tr>
  460. <td class="name"><code>keyboardShortcut</code></td>
  461. <td class="type">
  462. <span class="param-type">string</span>
  463. </td>
  464. <td class="description last">e.g. "ctrl+shift+a"</td>
  465. </tr>
  466. <tr>
  467. <td class="name"><code>handler</code></td>
  468. <td class="type">
  469. <span class="param-type">function</span>
  470. </td>
  471. <td class="description last"></td>
  472. </tr>
  473. </tbody>
  474. </table>
  475. <dl class="details">
  476. <dt class="tag-source">Source:</dt>
  477. <dd class="tag-source"><ul class="dummy"><li>
  478. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line569">line 569</a>
  479. </li></ul></dd>
  480. </dl>
  481. <h4 class="name" id="createNoteLink"><span class="type-signature"></span>createNoteLink<span class="signature">(notePath, params<span class="signature-attributes">opt</span>, title=<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
  482. <div class="description">
  483. Create note link (jQuery object) for given note.
  484. </div>
  485. <h5>Parameters:</h5>
  486. <table class="params">
  487. <thead>
  488. <tr>
  489. <th>Name</th>
  490. <th>Type</th>
  491. <th>Attributes</th>
  492. <th class="last">Description</th>
  493. </tr>
  494. </thead>
  495. <tbody>
  496. <tr>
  497. <td class="name"><code>notePath</code></td>
  498. <td class="type">
  499. <span class="param-type">string</span>
  500. </td>
  501. <td class="attributes">
  502. </td>
  503. <td class="description last">(or noteId)</td>
  504. </tr>
  505. <tr>
  506. <td class="name"><code>params</code></td>
  507. <td class="type">
  508. <span class="param-type">object</span>
  509. </td>
  510. <td class="attributes">
  511. &lt;optional><br>
  512. </td>
  513. <td class="description last">
  514. <h6>Properties</h6>
  515. <table class="params">
  516. <thead>
  517. <tr>
  518. <th>Name</th>
  519. <th>Type</th>
  520. <th>Attributes</th>
  521. <th>Default</th>
  522. <th class="last">Description</th>
  523. </tr>
  524. </thead>
  525. <tbody>
  526. <tr>
  527. <td class="name"><code>showTooltip</code></td>
  528. <td class="type">
  529. <span class="param-type">boolean</span>
  530. </td>
  531. <td class="attributes">
  532. &lt;optional><br>
  533. </td>
  534. <td class="default">
  535. true
  536. </td>
  537. <td class="description last">enable/disable tooltip on the link</td>
  538. </tr>
  539. <tr>
  540. <td class="name"><code>showNotePath</code></td>
  541. <td class="type">
  542. <span class="param-type">boolean</span>
  543. </td>
  544. <td class="attributes">
  545. &lt;optional><br>
  546. </td>
  547. <td class="default">
  548. false
  549. </td>
  550. <td class="description last">show also whole note's path as part of the link</td>
  551. </tr>
  552. <tr>
  553. <td class="name"><code>showNoteIcon</code></td>
  554. <td class="type">
  555. <span class="param-type">boolean</span>
  556. </td>
  557. <td class="attributes">
  558. &lt;optional><br>
  559. </td>
  560. <td class="default">
  561. false
  562. </td>
  563. <td class="description last">show also note icon before the title</td>
  564. </tr>
  565. </tbody>
  566. </table>
  567. </td>
  568. </tr>
  569. <tr>
  570. <td class="name"><code>title=</code></td>
  571. <td class="type">
  572. <span class="param-type">string</span>
  573. </td>
  574. <td class="attributes">
  575. &lt;optional><br>
  576. </td>
  577. <td class="description last">custom link tile with note's title as default</td>
  578. </tr>
  579. </tbody>
  580. </table>
  581. <dl class="details">
  582. <dt class="tag-source">Source:</dt>
  583. <dd class="tag-source"><ul class="dummy"><li>
  584. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line357">line 357</a>
  585. </li></ul></dd>
  586. </dl>
  587. <h4 class="name" id="formatDateISO"><span class="type-signature"></span>formatDateISO<span class="signature">(date)</span><span class="type-signature"> &rarr; {string}</span></h4>
  588. <h5>Parameters:</h5>
  589. <table class="params">
  590. <thead>
  591. <tr>
  592. <th>Name</th>
  593. <th>Type</th>
  594. <th class="last">Description</th>
  595. </tr>
  596. </thead>
  597. <tbody>
  598. <tr>
  599. <td class="name"><code>date</code></td>
  600. <td class="type">
  601. <span class="param-type">Date</span>
  602. </td>
  603. <td class="description last"></td>
  604. </tr>
  605. </tbody>
  606. </table>
  607. <dl class="details">
  608. <dt class="tag-source">Source:</dt>
  609. <dd class="tag-source"><ul class="dummy"><li>
  610. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line297">line 297</a>
  611. </li></ul></dd>
  612. </dl>
  613. <h5>Returns:</h5>
  614. <div class="param-desc">
  615. date in YYYY-MM-DD format
  616. </div>
  617. <dl>
  618. <dt>
  619. Type
  620. </dt>
  621. <dd>
  622. <span class="param-type">string</span>
  623. </dd>
  624. </dl>
  625. <h4 class="name" id="getActiveContextCodeEditor"><span class="type-signature"></span>getActiveContextCodeEditor<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;CodeMirror>}</span></h4>
  626. <div class="description">
  627. See https://codemirror.net/doc/manual.html#api
  628. </div>
  629. <dl class="details">
  630. <dt class="tag-source">Source:</dt>
  631. <dd class="tag-source"><ul class="dummy"><li>
  632. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line424">line 424</a>
  633. </li></ul></dd>
  634. </dl>
  635. <h5>Returns:</h5>
  636. <div class="param-desc">
  637. instance of CodeMirror
  638. </div>
  639. <dl>
  640. <dt>
  641. Type
  642. </dt>
  643. <dd>
  644. <span class="param-type">Promise.&lt;CodeMirror></span>
  645. </dd>
  646. </dl>
  647. <h4 class="name" id="getActiveContextNote"><span class="type-signature"></span>getActiveContextNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="NoteShort.html">NoteShort</a>}</span></h4>
  648. <dl class="details">
  649. <dt class="tag-source">Source:</dt>
  650. <dd class="tag-source"><ul class="dummy"><li>
  651. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line395">line 395</a>
  652. </li></ul></dd>
  653. </dl>
  654. <h5>Returns:</h5>
  655. <div class="param-desc">
  656. active note (loaded into right pane)
  657. </div>
  658. <dl>
  659. <dt>
  660. Type
  661. </dt>
  662. <dd>
  663. <span class="param-type"><a href="NoteShort.html">NoteShort</a></span>
  664. </dd>
  665. </dl>
  666. <h4 class="name" id="getActiveContextNotePath"><span class="type-signature"></span>getActiveContextNotePath<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;(string|null)>}</span></h4>
  667. <dl class="details">
  668. <dt class="tag-source">Source:</dt>
  669. <dd class="tag-source"><ul class="dummy"><li>
  670. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line450">line 450</a>
  671. </li></ul></dd>
  672. </dl>
  673. <h5>Returns:</h5>
  674. <div class="param-desc">
  675. returns note path of active note or null if there isn't active note
  676. </div>
  677. <dl>
  678. <dt>
  679. Type
  680. </dt>
  681. <dd>
  682. <span class="param-type">Promise.&lt;(string|null)></span>
  683. </dd>
  684. </dl>
  685. <h4 class="name" id="getActiveContextTextEditor"><span class="type-signature"></span>getActiveContextTextEditor<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;CKEditor>}</span></h4>
  686. <div class="description">
  687. See https://ckeditor.com/docs/ckeditor5/latest/api/module_core_editor_editor-Editor.html for a documentation on the returned instance.
  688. </div>
  689. <dl class="details">
  690. <dt class="tag-source">Source:</dt>
  691. <dd class="tag-source"><ul class="dummy"><li>
  692. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line416">line 416</a>
  693. </li></ul></dd>
  694. </dl>
  695. <h5>Returns:</h5>
  696. <div class="param-desc">
  697. instance of CKEditor
  698. </div>
  699. <dl>
  700. <dt>
  701. Type
  702. </dt>
  703. <dd>
  704. <span class="param-type">Promise.&lt;CKEditor></span>
  705. </dd>
  706. </dl>
  707. <h4 class="name" id="getActiveNoteDetailWidget"><span class="type-signature"></span>getActiveNoteDetailWidget<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;NoteDetailWidget>}</span></h4>
  708. <div class="description">
  709. Get access to the widget handling note detail. Methods like `getWidgetType()` and `getTypeWidget()` to get to the
  710. implementation of actual widget type.
  711. </div>
  712. <dl class="details">
  713. <dt class="tag-source">Source:</dt>
  714. <dd class="tag-source"><ul class="dummy"><li>
  715. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line433">line 433</a>
  716. </li></ul></dd>
  717. </dl>
  718. <h5>Returns:</h5>
  719. <dl>
  720. <dt>
  721. Type
  722. </dt>
  723. <dd>
  724. <span class="param-type">Promise.&lt;NoteDetailWidget></span>
  725. </dd>
  726. </dl>
  727. <h4 class="name" id="getActiveTabNote"><span class="type-signature"></span>getActiveTabNote<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="NoteShort.html">NoteShort</a>}</span></h4>
  728. <dl class="details">
  729. <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>use getActiveContextNote() instead</li></ul></dd>
  730. <dt class="tag-source">Source:</dt>
  731. <dd class="tag-source"><ul class="dummy"><li>
  732. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line385">line 385</a>
  733. </li></ul></dd>
  734. </dl>
  735. <h5>Returns:</h5>
  736. <div class="param-desc">
  737. active note (loaded into right pane)
  738. </div>
  739. <dl>
  740. <dt>
  741. Type
  742. </dt>
  743. <dd>
  744. <span class="param-type"><a href="NoteShort.html">NoteShort</a></span>
  745. </dd>
  746. </dl>
  747. <h4 class="name" id="getActiveTabNotePath"><span class="type-signature"></span>getActiveTabNotePath<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;(string|null)>}</span></h4>
  748. <dl class="details">
  749. <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>use getActiveContextNotePath() instead</li></ul></dd>
  750. <dt class="tag-source">Source:</dt>
  751. <dd class="tag-source"><ul class="dummy"><li>
  752. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line440">line 440</a>
  753. </li></ul></dd>
  754. </dl>
  755. <h5>Returns:</h5>
  756. <div class="param-desc">
  757. returns note path of active note or null if there isn't active note
  758. </div>
  759. <dl>
  760. <dt>
  761. Type
  762. </dt>
  763. <dd>
  764. <span class="param-type">Promise.&lt;(string|null)></span>
  765. </dd>
  766. </dl>
  767. <h4 class="name" id="getActiveTabTextEditor"><span class="type-signature"></span>getActiveTabTextEditor<span class="signature">(callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
  768. <div class="description">
  769. See https://ckeditor.com/docs/ckeditor5/latest/api/module_core_editor_editor-Editor.html for a documentation on the returned instance.
  770. </div>
  771. <h5>Parameters:</h5>
  772. <table class="params">
  773. <thead>
  774. <tr>
  775. <th>Name</th>
  776. <th>Type</th>
  777. <th>Attributes</th>
  778. <th class="last">Description</th>
  779. </tr>
  780. </thead>
  781. <tbody>
  782. <tr>
  783. <td class="name"><code>callback</code></td>
  784. <td class="type">
  785. </td>
  786. <td class="attributes">
  787. &lt;optional><br>
  788. </td>
  789. <td class="description last">callback receiving "textEditor" instance</td>
  790. </tr>
  791. </tbody>
  792. </table>
  793. <dl class="details">
  794. <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>use getActiveContextTextEditor()</li></ul></dd>
  795. <dt class="tag-source">Source:</dt>
  796. <dd class="tag-source"><ul class="dummy"><li>
  797. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line404">line 404</a>
  798. </li></ul></dd>
  799. </dl>
  800. <h4 class="name" id="getComponentByEl"><span class="type-signature"></span>getComponentByEl<span class="signature">(el)</span><span class="type-signature"> &rarr; {Component}</span></h4>
  801. <div class="description">
  802. Returns component which owns given DOM element (the nearest parent component in DOM tree)
  803. </div>
  804. <h5>Parameters:</h5>
  805. <table class="params">
  806. <thead>
  807. <tr>
  808. <th>Name</th>
  809. <th>Type</th>
  810. <th class="last">Description</th>
  811. </tr>
  812. </thead>
  813. <tbody>
  814. <tr>
  815. <td class="name"><code>el</code></td>
  816. <td class="type">
  817. <span class="param-type">Element</span>
  818. </td>
  819. <td class="description last">DOM element</td>
  820. </tr>
  821. </tbody>
  822. </table>
  823. <dl class="details">
  824. <dt class="tag-source">Source:</dt>
  825. <dd class="tag-source"><ul class="dummy"><li>
  826. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line459">line 459</a>
  827. </li></ul></dd>
  828. </dl>
  829. <h5>Returns:</h5>
  830. <dl>
  831. <dt>
  832. Type
  833. </dt>
  834. <dd>
  835. <span class="param-type">Component</span>
  836. </dd>
  837. </dl>
  838. <h4 class="name" id="getDateNote"><span class="type-signature"></span>getDateNote<span class="signature">(date)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="NoteShort.html">NoteShort</a>>}</span></h4>
  839. <div class="description">
  840. Returns day note for a given date. If it doesn't exist, it is automatically created.
  841. </div>
  842. <h5>Parameters:</h5>
  843. <table class="params">
  844. <thead>
  845. <tr>
  846. <th>Name</th>
  847. <th>Type</th>
  848. <th class="last">Description</th>
  849. </tr>
  850. </thead>
  851. <tbody>
  852. <tr>
  853. <td class="name"><code>date</code></td>
  854. <td class="type">
  855. <span class="param-type">string</span>
  856. </td>
  857. <td class="description last">e.g. "2019-04-29"</td>
  858. </tr>
  859. </tbody>
  860. </table>
  861. <dl class="details">
  862. <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>use getDayNote instead</li></ul></dd>
  863. <dt class="tag-source">Source:</dt>
  864. <dd class="tag-source"><ul class="dummy"><li>
  865. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line511">line 511</a>
  866. </li></ul></dd>
  867. </dl>
  868. <h5>Returns:</h5>
  869. <dl>
  870. <dt>
  871. Type
  872. </dt>
  873. <dd>
  874. <span class="param-type">Promise.&lt;<a href="NoteShort.html">NoteShort</a>></span>
  875. </dd>
  876. </dl>
  877. <h4 class="name" id="getDayNote"><span class="type-signature"></span>getDayNote<span class="signature">(date)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="NoteShort.html">NoteShort</a>>}</span></h4>
  878. <div class="description">
  879. Returns day note for a given date. If it doesn't exist, it is automatically created.
  880. </div>
  881. <h5>Parameters:</h5>
  882. <table class="params">
  883. <thead>
  884. <tr>
  885. <th>Name</th>
  886. <th>Type</th>
  887. <th class="last">Description</th>
  888. </tr>
  889. </thead>
  890. <tbody>
  891. <tr>
  892. <td class="name"><code>date</code></td>
  893. <td class="type">
  894. <span class="param-type">string</span>
  895. </td>
  896. <td class="description last">e.g. "2019-04-29"</td>
  897. </tr>
  898. </tbody>
  899. </table>
  900. <dl class="details">
  901. <dt class="tag-source">Source:</dt>
  902. <dd class="tag-source"><ul class="dummy"><li>
  903. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line520">line 520</a>
  904. </li></ul></dd>
  905. </dl>
  906. <h5>Returns:</h5>
  907. <dl>
  908. <dt>
  909. Type
  910. </dt>
  911. <dd>
  912. <span class="param-type">Promise.&lt;<a href="NoteShort.html">NoteShort</a>></span>
  913. </dd>
  914. </dl>
  915. <h4 class="name" id="getInstanceName"><span class="type-signature"></span>getInstanceName<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
  916. <div class="description">
  917. Instance name identifies particular Trilium instance. It can be useful for scripts
  918. if some action needs to happen on only one specific instance.
  919. </div>
  920. <dl class="details">
  921. <dt class="tag-source">Source:</dt>
  922. <dd class="tag-source"><ul class="dummy"><li>
  923. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line290">line 290</a>
  924. </li></ul></dd>
  925. </dl>
  926. <h5>Returns:</h5>
  927. <dl>
  928. <dt>
  929. Type
  930. </dt>
  931. <dd>
  932. <span class="param-type">string</span>
  933. </dd>
  934. </dl>
  935. <h4 class="name" id="getMonthNote"><span class="type-signature"></span>getMonthNote<span class="signature">(month)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="NoteShort.html">NoteShort</a>>}</span></h4>
  936. <div class="description">
  937. Returns month-note. If it doesn't exist, it is automatically created.
  938. </div>
  939. <h5>Parameters:</h5>
  940. <table class="params">
  941. <thead>
  942. <tr>
  943. <th>Name</th>
  944. <th>Type</th>
  945. <th class="last">Description</th>
  946. </tr>
  947. </thead>
  948. <tbody>
  949. <tr>
  950. <td class="name"><code>month</code></td>
  951. <td class="type">
  952. <span class="param-type">string</span>
  953. </td>
  954. <td class="description last">e.g. "2019-04"</td>
  955. </tr>
  956. </tbody>
  957. </table>
  958. <dl class="details">
  959. <dt class="tag-source">Source:</dt>
  960. <dd class="tag-source"><ul class="dummy"><li>
  961. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line538">line 538</a>
  962. </li></ul></dd>
  963. </dl>
  964. <h5>Returns:</h5>
  965. <dl>
  966. <dt>
  967. Type
  968. </dt>
  969. <dd>
  970. <span class="param-type">Promise.&lt;<a href="NoteShort.html">NoteShort</a>></span>
  971. </dd>
  972. </dl>
  973. <h4 class="name" id="getNote"><span class="type-signature"></span>getNote<span class="signature">(noteId)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="NoteShort.html">NoteShort</a>>}</span></h4>
  974. <div class="description">
  975. Returns note by given noteId. If note is missing from cache, it's loaded.
  976. *
  977. </div>
  978. <h5>Parameters:</h5>
  979. <table class="params">
  980. <thead>
  981. <tr>
  982. <th>Name</th>
  983. <th>Type</th>
  984. <th class="last">Description</th>
  985. </tr>
  986. </thead>
  987. <tbody>
  988. <tr>
  989. <td class="name"><code>noteId</code></td>
  990. <td class="type">
  991. <span class="param-type">string</span>
  992. </td>
  993. <td class="description last"></td>
  994. </tr>
  995. </tbody>
  996. </table>
  997. <dl class="details">
  998. <dt class="tag-source">Source:</dt>
  999. <dd class="tag-source"><ul class="dummy"><li>
  1000. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line262">line 262</a>
  1001. </li></ul></dd>
  1002. </dl>
  1003. <h5>Returns:</h5>
  1004. <dl>
  1005. <dt>
  1006. Type
  1007. </dt>
  1008. <dd>
  1009. <span class="param-type">Promise.&lt;<a href="NoteShort.html">NoteShort</a>></span>
  1010. </dd>
  1011. </dl>
  1012. <h4 class="name" id="getNotes"><span class="type-signature"></span>getNotes<span class="signature">(noteIds, silentNotFoundError<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;<a href="NoteShort.html">NoteShort</a>>>}</span></h4>
  1013. <div class="description">
  1014. Returns list of notes. If note is missing from cache, it's loaded.
  1015. This is often used to bulk-fill the cache with notes which would have to be picked one by one
  1016. otherwise (by e.g. createNoteLink())
  1017. </div>
  1018. <h5>Parameters:</h5>
  1019. <table class="params">
  1020. <thead>
  1021. <tr>
  1022. <th>Name</th>
  1023. <th>Type</th>
  1024. <th>Attributes</th>
  1025. <th class="last">Description</th>
  1026. </tr>
  1027. </thead>
  1028. <tbody>
  1029. <tr>
  1030. <td class="name"><code>noteIds</code></td>
  1031. <td class="type">
  1032. <span class="param-type">Array.&lt;string></span>
  1033. </td>
  1034. <td class="attributes">
  1035. </td>
  1036. <td class="description last"></td>
  1037. </tr>
  1038. <tr>
  1039. <td class="name"><code>silentNotFoundError</code></td>
  1040. <td class="type">
  1041. <span class="param-type">boolean</span>
  1042. </td>
  1043. <td class="attributes">
  1044. &lt;optional><br>
  1045. </td>
  1046. <td class="description last">don't report error if the note is not found</td>
  1047. </tr>
  1048. </tbody>
  1049. </table>
  1050. <dl class="details">
  1051. <dt class="tag-source">Source:</dt>
  1052. <dd class="tag-source"><ul class="dummy"><li>
  1053. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line274">line 274</a>
  1054. </li></ul></dd>
  1055. </dl>
  1056. <h5>Returns:</h5>
  1057. <dl>
  1058. <dt>
  1059. Type
  1060. </dt>
  1061. <dd>
  1062. <span class="param-type">Promise.&lt;Array.&lt;<a href="NoteShort.html">NoteShort</a>>></span>
  1063. </dd>
  1064. </dl>
  1065. <h4 class="name" id="getTodayNote"><span class="type-signature"></span>getTodayNote<span class="signature">()</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="NoteShort.html">NoteShort</a>>}</span></h4>
  1066. <div class="description">
  1067. Returns date-note for today. If it doesn't exist, it is automatically created.
  1068. </div>
  1069. <dl class="details">
  1070. <dt class="tag-source">Source:</dt>
  1071. <dd class="tag-source"><ul class="dummy"><li>
  1072. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line501">line 501</a>
  1073. </li></ul></dd>
  1074. </dl>
  1075. <h5>Returns:</h5>
  1076. <dl>
  1077. <dt>
  1078. Type
  1079. </dt>
  1080. <dd>
  1081. <span class="param-type">Promise.&lt;<a href="NoteShort.html">NoteShort</a>></span>
  1082. </dd>
  1083. </dl>
  1084. <h4 class="name" id="getWeekNote"><span class="type-signature"></span>getWeekNote<span class="signature">(date)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="NoteShort.html">NoteShort</a>>}</span></h4>
  1085. <div class="description">
  1086. Returns day note for the first date of the week of the given date. If it doesn't exist, it is automatically created.
  1087. </div>
  1088. <h5>Parameters:</h5>
  1089. <table class="params">
  1090. <thead>
  1091. <tr>
  1092. <th>Name</th>
  1093. <th>Type</th>
  1094. <th class="last">Description</th>
  1095. </tr>
  1096. </thead>
  1097. <tbody>
  1098. <tr>
  1099. <td class="name"><code>date</code></td>
  1100. <td class="type">
  1101. <span class="param-type">string</span>
  1102. </td>
  1103. <td class="description last">e.g. "2019-04-29"</td>
  1104. </tr>
  1105. </tbody>
  1106. </table>
  1107. <dl class="details">
  1108. <dt class="tag-source">Source:</dt>
  1109. <dd class="tag-source"><ul class="dummy"><li>
  1110. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line529">line 529</a>
  1111. </li></ul></dd>
  1112. </dl>
  1113. <h5>Returns:</h5>
  1114. <dl>
  1115. <dt>
  1116. Type
  1117. </dt>
  1118. <dd>
  1119. <span class="param-type">Promise.&lt;<a href="NoteShort.html">NoteShort</a>></span>
  1120. </dd>
  1121. </dl>
  1122. <h4 class="name" id="getYearNote"><span class="type-signature"></span>getYearNote<span class="signature">(year)</span><span class="type-signature"> &rarr; {Promise.&lt;<a href="NoteShort.html">NoteShort</a>>}</span></h4>
  1123. <div class="description">
  1124. Returns year-note. If it doesn't exist, it is automatically created.
  1125. </div>
  1126. <h5>Parameters:</h5>
  1127. <table class="params">
  1128. <thead>
  1129. <tr>
  1130. <th>Name</th>
  1131. <th>Type</th>
  1132. <th class="last">Description</th>
  1133. </tr>
  1134. </thead>
  1135. <tbody>
  1136. <tr>
  1137. <td class="name"><code>year</code></td>
  1138. <td class="type">
  1139. <span class="param-type">string</span>
  1140. </td>
  1141. <td class="description last">e.g. "2019"</td>
  1142. </tr>
  1143. </tbody>
  1144. </table>
  1145. <dl class="details">
  1146. <dt class="tag-source">Source:</dt>
  1147. <dd class="tag-source"><ul class="dummy"><li>
  1148. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line547">line 547</a>
  1149. </li></ul></dd>
  1150. </dl>
  1151. <h5>Returns:</h5>
  1152. <dl>
  1153. <dt>
  1154. Type
  1155. </dt>
  1156. <dd>
  1157. <span class="param-type">Promise.&lt;<a href="NoteShort.html">NoteShort</a>></span>
  1158. </dd>
  1159. </dl>
  1160. <h4 class="name" id="openSplitWithNote"><span class="type-signature"></span>openSplitWithNote<span class="signature">(notePath, activate)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
  1161. <div class="description">
  1162. Open a note in a new split.
  1163. </div>
  1164. <h5>Parameters:</h5>
  1165. <table class="params">
  1166. <thead>
  1167. <tr>
  1168. <th>Name</th>
  1169. <th>Type</th>
  1170. <th class="last">Description</th>
  1171. </tr>
  1172. </thead>
  1173. <tbody>
  1174. <tr>
  1175. <td class="name"><code>notePath</code></td>
  1176. <td class="type">
  1177. <span class="param-type">string</span>
  1178. </td>
  1179. <td class="description last">(or noteId)</td>
  1180. </tr>
  1181. <tr>
  1182. <td class="name"><code>activate</code></td>
  1183. <td class="type">
  1184. <span class="param-type">boolean</span>
  1185. </td>
  1186. <td class="description last">set to true to activate the new split, false to stay on the current split</td>
  1187. </tr>
  1188. </tbody>
  1189. </table>
  1190. <dl class="details">
  1191. <dt class="tag-source">Source:</dt>
  1192. <dd class="tag-source"><ul class="dummy"><li>
  1193. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line111">line 111</a>
  1194. </li></ul></dd>
  1195. </dl>
  1196. <h5>Returns:</h5>
  1197. <dl>
  1198. <dt>
  1199. Type
  1200. </dt>
  1201. <dd>
  1202. <span class="param-type">Promise.&lt;void></span>
  1203. </dd>
  1204. </dl>
  1205. <h4 class="name" id="openTabWithNote"><span class="type-signature"></span>openTabWithNote<span class="signature">(notePath, activate)</span><span class="type-signature"> &rarr; {Promise.&lt;void>}</span></h4>
  1206. <div class="description">
  1207. Open a note in a new tab.
  1208. </div>
  1209. <h5>Parameters:</h5>
  1210. <table class="params">
  1211. <thead>
  1212. <tr>
  1213. <th>Name</th>
  1214. <th>Type</th>
  1215. <th class="last">Description</th>
  1216. </tr>
  1217. </thead>
  1218. <tbody>
  1219. <tr>
  1220. <td class="name"><code>notePath</code></td>
  1221. <td class="type">
  1222. <span class="param-type">string</span>
  1223. </td>
  1224. <td class="description last">(or noteId)</td>
  1225. </tr>
  1226. <tr>
  1227. <td class="name"><code>activate</code></td>
  1228. <td class="type">
  1229. <span class="param-type">boolean</span>
  1230. </td>
  1231. <td class="description last">set to true to activate the new tab, false to stay on the current tab</td>
  1232. </tr>
  1233. </tbody>
  1234. </table>
  1235. <dl class="details">
  1236. <dt class="tag-source">Source:</dt>
  1237. <dd class="tag-source"><ul class="dummy"><li>
  1238. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line94">line 94</a>
  1239. </li></ul></dd>
  1240. </dl>
  1241. <h5>Returns:</h5>
  1242. <dl>
  1243. <dt>
  1244. Type
  1245. </dt>
  1246. <dd>
  1247. <span class="param-type">Promise.&lt;void></span>
  1248. </dd>
  1249. </dl>
  1250. <h4 class="name" id="parseDate"><span class="type-signature"></span>parseDate<span class="signature">(str)</span><span class="type-signature"> &rarr; {Date}</span></h4>
  1251. <h5>Parameters:</h5>
  1252. <table class="params">
  1253. <thead>
  1254. <tr>
  1255. <th>Name</th>
  1256. <th>Type</th>
  1257. <th class="last">Description</th>
  1258. </tr>
  1259. </thead>
  1260. <tbody>
  1261. <tr>
  1262. <td class="name"><code>str</code></td>
  1263. <td class="type">
  1264. <span class="param-type">string</span>
  1265. </td>
  1266. <td class="description last"></td>
  1267. </tr>
  1268. </tbody>
  1269. </table>
  1270. <dl class="details">
  1271. <dt class="tag-source">Source:</dt>
  1272. <dd class="tag-source"><ul class="dummy"><li>
  1273. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line304">line 304</a>
  1274. </li></ul></dd>
  1275. </dl>
  1276. <h5>Returns:</h5>
  1277. <div class="param-desc">
  1278. parsed object
  1279. </div>
  1280. <dl>
  1281. <dt>
  1282. Type
  1283. </dt>
  1284. <dd>
  1285. <span class="param-type">Date</span>
  1286. </dd>
  1287. </dl>
  1288. <h4 class="name" id="protectActiveNote"><span class="type-signature"></span>protectActiveNote<span class="signature">()</span><span class="type-signature"></span></h4>
  1289. <dl class="details">
  1290. <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>use protectNote and protectSubtree instead</li></ul></dd>
  1291. <dt class="tag-source">Source:</dt>
  1292. <dd class="tag-source"><ul class="dummy"><li>
  1293. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line471">line 471</a>
  1294. </li></ul></dd>
  1295. </dl>
  1296. <h4 class="name" id="protectNote"><span class="type-signature"></span>protectNote<span class="signature">(noteId, protect)</span><span class="type-signature"></span></h4>
  1297. <h5>Parameters:</h5>
  1298. <table class="params">
  1299. <thead>
  1300. <tr>
  1301. <th>Name</th>
  1302. <th>Type</th>
  1303. <th class="last">Description</th>
  1304. </tr>
  1305. </thead>
  1306. <tbody>
  1307. <tr>
  1308. <td class="name"><code>noteId</code></td>
  1309. <td class="type">
  1310. <span class="param-type">string</span>
  1311. </td>
  1312. <td class="description last"></td>
  1313. </tr>
  1314. <tr>
  1315. <td class="name"><code>protect</code></td>
  1316. <td class="type">
  1317. <span class="param-type">boolean</span>
  1318. </td>
  1319. <td class="description last">true to protect note, false to unprotect</td>
  1320. </tr>
  1321. </tbody>
  1322. </table>
  1323. <dl class="details">
  1324. <dt class="tag-source">Source:</dt>
  1325. <dd class="tag-source"><ul class="dummy"><li>
  1326. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line482">line 482</a>
  1327. </li></ul></dd>
  1328. </dl>
  1329. <h4 class="name" id="protectSubTree"><span class="type-signature"></span>protectSubTree<span class="signature">(noteId, protect)</span><span class="type-signature"></span></h4>
  1330. <h5>Parameters:</h5>
  1331. <table class="params">
  1332. <thead>
  1333. <tr>
  1334. <th>Name</th>
  1335. <th>Type</th>
  1336. <th class="last">Description</th>
  1337. </tr>
  1338. </thead>
  1339. <tbody>
  1340. <tr>
  1341. <td class="name"><code>noteId</code></td>
  1342. <td class="type">
  1343. <span class="param-type">string</span>
  1344. </td>
  1345. <td class="description last"></td>
  1346. </tr>
  1347. <tr>
  1348. <td class="name"><code>protect</code></td>
  1349. <td class="type">
  1350. <span class="param-type">boolean</span>
  1351. </td>
  1352. <td class="description last">true to protect subtree, false to unprotect</td>
  1353. </tr>
  1354. </tbody>
  1355. </table>
  1356. <dl class="details">
  1357. <dt class="tag-source">Source:</dt>
  1358. <dd class="tag-source"><ul class="dummy"><li>
  1359. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line491">line 491</a>
  1360. </li></ul></dd>
  1361. </dl>
  1362. <h4 class="name" id="randomString"><span class="type-signature"></span>randomString<span class="signature">(length)</span><span class="type-signature"> &rarr; {string}</span></h4>
  1363. <div class="description">
  1364. Return randomly generated string of given length. This random string generation is NOT cryptographically secure.
  1365. </div>
  1366. <h5>Parameters:</h5>
  1367. <table class="params">
  1368. <thead>
  1369. <tr>
  1370. <th>Name</th>
  1371. <th>Type</th>
  1372. <th class="last">Description</th>
  1373. </tr>
  1374. </thead>
  1375. <tbody>
  1376. <tr>
  1377. <td class="name"><code>length</code></td>
  1378. <td class="type">
  1379. <span class="param-type">number</span>
  1380. </td>
  1381. <td class="description last">of the string</td>
  1382. </tr>
  1383. </tbody>
  1384. </table>
  1385. <dl class="details">
  1386. <dt class="tag-source">Source:</dt>
  1387. <dd class="tag-source"><ul class="dummy"><li>
  1388. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line596">line 596</a>
  1389. </li></ul></dd>
  1390. </dl>
  1391. <h5>Returns:</h5>
  1392. <div class="param-desc">
  1393. random string
  1394. </div>
  1395. <dl>
  1396. <dt>
  1397. Type
  1398. </dt>
  1399. <dd>
  1400. <span class="param-type">string</span>
  1401. </dd>
  1402. </dl>
  1403. <h4 class="name" id="refreshIncludedNote"><span class="type-signature"></span>refreshIncludedNote<span class="signature">(includedNoteId)</span><span class="type-signature"></span></h4>
  1404. <div class="description">
  1405. This will refresh all currently opened notes which have included note specified in the parameter
  1406. </div>
  1407. <h5>Parameters:</h5>
  1408. <table class="params">
  1409. <thead>
  1410. <tr>
  1411. <th>Name</th>
  1412. <th>Type</th>
  1413. <th class="last">Description</th>
  1414. </tr>
  1415. </thead>
  1416. <tbody>
  1417. <tr>
  1418. <td class="name"><code>includedNoteId</code></td>
  1419. <td class="type">
  1420. </td>
  1421. <td class="description last">noteId of the included note</td>
  1422. </tr>
  1423. </tbody>
  1424. </table>
  1425. <dl class="details">
  1426. <dt class="tag-source">Source:</dt>
  1427. <dd class="tag-source"><ul class="dummy"><li>
  1428. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line587">line 587</a>
  1429. </li></ul></dd>
  1430. </dl>
  1431. <h4 class="name" id="refreshTree"><span class="type-signature"></span>refreshTree<span class="signature">()</span><span class="type-signature"></span></h4>
  1432. <dl class="details">
  1433. <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>- this is now no-op since all the changes should be gracefully handled per widget</li></ul></dd>
  1434. <dt class="tag-source">Source:</dt>
  1435. <dd class="tag-source"><ul class="dummy"><li>
  1436. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line344">line 344</a>
  1437. </li></ul></dd>
  1438. </dl>
  1439. <h4 class="name" id="reloadNotes"><span class="type-signature"></span>reloadNotes<span class="signature">(noteIds)</span><span class="type-signature"></span></h4>
  1440. <div class="description">
  1441. Update frontend tree (note) cache from the backend.
  1442. </div>
  1443. <h5>Parameters:</h5>
  1444. <table class="params">
  1445. <thead>
  1446. <tr>
  1447. <th>Name</th>
  1448. <th>Type</th>
  1449. <th class="last">Description</th>
  1450. </tr>
  1451. </thead>
  1452. <tbody>
  1453. <tr>
  1454. <td class="name"><code>noteIds</code></td>
  1455. <td class="type">
  1456. <span class="param-type">Array.&lt;string></span>
  1457. </td>
  1458. <td class="description last"></td>
  1459. </tr>
  1460. </tbody>
  1461. </table>
  1462. <dl class="details">
  1463. <dt class="tag-source">Source:</dt>
  1464. <dd class="tag-source"><ul class="dummy"><li>
  1465. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line282">line 282</a>
  1466. </li></ul></dd>
  1467. </dl>
  1468. <h4 class="name" id="runOnBackend"><span class="type-signature"></span>runOnBackend<span class="signature">(script, params)</span><span class="type-signature"> &rarr; {Promise.&lt;*>}</span></h4>
  1469. <div class="description">
  1470. Executes given anonymous function on the backend.
  1471. Internally this serializes the anonymous function into string and sends it to backend via AJAX.
  1472. </div>
  1473. <h5>Parameters:</h5>
  1474. <table class="params">
  1475. <thead>
  1476. <tr>
  1477. <th>Name</th>
  1478. <th>Type</th>
  1479. <th class="last">Description</th>
  1480. </tr>
  1481. </thead>
  1482. <tbody>
  1483. <tr>
  1484. <td class="name"><code>script</code></td>
  1485. <td class="type">
  1486. <span class="param-type">string</span>
  1487. </td>
  1488. <td class="description last">script to be executed on the backend</td>
  1489. </tr>
  1490. <tr>
  1491. <td class="name"><code>params</code></td>
  1492. <td class="type">
  1493. <span class="param-type">Array.&lt;?></span>
  1494. </td>
  1495. <td class="description last">list of parameters to the anonymous function to be send to backend</td>
  1496. </tr>
  1497. </tbody>
  1498. </table>
  1499. <dl class="details">
  1500. <dt class="tag-source">Source:</dt>
  1501. <dd class="tag-source"><ul class="dummy"><li>
  1502. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line200">line 200</a>
  1503. </li></ul></dd>
  1504. </dl>
  1505. <h5>Returns:</h5>
  1506. <div class="param-desc">
  1507. return value of the executed function on the backend
  1508. </div>
  1509. <dl>
  1510. <dt>
  1511. Type
  1512. </dt>
  1513. <dd>
  1514. <span class="param-type">Promise.&lt;*></span>
  1515. </dd>
  1516. </dl>
  1517. <h4 class="name" id="runOnServer"><span class="type-signature"></span>runOnServer<span class="signature">()</span><span class="type-signature"></span></h4>
  1518. <dl class="details">
  1519. <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>new name of this API call is runOnBackend so use that</li></ul></dd>
  1520. <dt class="tag-source">Source:</dt>
  1521. <dd class="tag-source"><ul class="dummy"><li>
  1522. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line228">line 228</a>
  1523. </li></ul></dd>
  1524. </dl>
  1525. <h4 class="name" id="searchForNote"><span class="type-signature"></span>searchForNote<span class="signature">(searchString)</span><span class="type-signature"> &rarr; {Promise.&lt;(<a href="NoteShort.html">NoteShort</a>|null)>}</span></h4>
  1526. <div class="description">
  1527. This is a powerful search method - you can search by attributes and their values, e.g.:
  1528. "#dateModified =* MONTH AND #log". See full documentation for all options at: https://github.com/zadam/trilium/wiki/Search
  1529. </div>
  1530. <h5>Parameters:</h5>
  1531. <table class="params">
  1532. <thead>
  1533. <tr>
  1534. <th>Name</th>
  1535. <th>Type</th>
  1536. <th class="last">Description</th>
  1537. </tr>
  1538. </thead>
  1539. <tbody>
  1540. <tr>
  1541. <td class="name"><code>searchString</code></td>
  1542. <td class="type">
  1543. <span class="param-type">string</span>
  1544. </td>
  1545. <td class="description last"></td>
  1546. </tr>
  1547. </tbody>
  1548. </table>
  1549. <dl class="details">
  1550. <dt class="tag-source">Source:</dt>
  1551. <dd class="tag-source"><ul class="dummy"><li>
  1552. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line250">line 250</a>
  1553. </li></ul></dd>
  1554. </dl>
  1555. <h5>Returns:</h5>
  1556. <dl>
  1557. <dt>
  1558. Type
  1559. </dt>
  1560. <dd>
  1561. <span class="param-type">Promise.&lt;(<a href="NoteShort.html">NoteShort</a>|null)></span>
  1562. </dd>
  1563. </dl>
  1564. <h4 class="name" id="searchForNotes"><span class="type-signature"></span>searchForNotes<span class="signature">(searchString)</span><span class="type-signature"> &rarr; {Promise.&lt;Array.&lt;<a href="NoteShort.html">NoteShort</a>>>}</span></h4>
  1565. <div class="description">
  1566. This is a powerful search method - you can search by attributes and their values, e.g.:
  1567. "#dateModified =* MONTH AND #log". See full documentation for all options at: https://github.com/zadam/trilium/wiki/Search
  1568. </div>
  1569. <h5>Parameters:</h5>
  1570. <table class="params">
  1571. <thead>
  1572. <tr>
  1573. <th>Name</th>
  1574. <th>Type</th>
  1575. <th class="last">Description</th>
  1576. </tr>
  1577. </thead>
  1578. <tbody>
  1579. <tr>
  1580. <td class="name"><code>searchString</code></td>
  1581. <td class="type">
  1582. <span class="param-type">string</span>
  1583. </td>
  1584. <td class="description last"></td>
  1585. </tr>
  1586. </tbody>
  1587. </table>
  1588. <dl class="details">
  1589. <dt class="tag-source">Source:</dt>
  1590. <dd class="tag-source"><ul class="dummy"><li>
  1591. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line238">line 238</a>
  1592. </li></ul></dd>
  1593. </dl>
  1594. <h5>Returns:</h5>
  1595. <dl>
  1596. <dt>
  1597. Type
  1598. </dt>
  1599. <dd>
  1600. <span class="param-type">Promise.&lt;Array.&lt;<a href="NoteShort.html">NoteShort</a>>></span>
  1601. </dd>
  1602. </dl>
  1603. <h4 class="name" id="setHoistedNoteId"><span class="type-signature"></span>setHoistedNoteId<span class="signature">(noteId)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
  1604. <div class="description">
  1605. Hoist note in the current tab. See https://github.com/zadam/trilium/wiki/Note-hoisting
  1606. </div>
  1607. <h5>Parameters:</h5>
  1608. <table class="params">
  1609. <thead>
  1610. <tr>
  1611. <th>Name</th>
  1612. <th>Type</th>
  1613. <th class="last">Description</th>
  1614. </tr>
  1615. </thead>
  1616. <tbody>
  1617. <tr>
  1618. <td class="name"><code>noteId</code></td>
  1619. <td class="type">
  1620. <span class="param-type">string</span>
  1621. </td>
  1622. <td class="description last">set hoisted note. 'root' will effectively unhoist</td>
  1623. </tr>
  1624. </tbody>
  1625. </table>
  1626. <dl class="details">
  1627. <dt class="tag-source">Source:</dt>
  1628. <dd class="tag-source"><ul class="dummy"><li>
  1629. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line556">line 556</a>
  1630. </li></ul></dd>
  1631. </dl>
  1632. <h5>Returns:</h5>
  1633. <dl>
  1634. <dt>
  1635. Type
  1636. </dt>
  1637. <dd>
  1638. <span class="param-type">Promise</span>
  1639. </dd>
  1640. </dl>
  1641. <h4 class="name" id="setupElementTooltip"><span class="type-signature"></span>setupElementTooltip<span class="signature">($el)</span><span class="type-signature"></span></h4>
  1642. <h5>Parameters:</h5>
  1643. <table class="params">
  1644. <thead>
  1645. <tr>
  1646. <th>Name</th>
  1647. <th>Type</th>
  1648. <th class="last">Description</th>
  1649. </tr>
  1650. </thead>
  1651. <tbody>
  1652. <tr>
  1653. <td class="name"><code>$el</code></td>
  1654. <td class="type">
  1655. <span class="param-type">object</span>
  1656. </td>
  1657. <td class="description last">jquery object on which to setup the tooltip</td>
  1658. </tr>
  1659. </tbody>
  1660. </table>
  1661. <dl class="details">
  1662. <dt class="tag-source">Source:</dt>
  1663. <dd class="tag-source"><ul class="dummy"><li>
  1664. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line465">line 465</a>
  1665. </li></ul></dd>
  1666. </dl>
  1667. <h4 class="name" id="showError"><span class="type-signature"></span>showError<span class="signature">(message)</span><span class="type-signature"></span></h4>
  1668. <div class="description">
  1669. Show error message to the user.
  1670. </div>
  1671. <h5>Parameters:</h5>
  1672. <table class="params">
  1673. <thead>
  1674. <tr>
  1675. <th>Name</th>
  1676. <th>Type</th>
  1677. <th class="last">Description</th>
  1678. </tr>
  1679. </thead>
  1680. <tbody>
  1681. <tr>
  1682. <td class="name"><code>message</code></td>
  1683. <td class="type">
  1684. <span class="param-type">string</span>
  1685. </td>
  1686. <td class="description last"></td>
  1687. </tr>
  1688. </tbody>
  1689. </table>
  1690. <dl class="details">
  1691. <dt class="tag-source">Source:</dt>
  1692. <dd class="tag-source"><ul class="dummy"><li>
  1693. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line320">line 320</a>
  1694. </li></ul></dd>
  1695. </dl>
  1696. <h4 class="name" id="showMessage"><span class="type-signature"></span>showMessage<span class="signature">(message)</span><span class="type-signature"></span></h4>
  1697. <div class="description">
  1698. Show info message to the user.
  1699. </div>
  1700. <h5>Parameters:</h5>
  1701. <table class="params">
  1702. <thead>
  1703. <tr>
  1704. <th>Name</th>
  1705. <th>Type</th>
  1706. <th class="last">Description</th>
  1707. </tr>
  1708. </thead>
  1709. <tbody>
  1710. <tr>
  1711. <td class="name"><code>message</code></td>
  1712. <td class="type">
  1713. <span class="param-type">string</span>
  1714. </td>
  1715. <td class="description last"></td>
  1716. </tr>
  1717. </tbody>
  1718. </table>
  1719. <dl class="details">
  1720. <dt class="tag-source">Source:</dt>
  1721. <dd class="tag-source"><ul class="dummy"><li>
  1722. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line312">line 312</a>
  1723. </li></ul></dd>
  1724. </dl>
  1725. <h4 class="name" id="triggerCommand"><span class="type-signature"></span>triggerCommand<span class="signature">(name, data)</span><span class="type-signature"></span></h4>
  1726. <div class="description">
  1727. Trigger command.
  1728. </div>
  1729. <h5>Parameters:</h5>
  1730. <table class="params">
  1731. <thead>
  1732. <tr>
  1733. <th>Name</th>
  1734. <th>Type</th>
  1735. <th class="last">Description</th>
  1736. </tr>
  1737. </thead>
  1738. <tbody>
  1739. <tr>
  1740. <td class="name"><code>name</code></td>
  1741. <td class="type">
  1742. <span class="param-type">string</span>
  1743. </td>
  1744. <td class="description last"></td>
  1745. </tr>
  1746. <tr>
  1747. <td class="name"><code>data</code></td>
  1748. <td class="type">
  1749. <span class="param-type">object</span>
  1750. </td>
  1751. <td class="description last"></td>
  1752. </tr>
  1753. </tbody>
  1754. </table>
  1755. <dl class="details">
  1756. <dt class="tag-source">Source:</dt>
  1757. <dd class="tag-source"><ul class="dummy"><li>
  1758. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line329">line 329</a>
  1759. </li></ul></dd>
  1760. </dl>
  1761. <h4 class="name" id="triggerEvent"><span class="type-signature"></span>triggerEvent<span class="signature">(name, data)</span><span class="type-signature"></span></h4>
  1762. <div class="description">
  1763. Trigger event.
  1764. </div>
  1765. <h5>Parameters:</h5>
  1766. <table class="params">
  1767. <thead>
  1768. <tr>
  1769. <th>Name</th>
  1770. <th>Type</th>
  1771. <th class="last">Description</th>
  1772. </tr>
  1773. </thead>
  1774. <tbody>
  1775. <tr>
  1776. <td class="name"><code>name</code></td>
  1777. <td class="type">
  1778. <span class="param-type">string</span>
  1779. </td>
  1780. <td class="description last"></td>
  1781. </tr>
  1782. <tr>
  1783. <td class="name"><code>data</code></td>
  1784. <td class="type">
  1785. <span class="param-type">object</span>
  1786. </td>
  1787. <td class="description last"></td>
  1788. </tr>
  1789. </tbody>
  1790. </table>
  1791. <dl class="details">
  1792. <dt class="tag-source">Source:</dt>
  1793. <dd class="tag-source"><ul class="dummy"><li>
  1794. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line338">line 338</a>
  1795. </li></ul></dd>
  1796. </dl>
  1797. <h4 class="name" id="waitUntilSynced"><span class="type-signature"></span>waitUntilSynced<span class="signature">()</span><span class="type-signature"></span></h4>
  1798. <div class="description">
  1799. Trilium runs in backend and frontend process, when something is changed on the backend from script,
  1800. frontend will get asynchronously synchronized.
  1801. This method returns a promise which resolves once all the backend -> frontend synchronization is finished.
  1802. Typical use case is when new note has been created, we should wait until it is synced into frontend and only then activate it.
  1803. </div>
  1804. <dl class="details">
  1805. <dt class="tag-source">Source:</dt>
  1806. <dd class="tag-source"><ul class="dummy"><li>
  1807. <a href="services_frontend_script_api.js.html">services/frontend_script_api.js</a>, <a href="services_frontend_script_api.js.html#line580">line 580</a>
  1808. </li></ul></dd>
  1809. </dl>
  1810. </article>
  1811. </section>
  1812. </div>
  1813. <nav>
  1814. <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Attribute.html">Attribute</a></li><li><a href="Branch.html">Branch</a></li><li><a href="FrontendScriptApi.html">FrontendScriptApi</a></li><li><a href="module.exports.html">exports</a></li><li><a href="NoteComplement.html">NoteComplement</a></li><li><a href="NoteShort.html">NoteShort</a></li></ul><h3>Global</h3><ul><li><a href="global.html#doRenderBody">doRenderBody</a></li></ul>
  1815. </nav>
  1816. <br class="clear">
  1817. <footer>
  1818. Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.10</a>
  1819. </footer>
  1820. <script> prettyPrint(); </script>
  1821. <script src="scripts/linenumber.js"> </script>
  1822. </body>
  1823. </html>