12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
- <head>
- <meta http-equiv="content-type" content="text/html; charset=utf-8" />
- <meta name="generator" content="JsDoc Toolkit" />
-
- <title>JsDoc Reference - links.Timeline</title>
- <style type="text/css">
- /* default.css */
- body
- {
- font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
- width: 800px;
- }
- .header
- {
- clear: both;
- background-color: #ccc;
- padding: 8px;
- }
- h1
- {
- font-size: 150%;
- font-weight: bold;
- padding: 0;
- margin: 1em 0 0 .3em;
- }
- hr
- {
- border: none 0;
- border-top: 1px solid #7F8FB1;
- height: 1px;
- }
- pre.code
- {
- display: block;
- padding: 8px;
- border: 1px dashed #ccc;
- }
- #index
- {
- margin-top: 24px;
- float: left;
- width: 160px;
- position: absolute;
- left: 8px;
- background-color: #F3F3F3;
- padding: 8px;
- }
- #content
- {
- margin-left: 190px;
- width: 600px;
- }
- .classList
- {
- list-style-type: none;
- padding: 0;
- margin: 0 0 0 8px;
- font-family: arial, sans-serif;
- font-size: 1em;
- overflow: auto;
- }
- .classList li
- {
- padding: 0;
- margin: 0 0 8px 0;
- }
- .summaryTable { width: 100%; }
- h1.classTitle
- {
- font-size:170%;
- line-height:130%;
- }
- h2 { font-size: 110%; }
- caption, div.sectionTitle
- {
- background-color: #7F8FB1;
- color: #fff;
- font-size:130%;
- text-align: left;
- padding: 2px 6px 2px 6px;
- border: 1px #7F8FB1 solid;
- }
- div.sectionTitle { margin-bottom: 8px; }
- .summaryTable thead { display: none; }
- .summaryTable td
- {
- vertical-align: top;
- padding: 4px;
- border-bottom: 1px #7F8FB1 solid;
- border-right: 1px #7F8FB1 solid;
- }
- /*col#summaryAttributes {}*/
- .summaryTable td.attributes
- {
- border-left: 1px #7F8FB1 solid;
- width: 140px;
- text-align: right;
- }
- td.attributes, .fixedFont
- {
- line-height: 15px;
- color: #002EBE;
- font-family: "Courier New",Courier,monospace;
- font-size: 13px;
- }
- .summaryTable td.nameDescription
- {
- text-align: left;
- font-size: 13px;
- line-height: 15px;
- }
- .summaryTable td.nameDescription, .description
- {
- line-height: 15px;
- padding: 4px;
- padding-left: 4px;
- }
- .summaryTable { margin-bottom: 8px; }
- ul.inheritsList
- {
- list-style: square;
- margin-left: 20px;
- padding-left: 0;
- }
- .detailList {
- margin-left: 20px;
- line-height: 15px;
- }
- .detailList dt { margin-left: 20px; }
- .detailList .heading
- {
- font-weight: bold;
- padding-bottom: 6px;
- margin-left: 0;
- }
- .light, td.attributes, .light a:link, .light a:visited
- {
- color: #777;
- font-style: italic;
- }
- .fineprint
- {
- text-align: right;
- font-size: 10px;
- }
- </style>
- </head>
- <body>
- <!-- ============================== header ================================= -->
- <!-- begin static/header.html -->
- <div id="header">
- </div>
- <!-- end static/header.html -->
- <!-- ============================== classes index ============================ -->
- <div id="index">
- <!-- begin publish.classesIndex -->
- <div align="center"><a href="../index.html">Class Index</a>
- | <a href="../files.html">File Index</a></div>
- <hr />
- <h2>Classes</h2>
- <ul class="classList">
-
- <li><i><a href="../symbols/_global_.html">_global_</a></i></li>
-
- <li><a href="../symbols/Array.html">Array</a></li>
-
- <li><a href="../symbols/links.Timeline.html">links.Timeline</a></li>
-
- <li><a href="../symbols/links.Timeline.StepDate.html">links.Timeline.StepDate</a></li>
-
- </ul>
- <hr />
- <!-- end publish.classesIndex -->
- </div>
-
- <div id="content">
- <!-- ============================== class title ============================ -->
- <h1 class="classTitle">
-
- Class links.Timeline
- </h1>
- <!-- ============================== class summary ========================== -->
- <p class="description">
-
-
-
-
-
-
- <br /><i>Defined in: </i> <a href="../symbols/src/timeline.js.html">timeline.js</a>.
-
- </p>
- <!-- ============================== constructor summary ==================== -->
-
- <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class links.Timeline.">
- <caption>Class Summary</caption>
- <thead>
- <tr>
- <th scope="col">Constructor Attributes</th>
- <th scope="col">Constructor Name and Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription" >
- <div class="fixedFont">
- <b><a href="../symbols/links.Timeline.html#constructor">links.Timeline</a></b>(container)
- </div>
- <div class="description"></div>
- </td>
- </tr>
- </tbody>
- </table>
-
- <!-- ============================== properties summary ===================== -->
-
- <!-- ============================== methods summary ======================== -->
-
-
-
- <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class links.Timeline.">
- <caption>Method Summary</caption>
- <thead>
- <tr>
- <th scope="col">Method Attributes</th>
- <th scope="col">Method Name and Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
- <td class="attributes"><static> </td>
- <td class="nameDescription">
- <div class="fixedFont">links.Timeline.<b><a href="../symbols/links.Timeline.html#.addEventListener">addEventListener</a></b>(element, action, listener, useCapture)
- </div>
- <div class="description">Add and event listener.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#addGroup">addGroup</a></b>(groupName)
- </div>
- <div class="description">Add a group.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#addItem">addItem</a></b>(itemData)
- </div>
- <div class="description">Add a new item.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#addItems">addItems</a></b>(items)
- </div>
- <div class="description">Add new items.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#applyRange">applyRange</a></b>(start, end, zoomAroundDate)
- </div>
- <div class="description">Apply a visible range.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#cancelAdd">cancelAdd</a></b>()
- </div>
- <div class="description">Cancel creation of a new item
- This method can be called insed an event listener which catches the "new"
- event.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#cancelChange">cancelChange</a></b>()
- </div>
- <div class="description">Cancel a change item
- This method can be called insed an event listener which catches the "change"
- event.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#cancelDelete">cancelDelete</a></b>()
- </div>
- <div class="description">Cancel deletion of an item
- This method can be called insed an event listener which catches the "delete"
- event.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#changeItem">changeItem</a></b>(index, itemData)
- </div>
- <div class="description">Edit an item</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#checkResize">checkResize</a></b>()
- </div>
- <div class="description">Check if the timeline is resized, and if so, redraw the timeline.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#collision">collision</a></b>(item1, item2, margin)
- </div>
- <div class="description">Test if the two provided items collide
- The items must have parameters left, right, top, and bottom.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#confirmDeleteItem">confirmDeleteItem</a></b>(index)
- </div>
- <div class="description">Delete an item after a confirmation.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#createEventBox">createEventBox</a></b>(content)
- </div>
- <div class="description">Create an event in the timeline, with (optional) formatting: inside a box
- with rounded corners, and a vertical line+dot to the axis.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#createEventDot">createEventDot</a></b>(content)
- </div>
- <div class="description">Create an event in the timeline: a dot, followed by the content.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#createEventRange">createEventRange</a></b>(content)
- </div>
- <div class="description">Create an event range as a beam in the timeline.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#createItem">createItem</a></b>(itemData)
- </div>
- <div class="description">Create an item object, containing all needed parameters</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#deleteAllItems">deleteAllItems</a></b>()
- </div>
- <div class="description">Delete all items</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#deleteGroups">deleteGroups</a></b>()
- </div>
- <div class="description">Delete all groups</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#deleteItem">deleteItem</a></b>(index)
- </div>
- <div class="description">Delete an item</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#draw">draw</a></b>(data, options)
- </div>
- <div class="description">Main drawing logic.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"><static> </td>
- <td class="nameDescription">
- <div class="fixedFont">links.Timeline.<b><a href="../symbols/links.Timeline.html#.filterImageUrls">filterImageUrls</a></b>(elem, urls)
- </div>
- <div class="description">Recursively retrieve all image urls from the images located inside a given
- HTML element</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#findGroup">findGroup</a></b>(group)
- </div>
- <div class="description">Find a group by its name.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"><static> </td>
- <td class="nameDescription">
- <div class="fixedFont">links.Timeline.<b><a href="../symbols/links.Timeline.html#.getAbsoluteLeft">getAbsoluteLeft</a></b>(elem)
- </div>
- <div class="description">Retrieve the absolute left value of a DOM element</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"><static> </td>
- <td class="nameDescription">
- <div class="fixedFont">links.Timeline.<b><a href="../symbols/links.Timeline.html#.getAbsoluteTop">getAbsoluteTop</a></b>(elem)
- </div>
- <div class="description">Retrieve the absolute top value of a DOM element</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#getCurrentTime">getCurrentTime</a></b>()
- </div>
- <div class="description">Get current time.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#getCustomTime">getCustomTime</a></b>()
- </div>
- <div class="description">Retrieve the current custom time.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#getData">getData</a></b>()
- </div>
- <div class="description">Return the original data table.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#getGroupFromHeight">getGroupFromHeight</a></b>(height, )
- </div>
- <div class="description">Find the group from a given height in the timeline</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#getItem">getItem</a></b>(index)
- </div>
- <div class="description">Retrieve the properties of an item.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#getItemIndex">getItemIndex</a></b>(element)
- </div>
- <div class="description">Find the item index from a given HTML element
- If no item index is found, undefined is returned</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#getSelection">getSelection</a></b>()
- </div>
- <div class="description">Retrieve the currently selected event</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"><static> </td>
- <td class="nameDescription">
- <div class="fixedFont">links.Timeline.<b><a href="../symbols/links.Timeline.html#.getTarget">getTarget</a></b>(event)
- </div>
- <div class="description">Get HTML element which is the target of the event</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#getVisibleChartRange">getVisibleChartRange</a></b>()
- </div>
- <div class="description">Retrieve the current visible range in the timeline.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"><static> </td>
- <td class="nameDescription">
- <div class="fixedFont">links.Timeline.<b><a href="../symbols/links.Timeline.html#.isArray">isArray</a></b>(obj)
- </div>
- <div class="description">Check if given object is a Javascript Array</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#isSelected">isSelected</a></b>(index)
- </div>
- <div class="description">Check if an item is currently selected</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#move">move</a></b>(moveFactor)
- </div>
- <div class="description">Move the timeline the given movefactor to the left or right.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#onDblClick">onDblClick</a></b>(event)
- </div>
- <div class="description">Double click event occurred for an item</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#onMouseDown">onMouseDown</a></b>(event)
- </div>
- <div class="description">Start a moving operation inside the provided parent element</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#onMouseMove">onMouseMove</a></b>(event)
- </div>
- <div class="description">Perform moving operating.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#onMouseUp">onMouseUp</a></b>(event)
- </div>
- <div class="description">Stop moving operating.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#onMouseWheel">onMouseWheel</a></b>(event)
- </div>
- <div class="description">Event handler for mouse wheel event, used to zoom the timeline
- Code from http://adomas.org/javascript-mouse-wheel/</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#onTouchEnd">onTouchEnd</a></b>(event)
- </div>
- <div class="description">Event handler for touchend event on mobile devices</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#onTouchMove">onTouchMove</a></b>(event)
- </div>
- <div class="description">Event handler for touchmove event on mobile devices</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#onTouchStart">onTouchStart</a></b>(event)
- </div>
- <div class="description">Event handler for touchstart event on mobile devices</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"><static> </td>
- <td class="nameDescription">
- <div class="fixedFont">links.Timeline.<b><a href="../symbols/links.Timeline.html#.preventDefault">preventDefault</a></b>(event)
- </div>
- <div class="description">Cancels the event if it is cancelable, without stopping further propagation of the event.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#recalcConversion">recalcConversion</a></b>()
- </div>
- <div class="description">Calculate the factor and offset to convert a position on screen to the
- corresponding date and vice versa.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#recalcSize">recalcSize</a></b>()
- </div>
- <div class="description">Recalculate the sizes of all frames, groups, items, axis
- After recalcSize() is executed, the Timeline should be redrawn normally</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#redraw">redraw</a></b>()
- </div>
- <div class="description">Redraw the timeline
- Reloads the (linked) data table and redraws the timeline when resized.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#redrawAxis">redrawAxis</a></b>()
- </div>
- <div class="description">Redraw the timeline axis with minor and major labels</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#redrawAxisCharacters">redrawAxisCharacters</a></b>()
- </div>
- <div class="description">Create characters used to determine the size of text on the axis</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#redrawAxisEndOverwriting">redrawAxisEndOverwriting</a></b>()
- </div>
- <div class="description">End of overwriting HTML DOM elements of the axis.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#redrawAxisHorizontal">redrawAxisHorizontal</a></b>()
- </div>
- <div class="description">Redraw the horizontal line and background of the axis</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#redrawAxisMajorLine">redrawAxisMajorLine</a></b>(x)
- </div>
- <div class="description">Create a Major line for the axis at position x</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#redrawAxisMajorText">redrawAxisMajorText</a></b>(x, text)
- </div>
- <div class="description">Create a Major label for the axis at position x</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#redrawAxisMinorLine">redrawAxisMinorLine</a></b>(x)
- </div>
- <div class="description">Create a minor line for the axis at position x</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#redrawAxisMinorText">redrawAxisMinorText</a></b>(x, text)
- </div>
- <div class="description">Create a minor label for the axis at position x</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#redrawAxisStartOverwriting">redrawAxisStartOverwriting</a></b>()
- </div>
- <div class="description">Initialize redraw of the axis.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#redrawContent">redrawContent</a></b>()
- </div>
- <div class="description">Redraw the content of the timeline: the axis and the items</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#redrawCurrentTime">redrawCurrentTime</a></b>()
- </div>
- <div class="description">Redraw the current time bar</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#redrawCustomTime">redrawCustomTime</a></b>()
- </div>
- <div class="description">Redraw the custom time bar</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#redrawDeleteButton">redrawDeleteButton</a></b>()
- </div>
- <div class="description">Redraw the delete button, on the top right of the currently selected item
- if there is no item selected, the button is hidden.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#redrawDragAreas">redrawDragAreas</a></b>()
- </div>
- <div class="description">Redraw the drag areas.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#redrawFrame">redrawFrame</a></b>()
- </div>
- <div class="description">Redraw the timeline.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#redrawGroups">redrawGroups</a></b>()
- </div>
- <div class="description">Redraw the group labels</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#redrawItems">redrawItems</a></b>()
- </div>
- <div class="description">Redraw all items</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#redrawNavigation">redrawNavigation</a></b>()
- </div>
- <div class="description">Create the navigation buttons for zooming and moving</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"><static> </td>
- <td class="nameDescription">
- <div class="fixedFont">links.Timeline.<b><a href="../symbols/links.Timeline.html#.removeEventListener">removeEventListener</a></b>(element, action, listener, useCapture)
- </div>
- <div class="description">Remove an event listener from an element</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#repositionItem">repositionItem</a></b>(item, left, right)
- </div>
- <div class="description">Reposition given item</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#screenToTime">screenToTime</a></b>(x)
- </div>
- <div class="description">Convert a position on screen (pixels) to a datetime
- Before this method can be used, the method calcConversionFactor must be
- executed once.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#selectItem">selectItem</a></b>(index)
- </div>
- <div class="description">Select an item by its index</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#setAutoScale">setAutoScale</a></b>(enable)
- </div>
- <div class="description">Enable or disable autoscaling</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#setCurrentTime">setCurrentTime</a></b>(time)
- </div>
- <div class="description">Set current time.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#setCustomTime">setCustomTime</a></b>(time)
- </div>
- <div class="description">Set custom time.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#setData">setData</a></b>(data)
- </div>
- <div class="description">Set data for the timeline</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#setGroups">setGroups</a></b>(data)
- </div>
- <div class="description">Set the groups available in the given dataset</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#setOptions">setOptions</a></b>(options)
- </div>
- <div class="description">Set options for the timeline.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#setScale">setScale</a></b>(scale, step)
- </div>
- <div class="description">Set a custom scale.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#setSelection">setSelection</a></b>(selection)
- </div>
- <div class="description">Select an event.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#setSize">setSize</a></b>(width, height)
- </div>
- <div class="description">Set a new size for the timeline</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#setVisibleChartRange">setVisibleChartRange</a></b>(start, end, redraw)
- </div>
- <div class="description">Set a new value for the visible range int the timeline.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#setVisibleChartRangeAuto">setVisibleChartRangeAuto</a></b>()
- </div>
- <div class="description">Change the visible chart range such that all items become visible</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#setVisibleChartRangeNow">setVisibleChartRangeNow</a></b>()
- </div>
- <div class="description">Adjust the visible range such that the current time is located in the center
- of the timeline</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#stackCalculateFinal">stackCalculateFinal</a></b>(items)
- </div>
- <div class="description">Adjust vertical positions of the events such that they don't overlap each
- other.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#stackEvents">stackEvents</a></b>(animate)
- </div>
- <div class="description">Stack the items such that they don't overlap.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#stackEventsCheckOverlap">stackEventsCheckOverlap</a></b>(items, itemIndex, itemStart, itemEnd)
- </div>
- <div class="description">Check if the destiny position of given item overlaps with any
- of the other items from index itemStart to itemEnd.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#stackMoveOneStep">stackMoveOneStep</a></b>(currentItems, finalItems)
- </div>
- <div class="description">Move the events one step in the direction of their final positions</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#stackMoveToFinal">stackMoveToFinal</a></b>(currentItems, finalItems)
- </div>
- <div class="description">Move the events from their current position to the final position</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#stackOrder">stackOrder</a></b>(items)
- </div>
- <div class="description">Order the items in the array this.items.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"><static> </td>
- <td class="nameDescription">
- <div class="fixedFont">links.Timeline.<b><a href="../symbols/links.Timeline.html#.stopPropagation">stopPropagation</a></b>(event)
- </div>
- <div class="description">Stop event propagation</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#timeToScreen">timeToScreen</a></b>(time)
- </div>
- <div class="description">Convert a datetime (Date object) into a position on the screen
- Before this method can be used, the method calcConversionFactor must be
- executed once.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#trigger">trigger</a></b>(event)
- </div>
- <div class="description">fire an event</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#unselectItem">unselectItem</a></b>()
- </div>
- <div class="description">Unselect the currently selected event (if any)</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#updateData">updateData</a></b>(index, values)
- </div>
- <div class="description">Update the original data with changed start, end or group.</div>
- </td>
- </tr>
-
- <tr>
- <td class="attributes"> </td>
- <td class="nameDescription">
- <div class="fixedFont"><b><a href="../symbols/links.Timeline.html#zoom">zoom</a></b>(zoomFactor, zoomAroundDate)
- </div>
- <div class="description">Zoom the timeline the given zoomfactor in or out.</div>
- </td>
- </tr>
-
- </tbody>
- </table>
-
-
-
-
- <!-- ============================== events summary ======================== -->
-
- <!-- ============================== constructor details ==================== -->
-
- <div class="details"><a name="constructor"> </a>
- <div class="sectionTitle">
- Class Detail
- </div>
-
- <div class="fixedFont">
- <b>links.Timeline</b>(container)
- </div>
-
- <div class="description">
-
-
- </div>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Element}</span> <b>container</b>
-
- </dt>
- <dd>The DOM element in which the Timeline will
- be created. Normally a div element.</dd>
-
- </dl>
-
-
-
-
-
-
-
- </div>
-
- <!-- ============================== field details ========================== -->
-
- <!-- ============================== method details ========================= -->
-
- <div class="sectionTitle">
- Method Detail
- </div>
-
- <a name=".addEventListener"> </a>
- <div class="fixedFont"><static>
-
-
- <span class="light">links.Timeline.</span><b>addEventListener</b>(element, action, listener, useCapture)
-
- </div>
- <div class="description">
- Add and event listener. Works for all browsers
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Element}</span> <b>element</b>
-
- </dt>
- <dd>An html element</dd>
-
- <dt>
- <span class="light fixedFont">{string}</span> <b>action</b>
-
- </dt>
- <dd>The action, for example "click",
- without the prefix "on"</dd>
-
- <dt>
- <span class="light fixedFont">{function}</span> <b>listener</b>
-
- </dt>
- <dd>The callback function to be executed</dd>
-
- <dt>
- <span class="light fixedFont">{boolean}</span> <b>useCapture</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="addGroup"> </a>
- <div class="fixedFont">
-
- <span class="light">{Object}</span>
- <b>addGroup</b>(groupName)
-
- </div>
- <div class="description">
- Add a group. When the group already exists, no new group is created
- but the existing group is returned.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{String}</span> <b>groupName</b>
-
- </dt>
- <dd>the name of the group</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{Object}</span> groupObject</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="addItem"> </a>
- <div class="fixedFont">
-
-
- <b>addItem</b>(itemData)
-
- </div>
- <div class="description">
- Add a new item.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Object}</span> <b>itemData</b>
-
- </dt>
- <dd>Object containing item properties:<br>
- {Date} start (required),
- {Date} end (optional),
- {String} content (required),
- {String} group (optional)</dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="addItems"> </a>
- <div class="fixedFont">
-
-
- <b>addItems</b>(items)
-
- </div>
- <div class="description">
- Add new items.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{<a href="../symbols/Array.html">Array</a>}</span> <b>items</b>
-
- </dt>
- <dd>An array containing Objects.
- The objects must have the following parameters:
- {Date} start,
- {Date} end,
- {String} content with text or HTML code,
- {String} group</dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="applyRange"> </a>
- <div class="fixedFont">
-
-
- <b>applyRange</b>(start, end, zoomAroundDate)
-
- </div>
- <div class="description">
- Apply a visible range. The range is limited to feasible maximum and minimum
- range.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Date}</span> <b>start</b>
-
- </dt>
- <dd></dd>
-
- <dt>
- <span class="light fixedFont">{Date}</span> <b>end</b>
-
- </dt>
- <dd></dd>
-
- <dt>
- <span class="light fixedFont">{Date}</span> <b>zoomAroundDate</b>
-
- </dt>
- <dd>Optional. Date around which will be zoomed.</dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="cancelAdd"> </a>
- <div class="fixedFont">
-
-
- <b>cancelAdd</b>()
-
- </div>
- <div class="description">
- Cancel creation of a new item
- This method can be called insed an event listener which catches the "new"
- event. Creation of the new the event will be undone.
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="cancelChange"> </a>
- <div class="fixedFont">
-
-
- <b>cancelChange</b>()
-
- </div>
- <div class="description">
- Cancel a change item
- This method can be called insed an event listener which catches the "change"
- event. The changed event position will be undone.
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="cancelDelete"> </a>
- <div class="fixedFont">
-
-
- <b>cancelDelete</b>()
-
- </div>
- <div class="description">
- Cancel deletion of an item
- This method can be called insed an event listener which catches the "delete"
- event. Deletion of the event will be undone.
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="changeItem"> </a>
- <div class="fixedFont">
-
-
- <b>changeItem</b>(index, itemData)
-
- </div>
- <div class="description">
- Edit an item
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>index</b>
-
- </dt>
- <dd></dd>
-
- <dt>
- <span class="light fixedFont">{Object}</span> <b>itemData</b>
-
- </dt>
- <dd>Object containing item properties:<br>
- {Date} start (required),
- {Date} end (optional),
- {String} content (required),
- {String} group (optional)</dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="checkResize"> </a>
- <div class="fixedFont">
-
-
- <b>checkResize</b>()
-
- </div>
- <div class="description">
- Check if the timeline is resized, and if so, redraw the timeline.
- Useful when the webpage is resized.
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="collision"> </a>
- <div class="fixedFont">
-
- <span class="light">{boolean}</span>
- <b>collision</b>(item1, item2, margin)
-
- </div>
- <div class="description">
- Test if the two provided items collide
- The items must have parameters left, right, top, and bottom.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Element}</span> <b>item1</b>
-
- </dt>
- <dd>The first item</dd>
-
- <dt>
- <span class="light fixedFont">{Element}</span> <b>item2</b>
-
- </dt>
- <dd>The second item</dd>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>margin</b>
-
- </dt>
- <dd>A minimum required margin. Optional.
- If margin is provided, the two items will be
- marked colliding when they overlap or
- when the margin between the two is smaller than
- the requested margin.</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{boolean}</span> true if item1 and item2 collide, else false</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="confirmDeleteItem"> </a>
- <div class="fixedFont">
-
-
- <b>confirmDeleteItem</b>(index)
-
- </div>
- <div class="description">
- Delete an item after a confirmation.
- The deletion can be cancelled by executing .cancelDelete() during the
- triggered event 'delete'.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{int}</span> <b>index</b>
-
- </dt>
- <dd>Index of the item to be deleted</dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="createEventBox"> </a>
- <div class="fixedFont">
-
-
- <b>createEventBox</b>(content)
-
- </div>
- <div class="description">
- Create an event in the timeline, with (optional) formatting: inside a box
- with rounded corners, and a vertical line+dot to the axis.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{string}</span> <b>content</b>
-
- </dt>
- <dd>The content for the event. This can be plain text
- or HTML code.</dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="createEventDot"> </a>
- <div class="fixedFont">
-
-
- <b>createEventDot</b>(content)
-
- </div>
- <div class="description">
- Create an event in the timeline: a dot, followed by the content.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{string}</span> <b>content</b>
-
- </dt>
- <dd>The content for the event. This can be plain text
- or HTML code.</dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="createEventRange"> </a>
- <div class="fixedFont">
-
-
- <b>createEventRange</b>(content)
-
- </div>
- <div class="description">
- Create an event range as a beam in the timeline.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{string}</span> <b>content</b>
-
- </dt>
- <dd>The content for the event. This can be plain text
- or HTML code.</dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="createItem"> </a>
- <div class="fixedFont">
-
- <span class="light">{Object}</span>
- <b>createItem</b>(itemData)
-
- </div>
- <div class="description">
- Create an item object, containing all needed parameters
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Object}</span> <b>itemData</b>
-
- </dt>
- <dd>Object containing parameters start, end
- content, group.</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{Object}</span> item</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="deleteAllItems"> </a>
- <div class="fixedFont">
-
-
- <b>deleteAllItems</b>()
-
- </div>
- <div class="description">
- Delete all items
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="deleteGroups"> </a>
- <div class="fixedFont">
-
-
- <b>deleteGroups</b>()
-
- </div>
- <div class="description">
- Delete all groups
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="deleteItem"> </a>
- <div class="fixedFont">
-
-
- <b>deleteItem</b>(index)
-
- </div>
- <div class="description">
- Delete an item
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{int}</span> <b>index</b>
-
- </dt>
- <dd>Index of the item to be deleted</dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="draw"> </a>
- <div class="fixedFont">
-
-
- <b>draw</b>(data, options)
-
- </div>
- <div class="description">
- Main drawing logic. This is the function that needs to be called
- in the html page, to draw the timeline.
- A data table with the events must be provided, and an options table.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{google.visualization.DataTable}</span> <b>data</b>
-
- </dt>
- <dd>The data containing the events for the timeline.
- Object DataTable is defined in
- google.visualization.DataTable</dd>
-
- <dt>
- <span class="light fixedFont">{Object}</span> <b>options</b>
-
- </dt>
- <dd>A name/value map containing settings for the
- timeline. Optional.</dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name=".filterImageUrls"> </a>
- <div class="fixedFont"><static>
-
-
- <span class="light">links.Timeline.</span><b>filterImageUrls</b>(elem, urls)
-
- </div>
- <div class="description">
- Recursively retrieve all image urls from the images located inside a given
- HTML element
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{HTMLElement}</span> <b>elem</b>
-
- </dt>
- <dd></dd>
-
- <dt>
- <span class="light fixedFont">{String[]}</span> <b>urls</b>
-
- </dt>
- <dd>Urls will be added here (no duplicates)</dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="findGroup"> </a>
- <div class="fixedFont">
-
- <span class="light">{Object}</span>
- <b>findGroup</b>(group)
-
- </div>
- <div class="description">
- Find a group by its name.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{String}</span> <b>group</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{Object}</span> a group object or undefined when group is not found</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name=".getAbsoluteLeft"> </a>
- <div class="fixedFont"><static>
-
- <span class="light">{number}</span>
- <span class="light">links.Timeline.</span><b>getAbsoluteLeft</b>(elem)
-
- </div>
- <div class="description">
- Retrieve the absolute left value of a DOM element
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Element}</span> <b>elem</b>
-
- </dt>
- <dd>A dom element, for example a div</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{number}</span> left The absolute left position of this element
- in the browser page.</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name=".getAbsoluteTop"> </a>
- <div class="fixedFont"><static>
-
- <span class="light">{number}</span>
- <span class="light">links.Timeline.</span><b>getAbsoluteTop</b>(elem)
-
- </div>
- <div class="description">
- Retrieve the absolute top value of a DOM element
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Element}</span> <b>elem</b>
-
- </dt>
- <dd>A dom element, for example a div</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{number}</span> top The absolute top position of this element
- in the browser page.</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="getCurrentTime"> </a>
- <div class="fixedFont">
-
- <span class="light">{Date}</span>
- <b>getCurrentTime</b>()
-
- </div>
- <div class="description">
- Get current time. The time can have an offset from the real time, when
- the current time has been changed via the method setCurrentTime.
-
-
- </div>
-
-
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{Date}</span> time</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="getCustomTime"> </a>
- <div class="fixedFont">
-
- <span class="light">{Date}</span>
- <b>getCustomTime</b>()
-
- </div>
- <div class="description">
- Retrieve the current custom time.
-
-
- </div>
-
-
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{Date}</span> customTime</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="getData"> </a>
- <div class="fixedFont">
-
- <span class="light">{google.visualization.DataTable | Array}</span>
- <b>getData</b>()
-
- </div>
- <div class="description">
- Return the original data table.
-
-
- </div>
-
-
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{google.visualization.DataTable | Array}</span> data</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="getGroupFromHeight"> </a>
- <div class="fixedFont">
-
- <span class="light">{Object}</span>
- <b>getGroupFromHeight</b>(height, )
-
- </div>
- <div class="description">
- Find the group from a given height in the timeline
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>height</b>
-
- </dt>
- <dd>Height in the timeline</dd>
-
- <dt>
- <span class="light fixedFont">{boolean}</span> <b></b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{Object}</span> group The group object, or undefined if out of range</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="getItem"> </a>
- <div class="fixedFont">
-
- <span class="light">{Object}</span>
- <b>getItem</b>(index)
-
- </div>
- <div class="description">
- Retrieve the properties of an item.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>index</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{Object}</span> properties Object containing item properties:<br>
- {Date} start (required),
- {Date} end (optional),
- {String} content (required),
- {String} group (optional)</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="getItemIndex"> </a>
- <div class="fixedFont">
-
- <span class="light">{Number}</span>
- <b>getItemIndex</b>(element)
-
- </div>
- <div class="description">
- Find the item index from a given HTML element
- If no item index is found, undefined is returned
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Element}</span> <b>element</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{Number}</span> index</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="getSelection"> </a>
- <div class="fixedFont">
-
- <span class="light">{<a href="../symbols/Array.html">Array</a>}</span>
- <b>getSelection</b>()
-
- </div>
- <div class="description">
- Retrieve the currently selected event
-
-
- </div>
-
-
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{<a href="../symbols/Array.html">Array</a>}</span> sel An array with a column row, containing the row number
- of the selected event. If there is no selection, an
- empty array is returned.</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name=".getTarget"> </a>
- <div class="fixedFont"><static>
-
- <span class="light">{Element}</span>
- <span class="light">links.Timeline.</span><b>getTarget</b>(event)
-
- </div>
- <div class="description">
- Get HTML element which is the target of the event
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{MouseEvent}</span> <b>event</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{Element}</span> target element</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="getVisibleChartRange"> </a>
- <div class="fixedFont">
-
- <span class="light">{Object}</span>
- <b>getVisibleChartRange</b>()
-
- </div>
- <div class="description">
- Retrieve the current visible range in the timeline.
-
-
- </div>
-
-
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{Object}</span> An object with start and end properties</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name=".isArray"> </a>
- <div class="fixedFont"><static>
-
- <span class="light">{Boolean}</span>
- <span class="light">links.Timeline.</span><b>isArray</b>(obj)
-
- </div>
- <div class="description">
- Check if given object is a Javascript Array
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{*}</span> <b>obj</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{Boolean}</span> isArray true if the given object is an array</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="isSelected"> </a>
- <div class="fixedFont">
-
- <span class="light">{boolean}</span>
- <b>isSelected</b>(index)
-
- </div>
- <div class="description">
- Check if an item is currently selected
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>index</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{boolean}</span> true if row is selected, else false</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="move"> </a>
- <div class="fixedFont">
-
-
- <b>move</b>(moveFactor)
-
- </div>
- <div class="description">
- Move the timeline the given movefactor to the left or right. Start and end
- date will be adjusted, and the timeline will be redrawn.
- For example, try moveFactor = 0.1 or -0.1
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>moveFactor</b>
-
- </dt>
- <dd>Moving amount. Positive value will move right,
- negative value will move left</dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="onDblClick"> </a>
- <div class="fixedFont">
-
-
- <b>onDblClick</b>(event)
-
- </div>
- <div class="description">
- Double click event occurred for an item
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{event}</span> <b>event</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="onMouseDown"> </a>
- <div class="fixedFont">
-
-
- <b>onMouseDown</b>(event)
-
- </div>
- <div class="description">
- Start a moving operation inside the provided parent element
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{event}</span> <b>event</b>
-
- </dt>
- <dd>The event that occurred (required for
- retrieving the mouse position)</dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="onMouseMove"> </a>
- <div class="fixedFont">
-
-
- <b>onMouseMove</b>(event)
-
- </div>
- <div class="description">
- Perform moving operating.
- This function activated from within the funcion links.Timeline.onMouseDown().
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{event}</span> <b>event</b>
-
- </dt>
- <dd>Well, eehh, the event</dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="onMouseUp"> </a>
- <div class="fixedFont">
-
-
- <b>onMouseUp</b>(event)
-
- </div>
- <div class="description">
- Stop moving operating.
- This function activated from within the funcion links.Timeline.onMouseDown().
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{event}</span> <b>event</b>
-
- </dt>
- <dd>The event</dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="onMouseWheel"> </a>
- <div class="fixedFont">
-
-
- <b>onMouseWheel</b>(event)
-
- </div>
- <div class="description">
- Event handler for mouse wheel event, used to zoom the timeline
- Code from http://adomas.org/javascript-mouse-wheel/
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{event}</span> <b>event</b>
-
- </dt>
- <dd>The event</dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="onTouchEnd"> </a>
- <div class="fixedFont">
-
-
- <b>onTouchEnd</b>(event)
-
- </div>
- <div class="description">
- Event handler for touchend event on mobile devices
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <b>event</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="onTouchMove"> </a>
- <div class="fixedFont">
-
-
- <b>onTouchMove</b>(event)
-
- </div>
- <div class="description">
- Event handler for touchmove event on mobile devices
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <b>event</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="onTouchStart"> </a>
- <div class="fixedFont">
-
-
- <b>onTouchStart</b>(event)
-
- </div>
- <div class="description">
- Event handler for touchstart event on mobile devices
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <b>event</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name=".preventDefault"> </a>
- <div class="fixedFont"><static>
-
-
- <span class="light">links.Timeline.</span><b>preventDefault</b>(event)
-
- </div>
- <div class="description">
- Cancels the event if it is cancelable, without stopping further propagation of the event.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <b>event</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="recalcConversion"> </a>
- <div class="fixedFont">
-
-
- <b>recalcConversion</b>()
-
- </div>
- <div class="description">
- Calculate the factor and offset to convert a position on screen to the
- corresponding date and vice versa.
- After the method calcConversionFactor is executed once, the methods screenToTime and
- timeToScreen can be used.
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="recalcSize"> </a>
- <div class="fixedFont">
-
- <span class="light">{boolean}</span>
- <b>recalcSize</b>()
-
- </div>
- <div class="description">
- Recalculate the sizes of all frames, groups, items, axis
- After recalcSize() is executed, the Timeline should be redrawn normally
-
-
- </div>
-
-
-
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{boolean}</span> resized Returns true when the timeline has been resized</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="redraw"> </a>
- <div class="fixedFont">
-
-
- <b>redraw</b>()
-
- </div>
- <div class="description">
- Redraw the timeline
- Reloads the (linked) data table and redraws the timeline when resized.
- See also the method checkResize
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="redrawAxis"> </a>
- <div class="fixedFont">
-
-
- <b>redrawAxis</b>()
-
- </div>
- <div class="description">
- Redraw the timeline axis with minor and major labels
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="redrawAxisCharacters"> </a>
- <div class="fixedFont">
-
-
- <b>redrawAxisCharacters</b>()
-
- </div>
- <div class="description">
- Create characters used to determine the size of text on the axis
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="redrawAxisEndOverwriting"> </a>
- <div class="fixedFont">
-
-
- <b>redrawAxisEndOverwriting</b>()
-
- </div>
- <div class="description">
- End of overwriting HTML DOM elements of the axis.
- remaining elements will be removed
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="redrawAxisHorizontal"> </a>
- <div class="fixedFont">
-
-
- <b>redrawAxisHorizontal</b>()
-
- </div>
- <div class="description">
- Redraw the horizontal line and background of the axis
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="redrawAxisMajorLine"> </a>
- <div class="fixedFont">
-
-
- <b>redrawAxisMajorLine</b>(x)
-
- </div>
- <div class="description">
- Create a Major line for the axis at position x
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>x</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="redrawAxisMajorText"> </a>
- <div class="fixedFont">
-
-
- <b>redrawAxisMajorText</b>(x, text)
-
- </div>
- <div class="description">
- Create a Major label for the axis at position x
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>x</b>
-
- </dt>
- <dd></dd>
-
- <dt>
- <span class="light fixedFont">{String}</span> <b>text</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="redrawAxisMinorLine"> </a>
- <div class="fixedFont">
-
-
- <b>redrawAxisMinorLine</b>(x)
-
- </div>
- <div class="description">
- Create a minor line for the axis at position x
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>x</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="redrawAxisMinorText"> </a>
- <div class="fixedFont">
-
-
- <b>redrawAxisMinorText</b>(x, text)
-
- </div>
- <div class="description">
- Create a minor label for the axis at position x
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>x</b>
-
- </dt>
- <dd></dd>
-
- <dt>
- <span class="light fixedFont">{String}</span> <b>text</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="redrawAxisStartOverwriting"> </a>
- <div class="fixedFont">
-
-
- <b>redrawAxisStartOverwriting</b>()
-
- </div>
- <div class="description">
- Initialize redraw of the axis. All existing labels and lines will be
- overwritten and reused.
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="redrawContent"> </a>
- <div class="fixedFont">
-
-
- <b>redrawContent</b>()
-
- </div>
- <div class="description">
- Redraw the content of the timeline: the axis and the items
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="redrawCurrentTime"> </a>
- <div class="fixedFont">
-
-
- <b>redrawCurrentTime</b>()
-
- </div>
- <div class="description">
- Redraw the current time bar
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="redrawCustomTime"> </a>
- <div class="fixedFont">
-
-
- <b>redrawCustomTime</b>()
-
- </div>
- <div class="description">
- Redraw the custom time bar
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="redrawDeleteButton"> </a>
- <div class="fixedFont">
-
-
- <b>redrawDeleteButton</b>()
-
- </div>
- <div class="description">
- Redraw the delete button, on the top right of the currently selected item
- if there is no item selected, the button is hidden.
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="redrawDragAreas"> </a>
- <div class="fixedFont">
-
-
- <b>redrawDragAreas</b>()
-
- </div>
- <div class="description">
- Redraw the drag areas. When an item (ranges only) is selected,
- it gets a drag area on the left and right side, to change its width
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="redrawFrame"> </a>
- <div class="fixedFont">
-
-
- <b>redrawFrame</b>()
-
- </div>
- <div class="description">
- Redraw the timeline. This needs to be executed after the start and/or
- end time are changed, or when data is added or removed dynamically.
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="redrawGroups"> </a>
- <div class="fixedFont">
-
-
- <b>redrawGroups</b>()
-
- </div>
- <div class="description">
- Redraw the group labels
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="redrawItems"> </a>
- <div class="fixedFont">
-
-
- <b>redrawItems</b>()
-
- </div>
- <div class="description">
- Redraw all items
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="redrawNavigation"> </a>
- <div class="fixedFont">
-
-
- <b>redrawNavigation</b>()
-
- </div>
- <div class="description">
- Create the navigation buttons for zooming and moving
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name=".removeEventListener"> </a>
- <div class="fixedFont"><static>
-
-
- <span class="light">links.Timeline.</span><b>removeEventListener</b>(element, action, listener, useCapture)
-
- </div>
- <div class="description">
- Remove an event listener from an element
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Element}</span> <b>element</b>
-
- </dt>
- <dd>An html dom element</dd>
-
- <dt>
- <span class="light fixedFont">{string}</span> <b>action</b>
-
- </dt>
- <dd>The name of the event, for example "mousedown"</dd>
-
- <dt>
- <span class="light fixedFont">{function}</span> <b>listener</b>
-
- </dt>
- <dd>The listener function</dd>
-
- <dt>
- <span class="light fixedFont">{boolean}</span> <b>useCapture</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="repositionItem"> </a>
- <div class="fixedFont">
-
-
- <b>repositionItem</b>(item, left, right)
-
- </div>
- <div class="description">
- Reposition given item
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Object}</span> <b>item</b>
-
- </dt>
- <dd></dd>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>left</b>
-
- </dt>
- <dd></dd>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>right</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="screenToTime"> </a>
- <div class="fixedFont">
-
- <span class="light">{Date}</span>
- <b>screenToTime</b>(x)
-
- </div>
- <div class="description">
- Convert a position on screen (pixels) to a datetime
- Before this method can be used, the method calcConversionFactor must be
- executed once.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{int}</span> <b>x</b>
-
- </dt>
- <dd>Position on the screen in pixels</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{Date}</span> time The datetime the corresponds with given position x</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="selectItem"> </a>
- <div class="fixedFont">
-
-
- <b>selectItem</b>(index)
-
- </div>
- <div class="description">
- Select an item by its index
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>index</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="setAutoScale"> </a>
- <div class="fixedFont">
-
-
- <b>setAutoScale</b>(enable)
-
- </div>
- <div class="description">
- Enable or disable autoscaling
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{boolean}</span> <b>enable</b>
-
- </dt>
- <dd>If true or not defined, autoscaling is enabled.
- If false, autoscaling is disabled.</dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="setCurrentTime"> </a>
- <div class="fixedFont">
-
-
- <b>setCurrentTime</b>(time)
-
- </div>
- <div class="description">
- Set current time. This function can be used to set the time in the client
- timeline equal with the time on a server.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Date}</span> <b>time</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="setCustomTime"> </a>
- <div class="fixedFont">
-
-
- <b>setCustomTime</b>(time)
-
- </div>
- <div class="description">
- Set custom time.
- The custom time bar can be used to display events in past or future.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Date}</span> <b>time</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="setData"> </a>
- <div class="fixedFont">
-
-
- <b>setData</b>(data)
-
- </div>
- <div class="description">
- Set data for the timeline
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{google.visualization.DataTable | array}</span> <b>data</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="setGroups"> </a>
- <div class="fixedFont">
-
-
- <b>setGroups</b>(data)
-
- </div>
- <div class="description">
- Set the groups available in the given dataset
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{google.visualization.DataTable | array}</span> <b>data</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="setOptions"> </a>
- <div class="fixedFont">
-
-
- <b>setOptions</b>(options)
-
- </div>
- <div class="description">
- Set options for the timeline.
- Timeline must be redrawn afterwards
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Object}</span> <b>options</b>
-
- </dt>
- <dd>A name/value map containing settings for the
- timeline. Optional.</dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="setScale"> </a>
- <div class="fixedFont">
-
-
- <b>setScale</b>(scale, step)
-
- </div>
- <div class="description">
- Set a custom scale. Autoscaling will be disabled.
- For example setScale(SCALE.MINUTES, 5) will result
- in minor steps of 5 minutes, and major steps of an hour.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{links.Timeline.StepDate.SCALE}</span> <b>scale</b>
-
- </dt>
- <dd>A scale. Choose from SCALE.MILLISECOND,
- SCALE.SECOND, SCALE.MINUTE, SCALE.HOUR,
- SCALE.DAY, SCALE.MONTH, SCALE.YEAR.</dd>
-
- <dt>
- <span class="light fixedFont">{int}</span> <b>step</b>
-
- </dt>
- <dd>A step size, by default 1. Choose for
- example 1, 2, 5, or 10.</dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="setSelection"> </a>
- <div class="fixedFont">
-
- <span class="light">{boolean}</span>
- <b>setSelection</b>(selection)
-
- </div>
- <div class="description">
- Select an event. The visible chart range will be moved such that the selected
- event is placed in the middle.
- For example selection = [{row: 5}];
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{<a href="../symbols/Array.html">Array</a>}</span> <b>selection</b>
-
- </dt>
- <dd>An array with a column row, containing the row
- number (the id) of the event to be selected.</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{boolean}</span> true if selection is succesfully set, else false.</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="setSize"> </a>
- <div class="fixedFont">
-
-
- <b>setSize</b>(width, height)
-
- </div>
- <div class="description">
- Set a new size for the timeline
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{string}</span> <b>width</b>
-
- </dt>
- <dd>Width in pixels or percentage (for example "800px"
- or "50%")</dd>
-
- <dt>
- <span class="light fixedFont">{string}</span> <b>height</b>
-
- </dt>
- <dd>Height in pixels or percentage (for example "400px"
- or "30%")</dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="setVisibleChartRange"> </a>
- <div class="fixedFont">
-
-
- <b>setVisibleChartRange</b>(start, end, redraw)
-
- </div>
- <div class="description">
- Set a new value for the visible range int the timeline.
- Set start to null to include everything from the earliest date to end.
- Set end to null to include everything from start to the last date.
- Example usage:
- myTimeline.setVisibleChartRange(new Date("2010-08-22"),
- new Date("2010-09-13"));
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Date}</span> <b>start</b>
-
- </dt>
- <dd>The start date for the timeline. optional</dd>
-
- <dt>
- <span class="light fixedFont">{Date}</span> <b>end</b>
-
- </dt>
- <dd>The end date for the timeline. optional</dd>
-
- <dt>
- <span class="light fixedFont">{boolean}</span> <b>redraw</b>
-
- </dt>
- <dd>Optional. If true (default) the Timeline is
- directly redrawn</dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="setVisibleChartRangeAuto"> </a>
- <div class="fixedFont">
-
-
- <b>setVisibleChartRangeAuto</b>()
-
- </div>
- <div class="description">
- Change the visible chart range such that all items become visible
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="setVisibleChartRangeNow"> </a>
- <div class="fixedFont">
-
-
- <b>setVisibleChartRangeNow</b>()
-
- </div>
- <div class="description">
- Adjust the visible range such that the current time is located in the center
- of the timeline
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="stackCalculateFinal"> </a>
- <div class="fixedFont">
-
-
- <b>stackCalculateFinal</b>(items)
-
- </div>
- <div class="description">
- Adjust vertical positions of the events such that they don't overlap each
- other.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <b>items</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="stackEvents"> </a>
- <div class="fixedFont">
-
-
- <b>stackEvents</b>(animate)
-
- </div>
- <div class="description">
- Stack the items such that they don't overlap. The items will have a minimal
- distance equal to options.eventMargin.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{boolean}</span> <b>animate</b>
-
- </dt>
- <dd>if animate is true, the items are moved to
- their new position animated</dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="stackEventsCheckOverlap"> </a>
- <div class="fixedFont">
-
- <span class="light">{Object}</span>
- <b>stackEventsCheckOverlap</b>(items, itemIndex, itemStart, itemEnd)
-
- </div>
- <div class="description">
- Check if the destiny position of given item overlaps with any
- of the other items from index itemStart to itemEnd.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{<a href="../symbols/Array.html">Array</a>}</span> <b>items</b>
-
- </dt>
- <dd>Array with items</dd>
-
- <dt>
- <span class="light fixedFont">{int}</span> <b>itemIndex</b>
-
- </dt>
- <dd>Number of the item to be checked for overlap</dd>
-
- <dt>
- <span class="light fixedFont">{int}</span> <b>itemStart</b>
-
- </dt>
- <dd>First item to be checked.</dd>
-
- <dt>
- <span class="light fixedFont">{int}</span> <b>itemEnd</b>
-
- </dt>
- <dd>Last item to be checked.</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{Object}</span> colliding item, or undefined when no collisions</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="stackMoveOneStep"> </a>
- <div class="fixedFont">
-
- <span class="light">{boolean}</span>
- <b>stackMoveOneStep</b>(currentItems, finalItems)
-
- </div>
- <div class="description">
- Move the events one step in the direction of their final positions
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{<a href="../symbols/Array.html">Array</a>}</span> <b>currentItems</b>
-
- </dt>
- <dd>Array with the real items and their current
- positions</dd>
-
- <dt>
- <span class="light fixedFont">{<a href="../symbols/Array.html">Array</a>}</span> <b>finalItems</b>
-
- </dt>
- <dd>Array with objects containing the final
- positions of the items</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{boolean}</span> arrived True if all items have reached their final
- location, else false</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="stackMoveToFinal"> </a>
- <div class="fixedFont">
-
-
- <b>stackMoveToFinal</b>(currentItems, finalItems)
-
- </div>
- <div class="description">
- Move the events from their current position to the final position
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{<a href="../symbols/Array.html">Array</a>}</span> <b>currentItems</b>
-
- </dt>
- <dd>Array with the real items and their current
- positions</dd>
-
- <dt>
- <span class="light fixedFont">{<a href="../symbols/Array.html">Array</a>}</span> <b>finalItems</b>
-
- </dt>
- <dd>Array with objects containing the final
- positions of the items</dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="stackOrder"> </a>
- <div class="fixedFont">
-
- <span class="light">{<a href="../symbols/Array.html">Array</a>}</span>
- <b>stackOrder</b>(items)
-
- </div>
- <div class="description">
- Order the items in the array this.items. The order is determined via:
- - Ranges go before boxes and dots.
- - The item with the left most location goes first
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{<a href="../symbols/Array.html">Array</a>}</span> <b>items</b>
-
- </dt>
- <dd>Array with items</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{<a href="../symbols/Array.html">Array</a>}</span> sortedItems Array with sorted items</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name=".stopPropagation"> </a>
- <div class="fixedFont"><static>
-
-
- <span class="light">links.Timeline.</span><b>stopPropagation</b>(event)
-
- </div>
- <div class="description">
- Stop event propagation
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <b>event</b>
-
- </dt>
- <dd></dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="timeToScreen"> </a>
- <div class="fixedFont">
-
- <span class="light">{int}</span>
- <b>timeToScreen</b>(time)
-
- </div>
- <div class="description">
- Convert a datetime (Date object) into a position on the screen
- Before this method can be used, the method calcConversionFactor must be
- executed once.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Date}</span> <b>time</b>
-
- </dt>
- <dd>A date</dd>
-
- </dl>
-
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Returns:</dt>
-
- <dd><span class="light fixedFont">{int}</span> x The position on the screen in pixels which corresponds
- with the given date.</dd>
-
- </dl>
-
-
-
- <hr />
-
- <a name="trigger"> </a>
- <div class="fixedFont">
-
-
- <b>trigger</b>(event)
-
- </div>
- <div class="description">
- fire an event
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{String}</span> <b>event</b>
-
- </dt>
- <dd>The name of an event, for example "rangechange" or "edit"</dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="unselectItem"> </a>
- <div class="fixedFont">
-
-
- <b>unselectItem</b>()
-
- </div>
- <div class="description">
- Unselect the currently selected event (if any)
-
-
- </div>
-
-
-
-
-
-
-
-
-
-
- <hr />
-
- <a name="updateData"> </a>
- <div class="fixedFont">
-
-
- <b>updateData</b>(index, values)
-
- </div>
- <div class="description">
- Update the original data with changed start, end or group.
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>index</b>
-
- </dt>
- <dd></dd>
-
- <dt>
- <span class="light fixedFont">{Object}</span> <b>values</b>
-
- </dt>
- <dd>An object containing some of the following parameters:
- {Date} start,
- {Date} end,
- {String} content,
- {String} group</dd>
-
- </dl>
-
-
-
-
-
-
-
- <hr />
-
- <a name="zoom"> </a>
- <div class="fixedFont">
-
-
- <b>zoom</b>(zoomFactor, zoomAroundDate)
-
- </div>
- <div class="description">
- Zoom the timeline the given zoomfactor in or out. Start and end date will
- be adjusted, and the timeline will be redrawn. You can optionally give a
- date around which to zoom.
- For example, try zoomfactor = 0.1 or -0.1
-
-
- </div>
-
-
-
-
- <dl class="detailList">
- <dt class="heading">Parameters:</dt>
-
- <dt>
- <span class="light fixedFont">{Number}</span> <b>zoomFactor</b>
-
- </dt>
- <dd>Zooming amount. Positive value will zoom in,
- negative value will zoom out</dd>
-
- <dt>
- <span class="light fixedFont">{Date}</span> <b>zoomAroundDate</b>
-
- </dt>
- <dd>Date around which will be zoomed. Optional</dd>
-
- </dl>
-
-
-
-
-
-
-
-
-
-
-
- <!-- ============================== event details ========================= -->
-
-
- <hr />
- </div>
-
- <!-- ============================== footer ================================= -->
- <div class="fineprint" style="clear:both">
-
- Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Mon Jun 18 2012 09:12:45 GMT+0200 (CEST)
- </div>
- </body>
- </html>
|