global.html 75 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Global - Documentation</title>
  6. <script src="scripts/prettify/prettify.js"></script>
  7. <script src="scripts/prettify/lang-css.js"></script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="styles/prettify.css">
  12. <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
  13. </head>
  14. <body>
  15. <input type="checkbox" id="nav-trigger" class="nav-trigger" />
  16. <label for="nav-trigger" class="navicon-button x">
  17. <div class="navicon"></div>
  18. </label>
  19. <label for="nav-trigger" class="overlay"></label>
  20. <nav>
  21. <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="jsPDF.html">jsPDF</a></li></ul><h3>Global</h3><ul><li><a href="global.html#addFont">addFont</a></li><li><a href="global.html#addHTML">addHTML</a></li><li><a href="global.html#addMetadata">addMetadata</a></li><li><a href="global.html#addPage">addPage</a></li><li><a href="global.html#autoPrint">autoPrint</a></li><li><a href="global.html#CapJoinStyles">CapJoinStyles</a></li><li><a href="global.html#circle">circle</a></li><li><a href="global.html#ellipse">ellipse</a></li><li><a href="global.html#getFontList">getFontList</a></li><li><a href="global.html#lines">lines</a></li><li><a href="global.html#lstext">lstext</a></li><li><a href="global.html#output">output</a></li><li><a href="global.html#rect">rect</a></li><li><a href="global.html#roundedRect">roundedRect</a></li><li><a href="global.html#save">save</a></li><li><a href="global.html#setDisplayMode">setDisplayMode</a></li><li><a href="global.html#setDrawColor">setDrawColor</a></li><li><a href="global.html#setFillColor">setFillColor</a></li><li><a href="global.html#setFont">setFont</a></li><li><a href="global.html#setFontSize">setFontSize</a></li><li><a href="global.html#setFontStyle">setFontStyle</a></li><li><a href="global.html#setLineCap">setLineCap</a></li><li><a href="global.html#setLineJoin">setLineJoin</a></li><li><a href="global.html#setLineWidth">setLineWidth</a></li><li><a href="global.html#setPage">setPage</a></li><li><a href="global.html#setProperties">setProperties</a></li><li><a href="global.html#setTextColor">setTextColor</a></li><li><a href="global.html#text">text</a></li><li><a href="global.html#triangle">triangle</a></li></ul>
  22. </nav>
  23. <div id="main">
  24. <h1 class="page-title">Global</h1>
  25. <section>
  26. <header>
  27. <h2>
  28. </h2>
  29. </header>
  30. <article>
  31. <div class="container-overview">
  32. <dl class="details">
  33. </dl>
  34. </div>
  35. <h3 class="subsection-title">Members</h3>
  36. <h4 class="name" id="addHTML"><span class="type-signature"></span>addHTML<span class="type-signature"></span></h4>
  37. <dl class="details">
  38. <dt class="tag-source">Source:</dt>
  39. <dd class="tag-source"><ul class="dummy"><li>
  40. <a href="plugins_addhtml.js.html">plugins/addhtml.js</a>, <a href="plugins_addhtml.js.html#line12">line 12</a>
  41. </li></ul></dd>
  42. <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li><p>This is being replace with a vector-supporting API. See
  43. <a href="https://cdn.rawgit.com/MrRio/jsPDF/master/examples/html2pdf/showcase_supported_html.html">this link</a></p></li></ul></dd>
  44. </dl>
  45. <div class="description">
  46. <p>Renders an HTML element to canvas object which added to the PDF</p>
  47. <p>This feature requires <a href="https://github.com/niklasvh/html2canvas">html2canvas</a>
  48. or <a href="https://github.com/cburgmer/rasterizeHTML.js">rasterizeHTML</a></p>
  49. </div>
  50. <h4 class="name" id="autoPrint"><span class="type-signature"></span>autoPrint<span class="type-signature"></span></h4>
  51. <dl class="details">
  52. <dt class="tag-source">Source:</dt>
  53. <dd class="tag-source"><ul class="dummy"><li>
  54. <a href="plugins_autoprint.js.html">plugins/autoprint.js</a>, <a href="plugins_autoprint.js.html#line8">line 8</a>
  55. </li></ul></dd>
  56. </dl>
  57. <div class="description">
  58. <p>Makes the PDF automatically print. This works in Chrome, Firefox, Acrobat
  59. Reader.</p>
  60. </div>
  61. <h5>Example</h5>
  62. <pre class="prettyprint"><code>var doc = new jsPDF()
  63. doc.text(10, 10, 'This is a test')
  64. doc.autoPrint()
  65. doc.save('autoprint.pdf')</code></pre>
  66. <h4 class="name" id="CapJoinStyles"><span class="type-signature"></span>CapJoinStyles<span class="type-signature"></span></h4>
  67. <dl class="details">
  68. <dt class="tag-source">Source:</dt>
  69. <dd class="tag-source"><ul class="dummy"><li>
  70. <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line2082">line 2082</a>
  71. </li></ul></dd>
  72. </dl>
  73. <div class="description">
  74. <p>Is an Object providing a mapping from human-readable to
  75. integer flag values designating the varieties of line cap
  76. and join styles.</p>
  77. </div>
  78. <h3 class="subsection-title">Methods</h3>
  79. <h4 class="name" id="addFont"><span class="type-signature"></span>addFont<span class="signature">(Postscript, Name, Font)</span><span class="type-signature"> &rarr; {fontKey}</span></h4>
  80. <dl class="details">
  81. <dt class="tag-source">Source:</dt>
  82. <dd class="tag-source"><ul class="dummy"><li>
  83. <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1883">line 1883</a>
  84. </li></ul></dd>
  85. </dl>
  86. <div class="description">
  87. <p>Add a custom font.</p>
  88. </div>
  89. <h5>Parameters:</h5>
  90. <table class="params">
  91. <thead>
  92. <tr>
  93. <th>Name</th>
  94. <th>Type</th>
  95. <th class="last">Description</th>
  96. </tr>
  97. </thead>
  98. <tbody>
  99. <tr>
  100. <td class="name"><code>Postscript</code></td>
  101. <td class="type">
  102. <span class="param-type">String</span>
  103. </td>
  104. <td class="description last"><p>name of the Font. Example: &quot;Menlo-Regular&quot;</p></td>
  105. </tr>
  106. <tr>
  107. <td class="name"><code>Name</code></td>
  108. <td class="type">
  109. <span class="param-type">String</span>
  110. </td>
  111. <td class="description last"><p>of font-family from @font-face definition. Example: &quot;Menlo Regular&quot;</p></td>
  112. </tr>
  113. <tr>
  114. <td class="name"><code>Font</code></td>
  115. <td class="type">
  116. <span class="param-type">String</span>
  117. </td>
  118. <td class="description last"><p>style. Example: &quot;normal&quot;</p></td>
  119. </tr>
  120. </tbody>
  121. </table>
  122. <h5>Returns:</h5>
  123. <div class="param-desc">
  124. <p>the (same as the internal method)</p>
  125. </div>
  126. <dl class="param-type">
  127. <dt>
  128. Type
  129. </dt>
  130. <dd>
  131. <span class="param-type">fontKey</span>
  132. </dd>
  133. </dl>
  134. <h4 class="name" id="addMetadata"><span class="type-signature"></span>addMetadata<span class="signature">(metadata, namespaceuri)</span><span class="type-signature"> &rarr; {<a href="jsPDF.html">jsPDF</a>}</span></h4>
  135. <dl class="details">
  136. <dt class="tag-source">Source:</dt>
  137. <dd class="tag-source"><ul class="dummy"><li>
  138. <a href="plugins_xmp_metadata.js.html">plugins/xmp_metadata.js</a>, <a href="plugins_xmp_metadata.js.html#line28">line 28</a>
  139. </li></ul></dd>
  140. </dl>
  141. <div class="description">
  142. <p>Adds XMP formatted metadata to PDF</p>
  143. </div>
  144. <h5>Parameters:</h5>
  145. <table class="params">
  146. <thead>
  147. <tr>
  148. <th>Name</th>
  149. <th>Type</th>
  150. <th class="last">Description</th>
  151. </tr>
  152. </thead>
  153. <tbody>
  154. <tr>
  155. <td class="name"><code>metadata</code></td>
  156. <td class="type">
  157. <span class="param-type">String</span>
  158. </td>
  159. <td class="description last"><p>The actual metadata to be added. The metadata shall be stored as XMP simple value. Note that if the metadata string contains XML markup characters &quot;&lt;&quot;, &quot;&gt;&quot; or &quot;&amp;&quot;, those characters should be written using XML entities.</p></td>
  160. </tr>
  161. <tr>
  162. <td class="name"><code>namespaceuri</code></td>
  163. <td class="type">
  164. <span class="param-type">String</span>
  165. </td>
  166. <td class="description last"><p>Sets the namespace URI for the metadata. Last character should be slash or hash.</p></td>
  167. </tr>
  168. </tbody>
  169. </table>
  170. <h5>Returns:</h5>
  171. <dl class="param-type">
  172. <dt>
  173. Type
  174. </dt>
  175. <dd>
  176. <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
  177. </dd>
  178. </dl>
  179. <h4 class="name" id="addPage"><span class="type-signature"></span>addPage<span class="signature">()</span><span class="type-signature"> &rarr; {<a href="jsPDF.html">jsPDF</a>}</span></h4>
  180. <dl class="details">
  181. <dt class="tag-source">Source:</dt>
  182. <dd class="tag-source"><ul class="dummy"><li>
  183. <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1158">line 1158</a>
  184. </li></ul></dd>
  185. </dl>
  186. <div class="description">
  187. <p>Adds (and transfers the focus to) new page to the PDF document.</p>
  188. </div>
  189. <h5>Returns:</h5>
  190. <dl class="param-type">
  191. <dt>
  192. Type
  193. </dt>
  194. <dd>
  195. <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
  196. </dd>
  197. </dl>
  198. <h4 class="name" id="circle"><span class="type-signature"></span>circle<span class="signature">(x, y, r, style)</span><span class="type-signature"> &rarr; {<a href="jsPDF.html">jsPDF</a>}</span></h4>
  199. <dl class="details">
  200. <dt class="tag-source">Source:</dt>
  201. <dd class="tag-source"><ul class="dummy"><li>
  202. <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1770">line 1770</a>
  203. </li></ul></dd>
  204. </dl>
  205. <div class="description">
  206. <p>Adds an circle to PDF</p>
  207. </div>
  208. <h5>Parameters:</h5>
  209. <table class="params">
  210. <thead>
  211. <tr>
  212. <th>Name</th>
  213. <th>Type</th>
  214. <th class="last">Description</th>
  215. </tr>
  216. </thead>
  217. <tbody>
  218. <tr>
  219. <td class="name"><code>x</code></td>
  220. <td class="type">
  221. <span class="param-type">Number</span>
  222. </td>
  223. <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against left edge of the page</p></td>
  224. </tr>
  225. <tr>
  226. <td class="name"><code>y</code></td>
  227. <td class="type">
  228. <span class="param-type">Number</span>
  229. </td>
  230. <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against upper edge of the page</p></td>
  231. </tr>
  232. <tr>
  233. <td class="name"><code>r</code></td>
  234. <td class="type">
  235. <span class="param-type">Number</span>
  236. </td>
  237. <td class="description last"><p>Radius (in units declared at inception of PDF document)</p></td>
  238. </tr>
  239. <tr>
  240. <td class="name"><code>style</code></td>
  241. <td class="type">
  242. <span class="param-type">String</span>
  243. </td>
  244. <td class="description last"><p>A string specifying the painting style or null. Valid styles include: 'S' [default] - stroke, 'F' - fill, and 'DF' (or 'FD') - fill then stroke. A null value postpones setting the style so that a shape may be composed using multiple method calls. The last drawing method call used to define the shape should not have a null style argument.</p></td>
  245. </tr>
  246. </tbody>
  247. </table>
  248. <h5>Returns:</h5>
  249. <dl class="param-type">
  250. <dt>
  251. Type
  252. </dt>
  253. <dd>
  254. <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
  255. </dd>
  256. </dl>
  257. <h4 class="name" id="ellipse"><span class="type-signature"></span>ellipse<span class="signature">(x, y, rx, rx, style)</span><span class="type-signature"> &rarr; {<a href="jsPDF.html">jsPDF</a>}</span></h4>
  258. <dl class="details">
  259. <dt class="tag-source">Source:</dt>
  260. <dd class="tag-source"><ul class="dummy"><li>
  261. <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1706">line 1706</a>
  262. </li></ul></dd>
  263. </dl>
  264. <div class="description">
  265. <p>Adds an ellipse to PDF</p>
  266. </div>
  267. <h5>Parameters:</h5>
  268. <table class="params">
  269. <thead>
  270. <tr>
  271. <th>Name</th>
  272. <th>Type</th>
  273. <th class="last">Description</th>
  274. </tr>
  275. </thead>
  276. <tbody>
  277. <tr>
  278. <td class="name"><code>x</code></td>
  279. <td class="type">
  280. <span class="param-type">Number</span>
  281. </td>
  282. <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against left edge of the page</p></td>
  283. </tr>
  284. <tr>
  285. <td class="name"><code>y</code></td>
  286. <td class="type">
  287. <span class="param-type">Number</span>
  288. </td>
  289. <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against upper edge of the page</p></td>
  290. </tr>
  291. <tr>
  292. <td class="name"><code>rx</code></td>
  293. <td class="type">
  294. <span class="param-type">Number</span>
  295. </td>
  296. <td class="description last"><p>Radius along x axis (in units declared at inception of PDF document)</p></td>
  297. </tr>
  298. <tr>
  299. <td class="name"><code>rx</code></td>
  300. <td class="type">
  301. <span class="param-type">Number</span>
  302. </td>
  303. <td class="description last"><p>Radius along y axis (in units declared at inception of PDF document)</p></td>
  304. </tr>
  305. <tr>
  306. <td class="name"><code>style</code></td>
  307. <td class="type">
  308. <span class="param-type">String</span>
  309. </td>
  310. <td class="description last"><p>A string specifying the painting style or null. Valid styles include: 'S' [default] - stroke, 'F' - fill, and 'DF' (or 'FD') - fill then stroke. A null value postpones setting the style so that a shape may be composed using multiple method calls. The last drawing method call used to define the shape should not have a null style argument.</p></td>
  311. </tr>
  312. </tbody>
  313. </table>
  314. <h5>Returns:</h5>
  315. <dl class="param-type">
  316. <dt>
  317. Type
  318. </dt>
  319. <dd>
  320. <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
  321. </dd>
  322. </dl>
  323. <h4 class="name" id="getFontList"><span class="type-signature"></span>getFontList<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h4>
  324. <dl class="details">
  325. <dt class="tag-source">Source:</dt>
  326. <dd class="tag-source"><ul class="dummy"><li>
  327. <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1854">line 1854</a>
  328. </li></ul></dd>
  329. </dl>
  330. <div class="description">
  331. <p>Returns an object - a tree of fontName to fontStyle relationships available to
  332. active PDF document.</p>
  333. </div>
  334. <h5>Returns:</h5>
  335. <div class="param-desc">
  336. <p>Like {'times':['normal', 'italic', ... ], 'arial':['normal', 'bold', ... ], ... }</p>
  337. </div>
  338. <dl class="param-type">
  339. <dt>
  340. Type
  341. </dt>
  342. <dd>
  343. <span class="param-type">Object</span>
  344. </dd>
  345. </dl>
  346. <h4 class="name" id="lines"><span class="type-signature"></span>lines<span class="signature">(lines, x, y, scale, style, closed)</span><span class="type-signature"> &rarr; {<a href="jsPDF.html">jsPDF</a>}</span></h4>
  347. <dl class="details">
  348. <dt class="tag-source">Source:</dt>
  349. <dd class="tag-source"><ul class="dummy"><li>
  350. <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1527">line 1527</a>
  351. </li></ul></dd>
  352. </dl>
  353. <div class="description">
  354. <p>Adds series of curves (straight lines or cubic bezier curves) to canvas, starting at <code>x</code>, <code>y</code> coordinates.
  355. All data points in <code>lines</code> are relative to last line origin.
  356. <code>x</code>, <code>y</code> become x1,y1 for first line / curve in the set.
  357. For lines you only need to specify [x2, y2] - (ending point) vector against x1, y1 starting point.
  358. For bezier curves you need to specify [x2,y2,x3,y3,x4,y4] - vectors to control points 1, 2, ending point. All vectors are against the start of the curve - x1,y1.</p>
  359. </div>
  360. <h5>Example</h5>
  361. <pre class="prettyprint"><code>.lines([[2,2],[-2,2],[1,1,2,2,3,3],[2,1]], 212,110, 10) // line, line, bezier curve, line</code></pre>
  362. <h5>Parameters:</h5>
  363. <table class="params">
  364. <thead>
  365. <tr>
  366. <th>Name</th>
  367. <th>Type</th>
  368. <th class="last">Description</th>
  369. </tr>
  370. </thead>
  371. <tbody>
  372. <tr>
  373. <td class="name"><code>lines</code></td>
  374. <td class="type">
  375. <span class="param-type">Array</span>
  376. </td>
  377. <td class="description last"><p>Array of <em>vector</em> shifts as pairs (lines) or sextets (cubic bezier curves).</p></td>
  378. </tr>
  379. <tr>
  380. <td class="name"><code>x</code></td>
  381. <td class="type">
  382. <span class="param-type">Number</span>
  383. </td>
  384. <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against left edge of the page</p></td>
  385. </tr>
  386. <tr>
  387. <td class="name"><code>y</code></td>
  388. <td class="type">
  389. <span class="param-type">Number</span>
  390. </td>
  391. <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against upper edge of the page</p></td>
  392. </tr>
  393. <tr>
  394. <td class="name"><code>scale</code></td>
  395. <td class="type">
  396. <span class="param-type">Number</span>
  397. </td>
  398. <td class="description last"><p>(Defaults to [1.0,1.0]) x,y Scaling factor for all vectors. Elements can be any floating number Sub-one makes drawing smaller. Over-one grows the drawing. Negative flips the direction.</p></td>
  399. </tr>
  400. <tr>
  401. <td class="name"><code>style</code></td>
  402. <td class="type">
  403. <span class="param-type">String</span>
  404. </td>
  405. <td class="description last"><p>A string specifying the painting style or null. Valid styles include: 'S' [default] - stroke, 'F' - fill, and 'DF' (or 'FD') - fill then stroke. A null value postpones setting the style so that a shape may be composed using multiple method calls. The last drawing method call used to define the shape should not have a null style argument.</p></td>
  406. </tr>
  407. <tr>
  408. <td class="name"><code>closed</code></td>
  409. <td class="type">
  410. <span class="param-type">Boolean</span>
  411. </td>
  412. <td class="description last"><p>If true, the path is closed with a straight line from the end of the last curve to the starting point.</p></td>
  413. </tr>
  414. </tbody>
  415. </table>
  416. <h5>Returns:</h5>
  417. <dl class="param-type">
  418. <dt>
  419. Type
  420. </dt>
  421. <dd>
  422. <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
  423. </dd>
  424. </dl>
  425. <h4 class="name" id="lstext"><span class="type-signature"></span>lstext<span class="signature">(text, x, y, spacing)</span><span class="type-signature"> &rarr; {<a href="jsPDF.html">jsPDF</a>}</span></h4>
  426. <dl class="details">
  427. <dt class="tag-source">Source:</dt>
  428. <dd class="tag-source"><ul class="dummy"><li>
  429. <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1475">line 1475</a>
  430. </li></ul></dd>
  431. <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li><p>We'll be removing this function. It doesn't take character width into account.</p></li></ul></dd>
  432. </dl>
  433. <div class="description">
  434. <p>Letter spacing method to print text with gaps</p>
  435. </div>
  436. <h5>Parameters:</h5>
  437. <table class="params">
  438. <thead>
  439. <tr>
  440. <th>Name</th>
  441. <th>Type</th>
  442. <th class="last">Description</th>
  443. </tr>
  444. </thead>
  445. <tbody>
  446. <tr>
  447. <td class="name"><code>text</code></td>
  448. <td class="type">
  449. <span class="param-type">String</span>
  450. |
  451. <span class="param-type">Array</span>
  452. </td>
  453. <td class="description last"><p>String to be added to the page.</p></td>
  454. </tr>
  455. <tr>
  456. <td class="name"><code>x</code></td>
  457. <td class="type">
  458. <span class="param-type">Number</span>
  459. </td>
  460. <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against left edge of the page</p></td>
  461. </tr>
  462. <tr>
  463. <td class="name"><code>y</code></td>
  464. <td class="type">
  465. <span class="param-type">Number</span>
  466. </td>
  467. <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against upper edge of the page</p></td>
  468. </tr>
  469. <tr>
  470. <td class="name"><code>spacing</code></td>
  471. <td class="type">
  472. <span class="param-type">Number</span>
  473. </td>
  474. <td class="description last"><p>Spacing (in units declared at inception)</p></td>
  475. </tr>
  476. </tbody>
  477. </table>
  478. <h5>Returns:</h5>
  479. <dl class="param-type">
  480. <dt>
  481. Type
  482. </dt>
  483. <dd>
  484. <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
  485. </dd>
  486. </dl>
  487. <h4 class="name" id="output"><span class="type-signature"></span>output<span class="signature">(type, options)</span><span class="type-signature"> &rarr; {<a href="jsPDF.html">jsPDF</a>}</span></h4>
  488. <dl class="details">
  489. <dt class="tag-source">Source:</dt>
  490. <dd class="tag-source"><ul class="dummy"><li>
  491. <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line981">line 981</a>
  492. </li></ul></dd>
  493. </dl>
  494. <div class="description">
  495. <p>Generates the PDF document.</p>
  496. <p>If <code>type</code> argument is undefined, output is raw body of resulting PDF returned as a string.</p>
  497. </div>
  498. <h5>Parameters:</h5>
  499. <table class="params">
  500. <thead>
  501. <tr>
  502. <th>Name</th>
  503. <th>Type</th>
  504. <th class="last">Description</th>
  505. </tr>
  506. </thead>
  507. <tbody>
  508. <tr>
  509. <td class="name"><code>type</code></td>
  510. <td class="type">
  511. <span class="param-type">String</span>
  512. </td>
  513. <td class="description last"><p>A string identifying one of the possible output types.</p></td>
  514. </tr>
  515. <tr>
  516. <td class="name"><code>options</code></td>
  517. <td class="type">
  518. <span class="param-type">Object</span>
  519. </td>
  520. <td class="description last"><p>An object providing some additional signalling to PDF generator.</p></td>
  521. </tr>
  522. </tbody>
  523. </table>
  524. <h5>Returns:</h5>
  525. <dl class="param-type">
  526. <dt>
  527. Type
  528. </dt>
  529. <dd>
  530. <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
  531. </dd>
  532. </dl>
  533. <h4 class="name" id="rect"><span class="type-signature"></span>rect<span class="signature">(x, y, w, h, style)</span><span class="type-signature"> &rarr; {<a href="jsPDF.html">jsPDF</a>}</span></h4>
  534. <dl class="details">
  535. <dt class="tag-source">Source:</dt>
  536. <dd class="tag-source"><ul class="dummy"><li>
  537. <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1611">line 1611</a>
  538. </li></ul></dd>
  539. </dl>
  540. <div class="description">
  541. <p>Adds a rectangle to PDF</p>
  542. </div>
  543. <h5>Parameters:</h5>
  544. <table class="params">
  545. <thead>
  546. <tr>
  547. <th>Name</th>
  548. <th>Type</th>
  549. <th class="last">Description</th>
  550. </tr>
  551. </thead>
  552. <tbody>
  553. <tr>
  554. <td class="name"><code>x</code></td>
  555. <td class="type">
  556. <span class="param-type">Number</span>
  557. </td>
  558. <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against left edge of the page</p></td>
  559. </tr>
  560. <tr>
  561. <td class="name"><code>y</code></td>
  562. <td class="type">
  563. <span class="param-type">Number</span>
  564. </td>
  565. <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against upper edge of the page</p></td>
  566. </tr>
  567. <tr>
  568. <td class="name"><code>w</code></td>
  569. <td class="type">
  570. <span class="param-type">Number</span>
  571. </td>
  572. <td class="description last"><p>Width (in units declared at inception of PDF document)</p></td>
  573. </tr>
  574. <tr>
  575. <td class="name"><code>h</code></td>
  576. <td class="type">
  577. <span class="param-type">Number</span>
  578. </td>
  579. <td class="description last"><p>Height (in units declared at inception of PDF document)</p></td>
  580. </tr>
  581. <tr>
  582. <td class="name"><code>style</code></td>
  583. <td class="type">
  584. <span class="param-type">String</span>
  585. </td>
  586. <td class="description last"><p>A string specifying the painting style or null. Valid styles include: 'S' [default] - stroke, 'F' - fill, and 'DF' (or 'FD') - fill then stroke. A null value postpones setting the style so that a shape may be composed using multiple method calls. The last drawing method call used to define the shape should not have a null style argument.</p></td>
  587. </tr>
  588. </tbody>
  589. </table>
  590. <h5>Returns:</h5>
  591. <dl class="param-type">
  592. <dt>
  593. Type
  594. </dt>
  595. <dd>
  596. <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
  597. </dd>
  598. </dl>
  599. <h4 class="name" id="roundedRect"><span class="type-signature"></span>roundedRect<span class="signature">(x, y, w, h, rx, rx, style)</span><span class="type-signature"> &rarr; {<a href="jsPDF.html">jsPDF</a>}</span></h4>
  600. <dl class="details">
  601. <dt class="tag-source">Source:</dt>
  602. <dd class="tag-source"><ul class="dummy"><li>
  603. <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1671">line 1671</a>
  604. </li></ul></dd>
  605. </dl>
  606. <div class="description">
  607. <p>Adds a rectangle with rounded corners to PDF</p>
  608. </div>
  609. <h5>Parameters:</h5>
  610. <table class="params">
  611. <thead>
  612. <tr>
  613. <th>Name</th>
  614. <th>Type</th>
  615. <th class="last">Description</th>
  616. </tr>
  617. </thead>
  618. <tbody>
  619. <tr>
  620. <td class="name"><code>x</code></td>
  621. <td class="type">
  622. <span class="param-type">Number</span>
  623. </td>
  624. <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against left edge of the page</p></td>
  625. </tr>
  626. <tr>
  627. <td class="name"><code>y</code></td>
  628. <td class="type">
  629. <span class="param-type">Number</span>
  630. </td>
  631. <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against upper edge of the page</p></td>
  632. </tr>
  633. <tr>
  634. <td class="name"><code>w</code></td>
  635. <td class="type">
  636. <span class="param-type">Number</span>
  637. </td>
  638. <td class="description last"><p>Width (in units declared at inception of PDF document)</p></td>
  639. </tr>
  640. <tr>
  641. <td class="name"><code>h</code></td>
  642. <td class="type">
  643. <span class="param-type">Number</span>
  644. </td>
  645. <td class="description last"><p>Height (in units declared at inception of PDF document)</p></td>
  646. </tr>
  647. <tr>
  648. <td class="name"><code>rx</code></td>
  649. <td class="type">
  650. <span class="param-type">Number</span>
  651. </td>
  652. <td class="description last"><p>Radius along x axis (in units declared at inception of PDF document)</p></td>
  653. </tr>
  654. <tr>
  655. <td class="name"><code>rx</code></td>
  656. <td class="type">
  657. <span class="param-type">Number</span>
  658. </td>
  659. <td class="description last"><p>Radius along y axis (in units declared at inception of PDF document)</p></td>
  660. </tr>
  661. <tr>
  662. <td class="name"><code>style</code></td>
  663. <td class="type">
  664. <span class="param-type">String</span>
  665. </td>
  666. <td class="description last"><p>A string specifying the painting style or null. Valid styles include: 'S' [default] - stroke, 'F' - fill, and 'DF' (or 'FD') - fill then stroke. A null value postpones setting the style so that a shape may be composed using multiple method calls. The last drawing method call used to define the shape should not have a null style argument.</p></td>
  667. </tr>
  668. </tbody>
  669. </table>
  670. <h5>Returns:</h5>
  671. <dl class="param-type">
  672. <dt>
  673. Type
  674. </dt>
  675. <dd>
  676. <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
  677. </dd>
  678. </dl>
  679. <h4 class="name" id="save"><span class="type-signature"></span>save<span class="signature">(filename)</span><span class="type-signature"> &rarr; {<a href="jsPDF.html">jsPDF</a>}</span></h4>
  680. <dl class="details">
  681. <dt class="tag-source">Source:</dt>
  682. <dd class="tag-source"><ul class="dummy"><li>
  683. <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line2156">line 2156</a>
  684. </li></ul></dd>
  685. </dl>
  686. <div class="description">
  687. <p>Saves as PDF document. An alias of jsPDF.output('save', 'filename.pdf')</p>
  688. </div>
  689. <h5>Parameters:</h5>
  690. <table class="params">
  691. <thead>
  692. <tr>
  693. <th>Name</th>
  694. <th>Type</th>
  695. <th class="last">Description</th>
  696. </tr>
  697. </thead>
  698. <tbody>
  699. <tr>
  700. <td class="name"><code>filename</code></td>
  701. <td class="type">
  702. <span class="param-type">String</span>
  703. </td>
  704. <td class="description last"><p>The filename including extension.</p></td>
  705. </tr>
  706. </tbody>
  707. </table>
  708. <h5>Returns:</h5>
  709. <dl class="param-type">
  710. <dt>
  711. Type
  712. </dt>
  713. <dd>
  714. <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
  715. </dd>
  716. </dl>
  717. <h4 class="name" id="setDisplayMode"><span class="type-signature"></span>setDisplayMode<span class="signature">(zoom, layout, pmode)</span><span class="type-signature"> &rarr; {<a href="jsPDF.html">jsPDF</a>}</span></h4>
  718. <dl class="details">
  719. <dt class="tag-source">Source:</dt>
  720. <dd class="tag-source"><ul class="dummy"><li>
  721. <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1231">line 1231</a>
  722. </li></ul></dd>
  723. </dl>
  724. <div class="description">
  725. <p>Set the display mode options of the page like zoom and layout.</p>
  726. </div>
  727. <h5>Parameters:</h5>
  728. <table class="params">
  729. <thead>
  730. <tr>
  731. <th>Name</th>
  732. <th>Type</th>
  733. <th class="last">Description</th>
  734. </tr>
  735. </thead>
  736. <tbody>
  737. <tr>
  738. <td class="name"><code>zoom</code></td>
  739. <td class="type">
  740. <span class="param-type">integer</span>
  741. |
  742. <span class="param-type">String</span>
  743. </td>
  744. <td class="description last"><p>You can pass an integer or percentage as
  745. a string. 2 will scale the document up 2x, '200%' will scale up by the
  746. same amount. You can also set it to 'fullwidth', 'fullheight',
  747. 'fullpage', or 'original'.</p>
  748. <p>Only certain PDF readers support this, such as Adobe Acrobat</p></td>
  749. </tr>
  750. <tr>
  751. <td class="name"><code>layout</code></td>
  752. <td class="type">
  753. <span class="param-type">String</span>
  754. </td>
  755. <td class="description last"><p>Layout mode can be: 'continuous' - this is the
  756. default continuous scroll. 'single' - the single page mode only shows one
  757. page at a time. 'twoleft' - two column left mode, first page starts on
  758. the left, and 'tworight' - pages are laid out in two columns, with the
  759. first page on the right. This would be used for books.</p></td>
  760. </tr>
  761. <tr>
  762. <td class="name"><code>pmode</code></td>
  763. <td class="type">
  764. <span class="param-type">String</span>
  765. </td>
  766. <td class="description last"><p>'UseOutlines' - it shows the
  767. outline of the document on the left. 'UseThumbs' - shows thumbnails along
  768. the left. 'FullScreen' - prompts the user to enter fullscreen mode.</p></td>
  769. </tr>
  770. </tbody>
  771. </table>
  772. <h5>Returns:</h5>
  773. <dl class="param-type">
  774. <dt>
  775. Type
  776. </dt>
  777. <dd>
  778. <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
  779. </dd>
  780. </dl>
  781. <h4 class="name" id="setDrawColor"><span class="type-signature"></span>setDrawColor<span class="signature">(ch1, ch2, ch3, ch4)</span><span class="type-signature"> &rarr; {<a href="jsPDF.html">jsPDF</a>}</span></h4>
  782. <dl class="details">
  783. <dt class="tag-source">Source:</dt>
  784. <dd class="tag-source"><ul class="dummy"><li>
  785. <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1912">line 1912</a>
  786. </li></ul></dd>
  787. </dl>
  788. <div class="description">
  789. <p>Sets the stroke color for upcoming elements.</p>
  790. <p>Depending on the number of arguments given, Gray, RGB, or CMYK
  791. color space is implied.</p>
  792. <p>When only ch1 is given, &quot;Gray&quot; color space is implied and it
  793. must be a value in the range from 0.00 (solid black) to to 1.00 (white)
  794. if values are communicated as String types, or in range from 0 (black)
  795. to 255 (white) if communicated as Number type.
  796. The RGB-like 0-255 range is provided for backward compatibility.</p>
  797. <p>When only ch1,ch2,ch3 are given, &quot;RGB&quot; color space is implied and each
  798. value must be in the range from 0.00 (minimum intensity) to to 1.00
  799. (max intensity) if values are communicated as String types, or
  800. from 0 (min intensity) to to 255 (max intensity) if values are communicated
  801. as Number types.
  802. The RGB-like 0-255 range is provided for backward compatibility.</p>
  803. <p>When ch1,ch2,ch3,ch4 are given, &quot;CMYK&quot; color space is implied and each
  804. value must be a in the range from 0.00 (0% concentration) to to
  805. 1.00 (100% concentration)</p>
  806. <p>Because JavaScript treats fixed point numbers badly (rounds to
  807. floating point nearest to binary representation) it is highly advised to
  808. communicate the fractional numbers as String types, not JavaScript Number type.</p>
  809. </div>
  810. <h5>Parameters:</h5>
  811. <table class="params">
  812. <thead>
  813. <tr>
  814. <th>Name</th>
  815. <th>Type</th>
  816. <th class="last">Description</th>
  817. </tr>
  818. </thead>
  819. <tbody>
  820. <tr>
  821. <td class="name"><code>ch1</code></td>
  822. <td class="type">
  823. <span class="param-type">Number</span>
  824. |
  825. <span class="param-type">String</span>
  826. </td>
  827. <td class="description last"><p>Color channel value</p></td>
  828. </tr>
  829. <tr>
  830. <td class="name"><code>ch2</code></td>
  831. <td class="type">
  832. <span class="param-type">Number</span>
  833. |
  834. <span class="param-type">String</span>
  835. </td>
  836. <td class="description last"><p>Color channel value</p></td>
  837. </tr>
  838. <tr>
  839. <td class="name"><code>ch3</code></td>
  840. <td class="type">
  841. <span class="param-type">Number</span>
  842. |
  843. <span class="param-type">String</span>
  844. </td>
  845. <td class="description last"><p>Color channel value</p></td>
  846. </tr>
  847. <tr>
  848. <td class="name"><code>ch4</code></td>
  849. <td class="type">
  850. <span class="param-type">Number</span>
  851. |
  852. <span class="param-type">String</span>
  853. </td>
  854. <td class="description last"><p>Color channel value</p></td>
  855. </tr>
  856. </tbody>
  857. </table>
  858. <h5>Returns:</h5>
  859. <dl class="param-type">
  860. <dt>
  861. Type
  862. </dt>
  863. <dd>
  864. <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
  865. </dd>
  866. </dl>
  867. <h4 class="name" id="setFillColor"><span class="type-signature"></span>setFillColor<span class="signature">(ch1, ch2, ch3, ch4)</span><span class="type-signature"> &rarr; {<a href="jsPDF.html">jsPDF</a>}</span></h4>
  868. <dl class="details">
  869. <dt class="tag-source">Source:</dt>
  870. <dd class="tag-source"><ul class="dummy"><li>
  871. <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1979">line 1979</a>
  872. </li></ul></dd>
  873. </dl>
  874. <div class="description">
  875. <p>Sets the fill color for upcoming elements.</p>
  876. <p>Depending on the number of arguments given, Gray, RGB, or CMYK
  877. color space is implied.</p>
  878. <p>When only ch1 is given, &quot;Gray&quot; color space is implied and it
  879. must be a value in the range from 0.00 (solid black) to to 1.00 (white)
  880. if values are communicated as String types, or in range from 0 (black)
  881. to 255 (white) if communicated as Number type.
  882. The RGB-like 0-255 range is provided for backward compatibility.</p>
  883. <p>When only ch1,ch2,ch3 are given, &quot;RGB&quot; color space is implied and each
  884. value must be in the range from 0.00 (minimum intensity) to to 1.00
  885. (max intensity) if values are communicated as String types, or
  886. from 0 (min intensity) to to 255 (max intensity) if values are communicated
  887. as Number types.
  888. The RGB-like 0-255 range is provided for backward compatibility.</p>
  889. <p>When ch1,ch2,ch3,ch4 are given, &quot;CMYK&quot; color space is implied and each
  890. value must be a in the range from 0.00 (0% concentration) to to
  891. 1.00 (100% concentration)</p>
  892. <p>Because JavaScript treats fixed point numbers badly (rounds to
  893. floating point nearest to binary representation) it is highly advised to
  894. communicate the fractional numbers as String types, not JavaScript Number type.</p>
  895. </div>
  896. <h5>Parameters:</h5>
  897. <table class="params">
  898. <thead>
  899. <tr>
  900. <th>Name</th>
  901. <th>Type</th>
  902. <th class="last">Description</th>
  903. </tr>
  904. </thead>
  905. <tbody>
  906. <tr>
  907. <td class="name"><code>ch1</code></td>
  908. <td class="type">
  909. <span class="param-type">Number</span>
  910. |
  911. <span class="param-type">String</span>
  912. </td>
  913. <td class="description last"><p>Color channel value</p></td>
  914. </tr>
  915. <tr>
  916. <td class="name"><code>ch2</code></td>
  917. <td class="type">
  918. <span class="param-type">Number</span>
  919. |
  920. <span class="param-type">String</span>
  921. </td>
  922. <td class="description last"><p>Color channel value</p></td>
  923. </tr>
  924. <tr>
  925. <td class="name"><code>ch3</code></td>
  926. <td class="type">
  927. <span class="param-type">Number</span>
  928. |
  929. <span class="param-type">String</span>
  930. </td>
  931. <td class="description last"><p>Color channel value</p></td>
  932. </tr>
  933. <tr>
  934. <td class="name"><code>ch4</code></td>
  935. <td class="type">
  936. <span class="param-type">Number</span>
  937. |
  938. <span class="param-type">String</span>
  939. </td>
  940. <td class="description last"><p>Color channel value</p></td>
  941. </tr>
  942. </tbody>
  943. </table>
  944. <h5>Returns:</h5>
  945. <dl class="param-type">
  946. <dt>
  947. Type
  948. </dt>
  949. <dd>
  950. <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
  951. </dd>
  952. </dl>
  953. <h4 class="name" id="setFont"><span class="type-signature"></span>setFont<span class="signature">(fontName, fontStyle)</span><span class="type-signature"> &rarr; {<a href="jsPDF.html">jsPDF</a>}</span></h4>
  954. <dl class="details">
  955. <dt class="tag-source">Source:</dt>
  956. <dd class="tag-source"><ul class="dummy"><li>
  957. <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1820">line 1820</a>
  958. </li></ul></dd>
  959. </dl>
  960. <div class="description">
  961. <p>Sets text font face, variant for upcoming text elements.
  962. See output of jsPDF.getFontList() for possible font names, styles.</p>
  963. </div>
  964. <h5>Parameters:</h5>
  965. <table class="params">
  966. <thead>
  967. <tr>
  968. <th>Name</th>
  969. <th>Type</th>
  970. <th class="last">Description</th>
  971. </tr>
  972. </thead>
  973. <tbody>
  974. <tr>
  975. <td class="name"><code>fontName</code></td>
  976. <td class="type">
  977. <span class="param-type">String</span>
  978. </td>
  979. <td class="description last"><p>Font name or family. Example: &quot;times&quot;</p></td>
  980. </tr>
  981. <tr>
  982. <td class="name"><code>fontStyle</code></td>
  983. <td class="type">
  984. <span class="param-type">String</span>
  985. </td>
  986. <td class="description last"><p>Font style or variant. Example: &quot;italic&quot;</p></td>
  987. </tr>
  988. </tbody>
  989. </table>
  990. <h5>Returns:</h5>
  991. <dl class="param-type">
  992. <dt>
  993. Type
  994. </dt>
  995. <dd>
  996. <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
  997. </dd>
  998. </dl>
  999. <h4 class="name" id="setFontSize"><span class="type-signature"></span>setFontSize<span class="signature">(size)</span><span class="type-signature"> &rarr; {<a href="jsPDF.html">jsPDF</a>}</span></h4>
  1000. <dl class="details">
  1001. <dt class="tag-source">Source:</dt>
  1002. <dd class="tag-source"><ul class="dummy"><li>
  1003. <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1806">line 1806</a>
  1004. </li></ul></dd>
  1005. </dl>
  1006. <div class="description">
  1007. <p>Sets font size for upcoming text elements.</p>
  1008. </div>
  1009. <h5>Parameters:</h5>
  1010. <table class="params">
  1011. <thead>
  1012. <tr>
  1013. <th>Name</th>
  1014. <th>Type</th>
  1015. <th class="last">Description</th>
  1016. </tr>
  1017. </thead>
  1018. <tbody>
  1019. <tr>
  1020. <td class="name"><code>size</code></td>
  1021. <td class="type">
  1022. <span class="param-type">Number</span>
  1023. </td>
  1024. <td class="description last"><p>Font size in points.</p></td>
  1025. </tr>
  1026. </tbody>
  1027. </table>
  1028. <h5>Returns:</h5>
  1029. <dl class="param-type">
  1030. <dt>
  1031. Type
  1032. </dt>
  1033. <dd>
  1034. <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
  1035. </dd>
  1036. </dl>
  1037. <h4 class="name" id="setFontStyle"><span class="type-signature"></span>setFontStyle<span class="signature">(style)</span><span class="type-signature"> &rarr; {<a href="jsPDF.html">jsPDF</a>}</span></h4>
  1038. <dl class="details">
  1039. <dt class="tag-source">Source:</dt>
  1040. <dd class="tag-source"><ul class="dummy"><li>
  1041. <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1837">line 1837</a>
  1042. </li></ul></dd>
  1043. </dl>
  1044. <div class="description">
  1045. <p>Switches font style or variant for upcoming text elements,
  1046. while keeping the font face or family same.
  1047. See output of jsPDF.getFontList() for possible font names, styles.</p>
  1048. </div>
  1049. <h5>Parameters:</h5>
  1050. <table class="params">
  1051. <thead>
  1052. <tr>
  1053. <th>Name</th>
  1054. <th>Type</th>
  1055. <th class="last">Description</th>
  1056. </tr>
  1057. </thead>
  1058. <tbody>
  1059. <tr>
  1060. <td class="name"><code>style</code></td>
  1061. <td class="type">
  1062. <span class="param-type">String</span>
  1063. </td>
  1064. <td class="description last"><p>Font style or variant. Example: &quot;italic&quot;</p></td>
  1065. </tr>
  1066. </tbody>
  1067. </table>
  1068. <h5>Returns:</h5>
  1069. <dl class="param-type">
  1070. <dt>
  1071. Type
  1072. </dt>
  1073. <dd>
  1074. <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
  1075. </dd>
  1076. </dl>
  1077. <h4 class="name" id="setLineCap"><span class="type-signature"></span>setLineCap<span class="signature">(style)</span><span class="type-signature"> &rarr; {<a href="jsPDF.html">jsPDF</a>}</span></h4>
  1078. <dl class="details">
  1079. <dt class="tag-source">Source:</dt>
  1080. <dd class="tag-source"><ul class="dummy"><li>
  1081. <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line2107">line 2107</a>
  1082. </li></ul></dd>
  1083. </dl>
  1084. <div class="description">
  1085. <p>Sets the line cap styles
  1086. See {jsPDF.CapJoinStyles} for variants</p>
  1087. </div>
  1088. <h5>Parameters:</h5>
  1089. <table class="params">
  1090. <thead>
  1091. <tr>
  1092. <th>Name</th>
  1093. <th>Type</th>
  1094. <th class="last">Description</th>
  1095. </tr>
  1096. </thead>
  1097. <tbody>
  1098. <tr>
  1099. <td class="name"><code>style</code></td>
  1100. <td class="type">
  1101. <span class="param-type">String</span>
  1102. |
  1103. <span class="param-type">Number</span>
  1104. </td>
  1105. <td class="description last"><p>A string or number identifying the type of line cap</p></td>
  1106. </tr>
  1107. </tbody>
  1108. </table>
  1109. <h5>Returns:</h5>
  1110. <dl class="param-type">
  1111. <dt>
  1112. Type
  1113. </dt>
  1114. <dd>
  1115. <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
  1116. </dd>
  1117. </dl>
  1118. <h4 class="name" id="setLineJoin"><span class="type-signature"></span>setLineJoin<span class="signature">(style)</span><span class="type-signature"> &rarr; {<a href="jsPDF.html">jsPDF</a>}</span></h4>
  1119. <dl class="details">
  1120. <dt class="tag-source">Source:</dt>
  1121. <dd class="tag-source"><ul class="dummy"><li>
  1122. <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line2130">line 2130</a>
  1123. </li></ul></dd>
  1124. </dl>
  1125. <div class="description">
  1126. <p>Sets the line join styles
  1127. See {jsPDF.CapJoinStyles} for variants</p>
  1128. </div>
  1129. <h5>Parameters:</h5>
  1130. <table class="params">
  1131. <thead>
  1132. <tr>
  1133. <th>Name</th>
  1134. <th>Type</th>
  1135. <th class="last">Description</th>
  1136. </tr>
  1137. </thead>
  1138. <tbody>
  1139. <tr>
  1140. <td class="name"><code>style</code></td>
  1141. <td class="type">
  1142. <span class="param-type">String</span>
  1143. |
  1144. <span class="param-type">Number</span>
  1145. </td>
  1146. <td class="description last"><p>A string or number identifying the type of line join</p></td>
  1147. </tr>
  1148. </tbody>
  1149. </table>
  1150. <h5>Returns:</h5>
  1151. <dl class="param-type">
  1152. <dt>
  1153. Type
  1154. </dt>
  1155. <dd>
  1156. <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
  1157. </dd>
  1158. </dl>
  1159. <h4 class="name" id="setLineWidth"><span class="type-signature"></span>setLineWidth<span class="signature">(width)</span><span class="type-signature"> &rarr; {<a href="jsPDF.html">jsPDF</a>}</span></h4>
  1160. <dl class="details">
  1161. <dt class="tag-source">Source:</dt>
  1162. <dd class="tag-source"><ul class="dummy"><li>
  1163. <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1898">line 1898</a>
  1164. </li></ul></dd>
  1165. </dl>
  1166. <div class="description">
  1167. <p>Sets line width for upcoming lines.</p>
  1168. </div>
  1169. <h5>Parameters:</h5>
  1170. <table class="params">
  1171. <thead>
  1172. <tr>
  1173. <th>Name</th>
  1174. <th>Type</th>
  1175. <th class="last">Description</th>
  1176. </tr>
  1177. </thead>
  1178. <tbody>
  1179. <tr>
  1180. <td class="name"><code>width</code></td>
  1181. <td class="type">
  1182. <span class="param-type">Number</span>
  1183. </td>
  1184. <td class="description last"><p>Line width (in units declared at inception of PDF document)</p></td>
  1185. </tr>
  1186. </tbody>
  1187. </table>
  1188. <h5>Returns:</h5>
  1189. <dl class="param-type">
  1190. <dt>
  1191. Type
  1192. </dt>
  1193. <dd>
  1194. <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
  1195. </dd>
  1196. </dl>
  1197. <h4 class="name" id="setPage"><span class="type-signature"></span>setPage<span class="signature">(page)</span><span class="type-signature"> &rarr; {<a href="jsPDF.html">jsPDF</a>}</span></h4>
  1198. <dl class="details">
  1199. <dt class="tag-source">Source:</dt>
  1200. <dd class="tag-source"><ul class="dummy"><li>
  1201. <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1170">line 1170</a>
  1202. </li></ul></dd>
  1203. </dl>
  1204. <div class="description">
  1205. <p>Adds (and transfers the focus to) new page to the PDF document.</p>
  1206. </div>
  1207. <h5>Example</h5>
  1208. <pre class="prettyprint"><code>doc = jsPDF()
  1209. doc.addPage()
  1210. doc.addPage()
  1211. doc.text('I am on page 3', 10, 10)
  1212. doc.setPage(1)
  1213. doc.text('I am on page 1', 10, 10)</code></pre>
  1214. <h5>Parameters:</h5>
  1215. <table class="params">
  1216. <thead>
  1217. <tr>
  1218. <th>Name</th>
  1219. <th>Type</th>
  1220. <th class="last">Description</th>
  1221. </tr>
  1222. </thead>
  1223. <tbody>
  1224. <tr>
  1225. <td class="name"><code>page</code></td>
  1226. <td class="type">
  1227. <span class="param-type">Number</span>
  1228. </td>
  1229. <td class="description last"><p>Switch the active page to the page number specified</p></td>
  1230. </tr>
  1231. </tbody>
  1232. </table>
  1233. <h5>Returns:</h5>
  1234. <dl class="param-type">
  1235. <dt>
  1236. Type
  1237. </dt>
  1238. <dd>
  1239. <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
  1240. </dd>
  1241. </dl>
  1242. <h4 class="name" id="setProperties"><span class="type-signature"></span>setProperties<span class="signature">(A)</span><span class="type-signature"> &rarr; {<a href="jsPDF.html">jsPDF</a>}</span></h4>
  1243. <dl class="details">
  1244. <dt class="tag-source">Source:</dt>
  1245. <dd class="tag-source"><ul class="dummy"><li>
  1246. <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1786">line 1786</a>
  1247. </li></ul></dd>
  1248. </dl>
  1249. <div class="description">
  1250. <p>Adds a properties to the PDF document</p>
  1251. </div>
  1252. <h5>Parameters:</h5>
  1253. <table class="params">
  1254. <thead>
  1255. <tr>
  1256. <th>Name</th>
  1257. <th>Type</th>
  1258. <th class="last">Description</th>
  1259. </tr>
  1260. </thead>
  1261. <tbody>
  1262. <tr>
  1263. <td class="name"><code>A</code></td>
  1264. <td class="type">
  1265. <span class="param-type">Object</span>
  1266. </td>
  1267. <td class="description last"><p>property_name-to-property_value object structure.</p></td>
  1268. </tr>
  1269. </tbody>
  1270. </table>
  1271. <h5>Returns:</h5>
  1272. <dl class="param-type">
  1273. <dt>
  1274. Type
  1275. </dt>
  1276. <dd>
  1277. <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
  1278. </dd>
  1279. </dl>
  1280. <h4 class="name" id="setTextColor"><span class="type-signature"></span>setTextColor<span class="signature">(r, g, b)</span><span class="type-signature"> &rarr; {<a href="jsPDF.html">jsPDF</a>}</span></h4>
  1281. <dl class="details">
  1282. <dt class="tag-source">Source:</dt>
  1283. <dd class="tag-source"><ul class="dummy"><li>
  1284. <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line2052">line 2052</a>
  1285. </li></ul></dd>
  1286. </dl>
  1287. <div class="description">
  1288. <p>Sets the text color for upcoming elements.
  1289. If only one, first argument is given,
  1290. treats the value as gray-scale color value.</p>
  1291. </div>
  1292. <h5>Parameters:</h5>
  1293. <table class="params">
  1294. <thead>
  1295. <tr>
  1296. <th>Name</th>
  1297. <th>Type</th>
  1298. <th class="last">Description</th>
  1299. </tr>
  1300. </thead>
  1301. <tbody>
  1302. <tr>
  1303. <td class="name"><code>r</code></td>
  1304. <td class="type">
  1305. <span class="param-type">Number</span>
  1306. </td>
  1307. <td class="description last"><p>Red channel color value in range 0-255 or {String} r color value in hexadecimal, example: '#FFFFFF'</p></td>
  1308. </tr>
  1309. <tr>
  1310. <td class="name"><code>g</code></td>
  1311. <td class="type">
  1312. <span class="param-type">Number</span>
  1313. </td>
  1314. <td class="description last"><p>Green channel color value in range 0-255</p></td>
  1315. </tr>
  1316. <tr>
  1317. <td class="name"><code>b</code></td>
  1318. <td class="type">
  1319. <span class="param-type">Number</span>
  1320. </td>
  1321. <td class="description last"><p>Blue channel color value in range 0-255</p></td>
  1322. </tr>
  1323. </tbody>
  1324. </table>
  1325. <h5>Returns:</h5>
  1326. <dl class="param-type">
  1327. <dt>
  1328. Type
  1329. </dt>
  1330. <dd>
  1331. <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
  1332. </dd>
  1333. </dl>
  1334. <h4 class="name" id="text"><span class="type-signature"></span>text<span class="signature">(text, x, y, flags)</span><span class="type-signature"> &rarr; {<a href="jsPDF.html">jsPDF</a>}</span></h4>
  1335. <dl class="details">
  1336. <dt class="tag-source">Source:</dt>
  1337. <dd class="tag-source"><ul class="dummy"><li>
  1338. <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1266">line 1266</a>
  1339. </li></ul></dd>
  1340. </dl>
  1341. <div class="description">
  1342. <p>Adds text to page. Supports adding multiline text when 'text' argument is an Array of Strings.</p>
  1343. </div>
  1344. <h5>Parameters:</h5>
  1345. <table class="params">
  1346. <thead>
  1347. <tr>
  1348. <th>Name</th>
  1349. <th>Type</th>
  1350. <th class="last">Description</th>
  1351. </tr>
  1352. </thead>
  1353. <tbody>
  1354. <tr>
  1355. <td class="name"><code>text</code></td>
  1356. <td class="type">
  1357. <span class="param-type">String</span>
  1358. |
  1359. <span class="param-type">Array</span>
  1360. </td>
  1361. <td class="description last"><p>String or array of strings to be added to the page. Each line is shifted one line down per font, spacing settings declared before this call.</p></td>
  1362. </tr>
  1363. <tr>
  1364. <td class="name"><code>x</code></td>
  1365. <td class="type">
  1366. <span class="param-type">Number</span>
  1367. </td>
  1368. <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against left edge of the page</p></td>
  1369. </tr>
  1370. <tr>
  1371. <td class="name"><code>y</code></td>
  1372. <td class="type">
  1373. <span class="param-type">Number</span>
  1374. </td>
  1375. <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against upper edge of the page</p></td>
  1376. </tr>
  1377. <tr>
  1378. <td class="name"><code>flags</code></td>
  1379. <td class="type">
  1380. <span class="param-type">Object</span>
  1381. </td>
  1382. <td class="description last"><p>Collection of settings signalling how the text must be encoded. Defaults are sane. If you think you want to pass some flags, you likely can read the source.</p></td>
  1383. </tr>
  1384. </tbody>
  1385. </table>
  1386. <h5>Returns:</h5>
  1387. <dl class="param-type">
  1388. <dt>
  1389. Type
  1390. </dt>
  1391. <dd>
  1392. <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
  1393. </dd>
  1394. </dl>
  1395. <h4 class="name" id="triangle"><span class="type-signature"></span>triangle<span class="signature">(x1, y1, x2, y2, x3, y3, style)</span><span class="type-signature"> &rarr; {<a href="jsPDF.html">jsPDF</a>}</span></h4>
  1396. <dl class="details">
  1397. <dt class="tag-source">Source:</dt>
  1398. <dd class="tag-source"><ul class="dummy"><li>
  1399. <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1641">line 1641</a>
  1400. </li></ul></dd>
  1401. </dl>
  1402. <div class="description">
  1403. <p>Adds a triangle to PDF</p>
  1404. </div>
  1405. <h5>Parameters:</h5>
  1406. <table class="params">
  1407. <thead>
  1408. <tr>
  1409. <th>Name</th>
  1410. <th>Type</th>
  1411. <th class="last">Description</th>
  1412. </tr>
  1413. </thead>
  1414. <tbody>
  1415. <tr>
  1416. <td class="name"><code>x1</code></td>
  1417. <td class="type">
  1418. <span class="param-type">Number</span>
  1419. </td>
  1420. <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against left edge of the page</p></td>
  1421. </tr>
  1422. <tr>
  1423. <td class="name"><code>y1</code></td>
  1424. <td class="type">
  1425. <span class="param-type">Number</span>
  1426. </td>
  1427. <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against upper edge of the page</p></td>
  1428. </tr>
  1429. <tr>
  1430. <td class="name"><code>x2</code></td>
  1431. <td class="type">
  1432. <span class="param-type">Number</span>
  1433. </td>
  1434. <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against left edge of the page</p></td>
  1435. </tr>
  1436. <tr>
  1437. <td class="name"><code>y2</code></td>
  1438. <td class="type">
  1439. <span class="param-type">Number</span>
  1440. </td>
  1441. <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against upper edge of the page</p></td>
  1442. </tr>
  1443. <tr>
  1444. <td class="name"><code>x3</code></td>
  1445. <td class="type">
  1446. <span class="param-type">Number</span>
  1447. </td>
  1448. <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against left edge of the page</p></td>
  1449. </tr>
  1450. <tr>
  1451. <td class="name"><code>y3</code></td>
  1452. <td class="type">
  1453. <span class="param-type">Number</span>
  1454. </td>
  1455. <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against upper edge of the page</p></td>
  1456. </tr>
  1457. <tr>
  1458. <td class="name"><code>style</code></td>
  1459. <td class="type">
  1460. <span class="param-type">String</span>
  1461. </td>
  1462. <td class="description last"><p>A string specifying the painting style or null. Valid styles include: 'S' [default] - stroke, 'F' - fill, and 'DF' (or 'FD') - fill then stroke. A null value postpones setting the style so that a shape may be composed using multiple method calls. The last drawing method call used to define the shape should not have a null style argument.</p></td>
  1463. </tr>
  1464. </tbody>
  1465. </table>
  1466. <h5>Returns:</h5>
  1467. <dl class="param-type">
  1468. <dt>
  1469. Type
  1470. </dt>
  1471. <dd>
  1472. <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
  1473. </dd>
  1474. </dl>
  1475. </article>
  1476. </section>
  1477. </div>
  1478. <br class="clear">
  1479. <footer>
  1480. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.2</a> on Sun Oct 09 2016 11:08:27 GMT+0100 (BST) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
  1481. </footer>
  1482. <script>prettyPrint();</script>
  1483. <script src="scripts/linenumber.js"></script>
  1484. </body>
  1485. </html>