12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <title>Global - Documentation</title>
- <script src="scripts/prettify/prettify.js"></script>
- <script src="scripts/prettify/lang-css.js"></script>
- <!--[if lt IE 9]>
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
- <![endif]-->
- <link type="text/css" rel="stylesheet" href="styles/prettify.css">
- <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
- </head>
- <body>
- <input type="checkbox" id="nav-trigger" class="nav-trigger" />
- <label for="nav-trigger" class="navicon-button x">
- <div class="navicon"></div>
- </label>
- <label for="nav-trigger" class="overlay"></label>
- <nav>
- <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>
- </nav>
- <div id="main">
-
- <h1 class="page-title">Global</h1>
-
-
- <section>
- <header>
-
- <h2>
-
- </h2>
-
-
- </header>
- <article>
- <div class="container-overview">
-
-
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
-
-
-
- </div>
-
-
-
-
-
-
- <h3 class="subsection-title">Members</h3>
-
-
- <h4 class="name" id="addHTML"><span class="type-signature"></span>addHTML<span class="type-signature"></span></h4>
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="plugins_addhtml.js.html">plugins/addhtml.js</a>, <a href="plugins_addhtml.js.html#line12">line 12</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
- <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li><p>This is being replace with a vector-supporting API. See
- <a href="https://cdn.rawgit.com/MrRio/jsPDF/master/examples/html2pdf/showcase_supported_html.html">this link</a></p></li></ul></dd>
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Renders an HTML element to canvas object which added to the PDF</p>
- <p>This feature requires <a href="https://github.com/niklasvh/html2canvas">html2canvas</a>
- or <a href="https://github.com/cburgmer/rasterizeHTML.js">rasterizeHTML</a></p>
- </div>
-
-
- <h4 class="name" id="autoPrint"><span class="type-signature"></span>autoPrint<span class="type-signature"></span></h4>
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="plugins_autoprint.js.html">plugins/autoprint.js</a>, <a href="plugins_autoprint.js.html#line8">line 8</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Makes the PDF automatically print. This works in Chrome, Firefox, Acrobat
- Reader.</p>
- </div>
- <h5>Example</h5>
-
- <pre class="prettyprint"><code>var doc = new jsPDF()
- doc.text(10, 10, 'This is a test')
- doc.autoPrint()
- doc.save('autoprint.pdf')</code></pre>
-
-
- <h4 class="name" id="CapJoinStyles"><span class="type-signature"></span>CapJoinStyles<span class="type-signature"></span></h4>
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line2082">line 2082</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Is an Object providing a mapping from human-readable to
- integer flag values designating the varieties of line cap
- and join styles.</p>
- </div>
-
-
-
- <h3 class="subsection-title">Methods</h3>
-
-
-
- <h4 class="name" id="addFont"><span class="type-signature"></span>addFont<span class="signature">(Postscript, Name, Font)</span><span class="type-signature"> → {fontKey}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1883">line 1883</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Add a custom font.</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>Postscript</code></td>
-
- <td class="type">
-
-
- <span class="param-type">String</span>
-
- </td>
-
-
- <td class="description last"><p>name of the Font. Example: "Menlo-Regular"</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>Name</code></td>
-
- <td class="type">
-
-
- <span class="param-type">String</span>
-
- </td>
-
-
- <td class="description last"><p>of font-family from @font-face definition. Example: "Menlo Regular"</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>Font</code></td>
-
- <td class="type">
-
-
- <span class="param-type">String</span>
-
- </td>
-
-
- <td class="description last"><p>style. Example: "normal"</p></td>
- </tr>
-
- </tbody>
- </table>
- <h5>Returns:</h5>
-
- <div class="param-desc">
- <p>the (same as the internal method)</p>
- </div>
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type">fontKey</span>
- </dd>
- </dl>
-
-
-
-
- <h4 class="name" id="addMetadata"><span class="type-signature"></span>addMetadata<span class="signature">(metadata, namespaceuri)</span><span class="type-signature"> → {<a href="jsPDF.html">jsPDF</a>}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="plugins_xmp_metadata.js.html">plugins/xmp_metadata.js</a>, <a href="plugins_xmp_metadata.js.html#line28">line 28</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Adds XMP formatted metadata to PDF</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>metadata</code></td>
-
- <td class="type">
-
-
- <span class="param-type">String</span>
-
- </td>
-
-
- <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 "<", ">" or "&", those characters should be written using XML entities.</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>namespaceuri</code></td>
-
- <td class="type">
-
-
- <span class="param-type">String</span>
-
- </td>
-
-
- <td class="description last"><p>Sets the namespace URI for the metadata. Last character should be slash or hash.</p></td>
- </tr>
-
- </tbody>
- </table>
- <h5>Returns:</h5>
-
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
- </dd>
- </dl>
-
-
-
-
- <h4 class="name" id="addPage"><span class="type-signature"></span>addPage<span class="signature">()</span><span class="type-signature"> → {<a href="jsPDF.html">jsPDF</a>}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1158">line 1158</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Adds (and transfers the focus to) new page to the PDF document.</p>
- </div>
- <h5>Returns:</h5>
-
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
- </dd>
- </dl>
-
-
-
-
- <h4 class="name" id="circle"><span class="type-signature"></span>circle<span class="signature">(x, y, r, style)</span><span class="type-signature"> → {<a href="jsPDF.html">jsPDF</a>}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1770">line 1770</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Adds an circle to PDF</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>x</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against left edge of the page</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>y</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against upper edge of the page</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>r</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Radius (in units declared at inception of PDF document)</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>style</code></td>
-
- <td class="type">
-
-
- <span class="param-type">String</span>
-
- </td>
-
-
- <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>
- </tr>
-
- </tbody>
- </table>
- <h5>Returns:</h5>
-
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
- </dd>
- </dl>
-
-
-
-
- <h4 class="name" id="ellipse"><span class="type-signature"></span>ellipse<span class="signature">(x, y, rx, rx, style)</span><span class="type-signature"> → {<a href="jsPDF.html">jsPDF</a>}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1706">line 1706</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Adds an ellipse to PDF</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>x</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against left edge of the page</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>y</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against upper edge of the page</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>rx</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Radius along x axis (in units declared at inception of PDF document)</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>rx</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Radius along y axis (in units declared at inception of PDF document)</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>style</code></td>
-
- <td class="type">
-
-
- <span class="param-type">String</span>
-
- </td>
-
-
- <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>
- </tr>
-
- </tbody>
- </table>
- <h5>Returns:</h5>
-
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
- </dd>
- </dl>
-
-
-
-
- <h4 class="name" id="getFontList"><span class="type-signature"></span>getFontList<span class="signature">()</span><span class="type-signature"> → {Object}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1854">line 1854</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Returns an object - a tree of fontName to fontStyle relationships available to
- active PDF document.</p>
- </div>
- <h5>Returns:</h5>
-
- <div class="param-desc">
- <p>Like {'times':['normal', 'italic', ... ], 'arial':['normal', 'bold', ... ], ... }</p>
- </div>
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type">Object</span>
- </dd>
- </dl>
-
-
-
-
- <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"> → {<a href="jsPDF.html">jsPDF</a>}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1527">line 1527</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Adds series of curves (straight lines or cubic bezier curves) to canvas, starting at <code>x</code>, <code>y</code> coordinates.
- All data points in <code>lines</code> are relative to last line origin.
- <code>x</code>, <code>y</code> become x1,y1 for first line / curve in the set.
- For lines you only need to specify [x2, y2] - (ending point) vector against x1, y1 starting point.
- 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>
- </div>
- <h5>Example</h5>
-
- <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>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>lines</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Array</span>
-
- </td>
-
-
- <td class="description last"><p>Array of <em>vector</em> shifts as pairs (lines) or sextets (cubic bezier curves).</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>x</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against left edge of the page</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>y</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against upper edge of the page</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>scale</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <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>
- </tr>
-
- <tr>
-
- <td class="name"><code>style</code></td>
-
- <td class="type">
-
-
- <span class="param-type">String</span>
-
- </td>
-
-
- <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>
- </tr>
-
- <tr>
-
- <td class="name"><code>closed</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Boolean</span>
-
- </td>
-
-
- <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>
- </tr>
-
- </tbody>
- </table>
- <h5>Returns:</h5>
-
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
- </dd>
- </dl>
-
-
-
-
- <h4 class="name" id="lstext"><span class="type-signature"></span>lstext<span class="signature">(text, x, y, spacing)</span><span class="type-signature"> → {<a href="jsPDF.html">jsPDF</a>}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1475">line 1475</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
- <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>
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Letter spacing method to print text with gaps</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>text</code></td>
-
- <td class="type">
-
-
- <span class="param-type">String</span>
- |
- <span class="param-type">Array</span>
-
- </td>
-
-
- <td class="description last"><p>String to be added to the page.</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>x</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against left edge of the page</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>y</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against upper edge of the page</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>spacing</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Spacing (in units declared at inception)</p></td>
- </tr>
-
- </tbody>
- </table>
- <h5>Returns:</h5>
-
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
- </dd>
- </dl>
-
-
-
-
- <h4 class="name" id="output"><span class="type-signature"></span>output<span class="signature">(type, options)</span><span class="type-signature"> → {<a href="jsPDF.html">jsPDF</a>}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line981">line 981</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Generates the PDF document.</p>
- <p>If <code>type</code> argument is undefined, output is raw body of resulting PDF returned as a string.</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>type</code></td>
-
- <td class="type">
-
-
- <span class="param-type">String</span>
-
- </td>
-
-
- <td class="description last"><p>A string identifying one of the possible output types.</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>options</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Object</span>
-
- </td>
-
-
- <td class="description last"><p>An object providing some additional signalling to PDF generator.</p></td>
- </tr>
-
- </tbody>
- </table>
- <h5>Returns:</h5>
-
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
- </dd>
- </dl>
-
-
-
-
- <h4 class="name" id="rect"><span class="type-signature"></span>rect<span class="signature">(x, y, w, h, style)</span><span class="type-signature"> → {<a href="jsPDF.html">jsPDF</a>}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1611">line 1611</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Adds a rectangle to PDF</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>x</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against left edge of the page</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>y</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against upper edge of the page</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>w</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Width (in units declared at inception of PDF document)</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>h</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Height (in units declared at inception of PDF document)</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>style</code></td>
-
- <td class="type">
-
-
- <span class="param-type">String</span>
-
- </td>
-
-
- <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>
- </tr>
-
- </tbody>
- </table>
- <h5>Returns:</h5>
-
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
- </dd>
- </dl>
-
-
-
-
- <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"> → {<a href="jsPDF.html">jsPDF</a>}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1671">line 1671</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Adds a rectangle with rounded corners to PDF</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>x</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against left edge of the page</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>y</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against upper edge of the page</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>w</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Width (in units declared at inception of PDF document)</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>h</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Height (in units declared at inception of PDF document)</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>rx</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Radius along x axis (in units declared at inception of PDF document)</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>rx</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Radius along y axis (in units declared at inception of PDF document)</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>style</code></td>
-
- <td class="type">
-
-
- <span class="param-type">String</span>
-
- </td>
-
-
- <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>
- </tr>
-
- </tbody>
- </table>
- <h5>Returns:</h5>
-
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
- </dd>
- </dl>
-
-
-
-
- <h4 class="name" id="save"><span class="type-signature"></span>save<span class="signature">(filename)</span><span class="type-signature"> → {<a href="jsPDF.html">jsPDF</a>}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line2156">line 2156</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Saves as PDF document. An alias of jsPDF.output('save', 'filename.pdf')</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>filename</code></td>
-
- <td class="type">
-
-
- <span class="param-type">String</span>
-
- </td>
-
-
- <td class="description last"><p>The filename including extension.</p></td>
- </tr>
-
- </tbody>
- </table>
- <h5>Returns:</h5>
-
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
- </dd>
- </dl>
-
-
-
-
- <h4 class="name" id="setDisplayMode"><span class="type-signature"></span>setDisplayMode<span class="signature">(zoom, layout, pmode)</span><span class="type-signature"> → {<a href="jsPDF.html">jsPDF</a>}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1231">line 1231</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Set the display mode options of the page like zoom and layout.</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>zoom</code></td>
-
- <td class="type">
-
-
- <span class="param-type">integer</span>
- |
- <span class="param-type">String</span>
-
- </td>
-
-
- <td class="description last"><p>You can pass an integer or percentage as
- a string. 2 will scale the document up 2x, '200%' will scale up by the
- same amount. You can also set it to 'fullwidth', 'fullheight',
- 'fullpage', or 'original'.</p>
- <p>Only certain PDF readers support this, such as Adobe Acrobat</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>layout</code></td>
-
- <td class="type">
-
-
- <span class="param-type">String</span>
-
- </td>
-
-
- <td class="description last"><p>Layout mode can be: 'continuous' - this is the
- default continuous scroll. 'single' - the single page mode only shows one
- page at a time. 'twoleft' - two column left mode, first page starts on
- the left, and 'tworight' - pages are laid out in two columns, with the
- first page on the right. This would be used for books.</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>pmode</code></td>
-
- <td class="type">
-
-
- <span class="param-type">String</span>
-
- </td>
-
-
- <td class="description last"><p>'UseOutlines' - it shows the
- outline of the document on the left. 'UseThumbs' - shows thumbnails along
- the left. 'FullScreen' - prompts the user to enter fullscreen mode.</p></td>
- </tr>
-
- </tbody>
- </table>
- <h5>Returns:</h5>
-
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
- </dd>
- </dl>
-
-
-
-
- <h4 class="name" id="setDrawColor"><span class="type-signature"></span>setDrawColor<span class="signature">(ch1, ch2, ch3, ch4)</span><span class="type-signature"> → {<a href="jsPDF.html">jsPDF</a>}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1912">line 1912</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Sets the stroke color for upcoming elements.</p>
- <p>Depending on the number of arguments given, Gray, RGB, or CMYK
- color space is implied.</p>
- <p>When only ch1 is given, "Gray" color space is implied and it
- must be a value in the range from 0.00 (solid black) to to 1.00 (white)
- if values are communicated as String types, or in range from 0 (black)
- to 255 (white) if communicated as Number type.
- The RGB-like 0-255 range is provided for backward compatibility.</p>
- <p>When only ch1,ch2,ch3 are given, "RGB" color space is implied and each
- value must be in the range from 0.00 (minimum intensity) to to 1.00
- (max intensity) if values are communicated as String types, or
- from 0 (min intensity) to to 255 (max intensity) if values are communicated
- as Number types.
- The RGB-like 0-255 range is provided for backward compatibility.</p>
- <p>When ch1,ch2,ch3,ch4 are given, "CMYK" color space is implied and each
- value must be a in the range from 0.00 (0% concentration) to to
- 1.00 (100% concentration)</p>
- <p>Because JavaScript treats fixed point numbers badly (rounds to
- floating point nearest to binary representation) it is highly advised to
- communicate the fractional numbers as String types, not JavaScript Number type.</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>ch1</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
- |
- <span class="param-type">String</span>
-
- </td>
-
-
- <td class="description last"><p>Color channel value</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>ch2</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
- |
- <span class="param-type">String</span>
-
- </td>
-
-
- <td class="description last"><p>Color channel value</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>ch3</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
- |
- <span class="param-type">String</span>
-
- </td>
-
-
- <td class="description last"><p>Color channel value</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>ch4</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
- |
- <span class="param-type">String</span>
-
- </td>
-
-
- <td class="description last"><p>Color channel value</p></td>
- </tr>
-
- </tbody>
- </table>
- <h5>Returns:</h5>
-
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
- </dd>
- </dl>
-
-
-
-
- <h4 class="name" id="setFillColor"><span class="type-signature"></span>setFillColor<span class="signature">(ch1, ch2, ch3, ch4)</span><span class="type-signature"> → {<a href="jsPDF.html">jsPDF</a>}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1979">line 1979</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Sets the fill color for upcoming elements.</p>
- <p>Depending on the number of arguments given, Gray, RGB, or CMYK
- color space is implied.</p>
- <p>When only ch1 is given, "Gray" color space is implied and it
- must be a value in the range from 0.00 (solid black) to to 1.00 (white)
- if values are communicated as String types, or in range from 0 (black)
- to 255 (white) if communicated as Number type.
- The RGB-like 0-255 range is provided for backward compatibility.</p>
- <p>When only ch1,ch2,ch3 are given, "RGB" color space is implied and each
- value must be in the range from 0.00 (minimum intensity) to to 1.00
- (max intensity) if values are communicated as String types, or
- from 0 (min intensity) to to 255 (max intensity) if values are communicated
- as Number types.
- The RGB-like 0-255 range is provided for backward compatibility.</p>
- <p>When ch1,ch2,ch3,ch4 are given, "CMYK" color space is implied and each
- value must be a in the range from 0.00 (0% concentration) to to
- 1.00 (100% concentration)</p>
- <p>Because JavaScript treats fixed point numbers badly (rounds to
- floating point nearest to binary representation) it is highly advised to
- communicate the fractional numbers as String types, not JavaScript Number type.</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>ch1</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
- |
- <span class="param-type">String</span>
-
- </td>
-
-
- <td class="description last"><p>Color channel value</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>ch2</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
- |
- <span class="param-type">String</span>
-
- </td>
-
-
- <td class="description last"><p>Color channel value</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>ch3</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
- |
- <span class="param-type">String</span>
-
- </td>
-
-
- <td class="description last"><p>Color channel value</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>ch4</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
- |
- <span class="param-type">String</span>
-
- </td>
-
-
- <td class="description last"><p>Color channel value</p></td>
- </tr>
-
- </tbody>
- </table>
- <h5>Returns:</h5>
-
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
- </dd>
- </dl>
-
-
-
-
- <h4 class="name" id="setFont"><span class="type-signature"></span>setFont<span class="signature">(fontName, fontStyle)</span><span class="type-signature"> → {<a href="jsPDF.html">jsPDF</a>}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1820">line 1820</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Sets text font face, variant for upcoming text elements.
- See output of jsPDF.getFontList() for possible font names, styles.</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>fontName</code></td>
-
- <td class="type">
-
-
- <span class="param-type">String</span>
-
- </td>
-
-
- <td class="description last"><p>Font name or family. Example: "times"</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>fontStyle</code></td>
-
- <td class="type">
-
-
- <span class="param-type">String</span>
-
- </td>
-
-
- <td class="description last"><p>Font style or variant. Example: "italic"</p></td>
- </tr>
-
- </tbody>
- </table>
- <h5>Returns:</h5>
-
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
- </dd>
- </dl>
-
-
-
-
- <h4 class="name" id="setFontSize"><span class="type-signature"></span>setFontSize<span class="signature">(size)</span><span class="type-signature"> → {<a href="jsPDF.html">jsPDF</a>}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1806">line 1806</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Sets font size for upcoming text elements.</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>size</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Font size in points.</p></td>
- </tr>
-
- </tbody>
- </table>
- <h5>Returns:</h5>
-
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
- </dd>
- </dl>
-
-
-
-
- <h4 class="name" id="setFontStyle"><span class="type-signature"></span>setFontStyle<span class="signature">(style)</span><span class="type-signature"> → {<a href="jsPDF.html">jsPDF</a>}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1837">line 1837</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Switches font style or variant for upcoming text elements,
- while keeping the font face or family same.
- See output of jsPDF.getFontList() for possible font names, styles.</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>style</code></td>
-
- <td class="type">
-
-
- <span class="param-type">String</span>
-
- </td>
-
-
- <td class="description last"><p>Font style or variant. Example: "italic"</p></td>
- </tr>
-
- </tbody>
- </table>
- <h5>Returns:</h5>
-
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
- </dd>
- </dl>
-
-
-
-
- <h4 class="name" id="setLineCap"><span class="type-signature"></span>setLineCap<span class="signature">(style)</span><span class="type-signature"> → {<a href="jsPDF.html">jsPDF</a>}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line2107">line 2107</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Sets the line cap styles
- See {jsPDF.CapJoinStyles} for variants</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>style</code></td>
-
- <td class="type">
-
-
- <span class="param-type">String</span>
- |
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>A string or number identifying the type of line cap</p></td>
- </tr>
-
- </tbody>
- </table>
- <h5>Returns:</h5>
-
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
- </dd>
- </dl>
-
-
-
-
- <h4 class="name" id="setLineJoin"><span class="type-signature"></span>setLineJoin<span class="signature">(style)</span><span class="type-signature"> → {<a href="jsPDF.html">jsPDF</a>}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line2130">line 2130</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Sets the line join styles
- See {jsPDF.CapJoinStyles} for variants</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>style</code></td>
-
- <td class="type">
-
-
- <span class="param-type">String</span>
- |
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>A string or number identifying the type of line join</p></td>
- </tr>
-
- </tbody>
- </table>
- <h5>Returns:</h5>
-
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
- </dd>
- </dl>
-
-
-
-
- <h4 class="name" id="setLineWidth"><span class="type-signature"></span>setLineWidth<span class="signature">(width)</span><span class="type-signature"> → {<a href="jsPDF.html">jsPDF</a>}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1898">line 1898</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Sets line width for upcoming lines.</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>width</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Line width (in units declared at inception of PDF document)</p></td>
- </tr>
-
- </tbody>
- </table>
- <h5>Returns:</h5>
-
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
- </dd>
- </dl>
-
-
-
-
- <h4 class="name" id="setPage"><span class="type-signature"></span>setPage<span class="signature">(page)</span><span class="type-signature"> → {<a href="jsPDF.html">jsPDF</a>}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1170">line 1170</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Adds (and transfers the focus to) new page to the PDF document.</p>
- </div>
- <h5>Example</h5>
-
- <pre class="prettyprint"><code>doc = jsPDF()
- doc.addPage()
- doc.addPage()
- doc.text('I am on page 3', 10, 10)
- doc.setPage(1)
- doc.text('I am on page 1', 10, 10)</code></pre>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>page</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Switch the active page to the page number specified</p></td>
- </tr>
-
- </tbody>
- </table>
- <h5>Returns:</h5>
-
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
- </dd>
- </dl>
-
-
-
-
- <h4 class="name" id="setProperties"><span class="type-signature"></span>setProperties<span class="signature">(A)</span><span class="type-signature"> → {<a href="jsPDF.html">jsPDF</a>}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1786">line 1786</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Adds a properties to the PDF document</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>A</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Object</span>
-
- </td>
-
-
- <td class="description last"><p>property_name-to-property_value object structure.</p></td>
- </tr>
-
- </tbody>
- </table>
- <h5>Returns:</h5>
-
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
- </dd>
- </dl>
-
-
-
-
- <h4 class="name" id="setTextColor"><span class="type-signature"></span>setTextColor<span class="signature">(r, g, b)</span><span class="type-signature"> → {<a href="jsPDF.html">jsPDF</a>}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line2052">line 2052</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Sets the text color for upcoming elements.
- If only one, first argument is given,
- treats the value as gray-scale color value.</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>r</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Red channel color value in range 0-255 or {String} r color value in hexadecimal, example: '#FFFFFF'</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>g</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Green channel color value in range 0-255</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>b</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Blue channel color value in range 0-255</p></td>
- </tr>
-
- </tbody>
- </table>
- <h5>Returns:</h5>
-
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
- </dd>
- </dl>
-
-
-
-
- <h4 class="name" id="text"><span class="type-signature"></span>text<span class="signature">(text, x, y, flags)</span><span class="type-signature"> → {<a href="jsPDF.html">jsPDF</a>}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1266">line 1266</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Adds text to page. Supports adding multiline text when 'text' argument is an Array of Strings.</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>text</code></td>
-
- <td class="type">
-
-
- <span class="param-type">String</span>
- |
- <span class="param-type">Array</span>
-
- </td>
-
-
- <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>
- </tr>
-
- <tr>
-
- <td class="name"><code>x</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against left edge of the page</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>y</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against upper edge of the page</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>flags</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Object</span>
-
- </td>
-
-
- <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>
- </tr>
-
- </tbody>
- </table>
- <h5>Returns:</h5>
-
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
- </dd>
- </dl>
-
-
-
-
- <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"> → {<a href="jsPDF.html">jsPDF</a>}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jspdf.js.html">jspdf.js</a>, <a href="jspdf.js.html#line1641">line 1641</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- <p>Adds a triangle to PDF</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>x1</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against left edge of the page</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>y1</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against upper edge of the page</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>x2</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against left edge of the page</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>y2</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against upper edge of the page</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>x3</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against left edge of the page</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>y3</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Number</span>
-
- </td>
-
-
- <td class="description last"><p>Coordinate (in units declared at inception of PDF document) against upper edge of the page</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>style</code></td>
-
- <td class="type">
-
-
- <span class="param-type">String</span>
-
- </td>
-
-
- <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>
- </tr>
-
- </tbody>
- </table>
- <h5>Returns:</h5>
-
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type"><a href="jsPDF.html">jsPDF</a></span>
- </dd>
- </dl>
-
-
-
-
-
- </article>
- </section>
- </div>
- <br class="clear">
- <footer>
- 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.
- </footer>
- <script>prettyPrint();</script>
- <script src="scripts/linenumber.js"></script>
- </body>
- </html>
|