Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 3.9.x will end* 10 May 2021 (12 months).
  • Bug fixes for security issues in 3.9.x will end* 8 May 2023 (36 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.

Differences Between: [Versions 39 and 311] [Versions 39 and 400] [Versions 39 and 401] [Versions 39 and 402] [Versions 39 and 403]

(no description)

Author: Nicola Asuni
Version: 6.3.2
File Size: 24571 lines (900 kb)
Included or required: 1 time
Referenced: 0 times
Includes or requires: 0 files

Defines 2 classes

TCPDF:: (141 methods):
  __construct()
  __destruct()
  setPageUnit()
  setPageFormat()
  setPageOrientation()
  setSpacesRE()
  setRTL()
  getRTL()
  setTempRTL()
  isRTLTextDir()
  setLastH()
  getCellHeight()
  resetLastH()
  getLastH()
  setImageScale()
  getImageScale()
  getPageDimensions()
  getPageWidth()
  getPageHeight()
  getBreakMargin()
  getScaleFactor()
  SetMargins()
  SetLeftMargin()
  SetTopMargin()
  SetRightMargin()
  SetCellPadding()
  setCellPaddings()
  getCellPaddings()
  setCellMargins()
  getCellMargins()
  adjustCellPadding()
  SetAutoPageBreak()
  getAutoPageBreak()
  SetDisplayMode()
  SetCompression()
  setSRGBmode()
  SetDocInfoUnicode()
  SetTitle()
  SetSubject()
  SetAuthor()
  SetKeywords()
  SetCreator()
  Error()
  Open()
  Close()
  setPage()
  lastPage()
  getPage()
  getNumPages()
  addTOCPage()
  endTOCPage()
  AddPage()
  endPage()
  startPage()
  setPageMark()
  setContentMark()
  setHeaderData()
  setFooterData()
  getHeaderData()
  setHeaderMargin()
  getHeaderMargin()
  setFooterMargin()
  getFooterMargin()
  setPrintHeader()
  setPrintFooter()
  getImageRBX()
  getImageRBY()
  resetHeaderTemplate()
  setHeaderTemplateAutoreset()
  Header()
  Footer()
  setHeader()
  setFooter()
  inPageBody()
  setTableHeader()
  PageNo()
  getAllSpotColors()
  AddSpotColor()
  setSpotColor()
  SetDrawSpotColor()
  SetFillSpotColor()
  SetTextSpotColor()
  setColorArray()
  SetDrawColorArray()
  SetFillColorArray()
  SetTextColorArray()
  setColor()
  SetDrawColor()
  SetFillColor()
  SetTextColor()
  GetStringWidth()
  GetArrStringWidth()
  GetCharWidth()
  getRawCharWidth()
  GetNumChars()
  getFontsList()
  AddFont()
  SetFont()
  SetFontSize()
  getFontBBox()
  getAbsFontMeasure()
  getCharBBox()
  getFontDescent()
  getFontAscent()
  isCharDefined()
  replaceMissingChars()
  SetDefaultMonospacedFont()
  AddLink()
  SetLink()
  Link()
  Annotation()
  _putEmbeddedFiles()
  Text()
  AcceptPageBreak()
  checkPageBreak()
  Cell()
  getCellCode()
  replaceChar()
  getCellBorder()
  MultiCell()
  getNumLines()
  getStringHeight()
  Write()
  getRemainingWidth()
  fitBlock()
  Image()
  ImagePngAlpha()
  getGDgamma()
  Ln()
  GetX()
  GetAbsX()
  GetY()
  SetX()
  SetY()
  SetXY()
  SetAbsX()
  SetAbsY()
  SetAbsXY()
  Output()
  _destroy()
  _dochecks()

file:: (275 methods):
  getInternalPageNumberAliases()
  getAllInternalPageNumberAliases()
  replaceRightShiftPageNumAliases()
  setPageBoxTypes()
  _putpages()
  _getannotsrefs()
  _putannotsobjs()
  _putAPXObject()
  _putfonts()
  _puttruetypeunicode()
  _putcidfont0()
  _putimages()
  _putxobjects()
  _putspotcolors()
  _getxobjectdict()
  _putresourcedict()
  _putresources()
  _putinfo()
  setExtraXMP()
  setExtraXMPRDF()
  _putXMP()
  _putcatalog()
  _putviewerpreferences()
  _putheader()
  _enddoc()
  _beginpage()
  _endpage()
  _newobj()
  _getobj()
  _dounderline()
  _dounderlinew()
  _dolinethrough()
  _dolinethroughw()
  _dooverline()
  _dooverlinew()
  _datastring()
  setDocCreationTimestamp()
  setDocModificationTimestamp()
  getDocCreationTimestamp()
  getDocModificationTimestamp()
  _datestring()
  _textstring()
  _getrawstream()
  _out()
  setHeaderFont()
  getHeaderFont()
  setFooterFont()
  getFooterFont()
  setLanguageArray()
  getPDFData()
  addHtmlLink()
  pixelsToUnits()
  unhtmlentities()
  _objectkey()
  _encrypt_data()
  _putencryption()
  _Uvalue()
  _UEvalue()
  _Ovalue()
  _OEvalue()
  _fixAES256Password()
  _generateencryptionkey()
  SetProtection()
  StartTransform()
  StopTransform()
  ScaleX()
  ScaleY()
  ScaleXY()
  Scale()
  MirrorH()
  MirrorV()
  MirrorP()
  MirrorL()
  TranslateX()
  TranslateY()
  Translate()
  Rotate()
  SkewX()
  SkewY()
  Skew()
  Transform()
  SetLineWidth()
  GetLineWidth()
  SetLineStyle()
  _outPoint()
  _outLine()
  _outRect()
  _outCurve()
  _outCurveV()
  _outCurveY()
  Line()
  Rect()
  Curve()
  Polycurve()
  Ellipse()
  _outellipticalarc()
  Circle()
  PolyLine()
  Polygon()
  RegularPolygon()
  StarPolygon()
  RoundedRect()
  RoundedRectXY()
  Arrow()
  setDestination()
  getDestination()
  _putdests()
  setBookmark()
  Bookmark()
  sortBookmarks()
  _putbookmarks()
  IncludeJS()
  addJavascriptObject()
  _putjavascript()
  _addfield()
  setFormDefaultProp()
  getFormDefaultProp()
  TextField()
  RadioButton()
  ListBox()
  ComboBox()
  CheckBox()
  Button()
  _putsignature()
  setUserRights()
  setSignature()
  setSignatureAppearance()
  addEmptySignatureAppearance()
  getSignatureAppearanceArray()
  setTimeStamp()
  applyTSA()
  startPageGroup()
  setStartingPageNumber()
  getAliasRightShift()
  getAliasNbPages()
  getAliasNumPage()
  getPageGroupAlias()
  getPageNumGroupAlias()
  getGroupPageNo()
  getGroupPageNoFormatted()
  PageNoFormatted()
  _putocg()
  startLayer()
  endLayer()
  setVisibility()
  addExtGState()
  setExtGState()
  _putextgstates()
  setOverprint()
  getOverprint()
  setAlpha()
  getAlpha()
  setJPEGQuality()
  setDefaultTableColumns()
  setCellHeightRatio()
  getCellHeightRatio()
  setPDFVersion()
  setViewerPreferences()
  colorRegistrationBar()
  cropMark()
  registrationMark()
  registrationMarkCMYK()
  LinearGradient()
  RadialGradient()
  CoonsPatchMesh()
  Clip()
  Gradient()
  _putshaders()
  PieSector()
  PieSectorXY()
  ImageEps()
  setBarcode()
  getBarcode()
  write1DBarcode()
  write2DBarcode()
  getMargins()
  getOriginalMargins()
  getFontSize()
  getFontSizePt()
  getFontFamily()
  getFontStyle()
  fixHTMLCode()
  getCSSBorderWidth()
  getCSSBorderDashStyle()
  getCSSBorderStyle()
  getCSSPadding()
  getCSSMargin()
  getCSSBorderMargin()
  getCSSFontSpacing()
  getCSSFontStretching()
  getHTMLFontUnits()
  getHtmlDomArray()
  getSpaceString()
  getHashForTCPDFtagParams()
  serializeTCPDFtagParameters()
  unserializeTCPDFtagParameters()
  writeHTMLCell()
  writeHTML()
  openHTMLTagHandler()
  closeHTMLTagHandler()
  addHTMLVertSpace()
  getBorderStartPosition()
  drawHTMLTagBorder()
  setLIsymbol()
  SetBooklet()
  swapMargins()
  setHtmlVSpace()
  setListIndentWidth()
  setOpenCell()
  setHtmlLinksStyle()
  getHTMLUnitToUnits()
  putHtmlListBullet()
  getGraphicVars()
  setGraphicVars()
  _outSaveGraphicsState()
  _outRestoreGraphicsState()
  setBuffer()
  replaceBuffer()
  getBuffer()
  setPageBuffer()
  getPageBuffer()
  setImageBuffer()
  setImageSubBuffer()
  getImageBuffer()
  setFontBuffer()
  setFontSubBuffer()
  getFontBuffer()
  movePage()
  deletePage()
  copyPage()
  addTOC()
  addHTMLTOC()
  startTransaction()
  commitTransaction()
  rollbackTransaction()
  setEqualColumns()
  resetColumns()
  setColumnsArray()
  selectColumn()
  getColumn()
  getNumberOfColumns()
  setTextRenderingMode()
  setTextShadow()
  getTextShadow()
  hyphenateWord()
  hyphenateText()
  setRasterizeVectorImages()
  setFontSubsetting()
  getFontSubsetting()
  stringLeftTrim()
  stringRightTrim()
  stringTrim()
  isUnicodeFont()
  getFontFamilyName()
  startTemplate()
  endTemplate()
  printTemplate()
  setFontStretching()
  getFontStretching()
  setFontSpacing()
  getFontSpacing()
  getPageRegions()
  setPageRegions()
  addPageRegion()
  removePageRegion()
  checkPageRegions()
  ImageSVG()
  convertSVGtMatrix()
  SVGTransform()
  setSVGStyles()
  SVGPath()
  removeTagNamespace()
  startSVGElementHandler()
  endSVGElementHandler()
  segSVGContentHandler()


Class: TCPDF  - X-Ref


__construct($orientation='P', $unit='mm', $format='A4', $unicode=true, $encoding='UTF-8', $diskcache=false, $pdfa=false)   X-Ref
This is the class constructor.
It allows to set up the page format, the orientation and the measure unit used in all the methods (except for the font sizes).

IMPORTANT: Please note that this method sets the mb_internal_encoding to ASCII, so if you are using the mbstring module functions with TCPDF you need to correctly set/unset the mb_internal_encoding when needed.

param: $orientation (string) page orientation. Possible values are (case insensitive):<ul><li>P or Portrait (default)</li><li>L or Landscape</li><li>'' (empty string) for automatic orientation</li></ul>
param: $unit (string) User measure unit. Possible values are:<ul><li>pt: point</li><li>mm: millimeter (default)</li><li>cm: centimeter</li><li>in: inch</li></ul><br />A point equals 1/72 of inch, that is to say about 0.35 mm (an inch being 2.54 cm). This is a very common unit in typography; font sizes are expressed in that unit.
param: $format (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().
param: $unicode (boolean) TRUE means that the input text is unicode (default = true)
param: $encoding (string) Charset encoding (used only when converting back html entities); default is UTF-8.
param: $diskcache (boolean) DEPRECATED FEATURE
param: $pdfa (integer) If not false, set the document to PDF/A mode and the good version (1 or 3).

__destruct()   X-Ref
Default destructor.


setPageUnit($unit)   X-Ref
Set the units of measure for the document.

param: $unit (string) User measure unit. Possible values are:<ul><li>pt: point</li><li>mm: millimeter (default)</li><li>cm: centimeter</li><li>in: inch</li></ul><br />A point equals 1/72 of inch, that is to say about 0.35 mm (an inch being 2.54 cm). This is a very common unit in typography; font sizes are expressed in that unit.

setPageFormat($format, $orientation='P')   X-Ref
Change the format of the current page

param: $format (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() documentation or an array of two numbers (width, height) or an array containing the following measures and options:<ul>
param: $orientation (string) page orientation. Possible values are (case insensitive):<ul>

setPageOrientation($orientation, $autopagebreak='', $bottommargin='')   X-Ref
Set page orientation.

param: $orientation (string) page orientation. Possible values are (case insensitive):<ul><li>P or Portrait (default)</li><li>L or Landscape</li><li>'' (empty string) for automatic orientation</li></ul>
param: $autopagebreak (boolean) Boolean indicating if auto-page-break mode should be on or off.
param: $bottommargin (float) bottom margin of the page.

setSpacesRE($re='/[^\S\xa0]/')   X-Ref
Set regular expression to detect withespaces or word separators.
The pattern delimiter must be the forward-slash character "/".
Some example patterns are:
<pre>
Non-Unicode or missing PCRE unicode support: "/[^\S\xa0]/"
Unicode and PCRE unicode support: "/(?!\xa0)[\s\p{Z}]/u"
Unicode and PCRE unicode support in Chinese mode: "/(?!\xa0)[\s\p{Z}\p{Lo}]/u"
if PCRE unicode support is turned ON ("\P" is the negate class of "\p"):
\s     : any whitespace character
\p{Z}  : any separator
\p{Lo} : Unicode letter or ideograph that does not have lowercase and uppercase variants. Is used to chunk chinese words.
\xa0   : Unicode Character 'NO-BREAK SPACE' (U+00A0)
</pre>

param: $re (string) regular expression (leave empty for default).

setRTL($enable, $resetx=true)   X-Ref
Enable or disable Right-To-Left language mode

param: $enable (Boolean) if true enable Right-To-Left language mode.
param: $resetx (Boolean) if true reset the X position on direction change.

getRTL()   X-Ref
Return the RTL status

return: boolean

setTempRTL($mode)   X-Ref
Force temporary RTL language direction

param: $mode (mixed) can be false, 'L' for LTR or 'R' for RTL

isRTLTextDir()   X-Ref
Return the current temporary RTL status

return: boolean

setLastH($h)   X-Ref
Set the last cell height.

param: $h (float) cell height.
author: Nicola Asuni

getCellHeight($fontsize, $padding=TRUE)   X-Ref
Return the cell height

param: $fontsize (int) Font size in internal units
param: $padding (boolean) If true add cell padding

resetLastH()   X-Ref
Reset the last cell height.


getLastH()   X-Ref
Get the last cell height.

return: last cell height

setImageScale($scale)   X-Ref
Set the adjusting factor to convert pixels to user units.

param: $scale (float) adjusting factor to convert pixels to user units.
author: Nicola Asuni

getImageScale()   X-Ref
Returns the adjusting factor to convert pixels to user units.

author: Nicola Asuni
return: float adjusting factor to convert pixels to user units.

getPageDimensions($pagenum='')   X-Ref
Returns an array of page dimensions:
<ul><li>$this->pagedim[$this->page]['w'] = page width in points</li><li>$this->pagedim[$this->page]['h'] = height in points</li><li>$this->pagedim[$this->page]['wk'] = page width in user units</li><li>$this->pagedim[$this->page]['hk'] = page height in user units</li><li>$this->pagedim[$this->page]['tm'] = top margin</li><li>$this->pagedim[$this->page]['bm'] = bottom margin</li><li>$this->pagedim[$this->page]['lm'] = left margin</li><li>$this->pagedim[$this->page]['rm'] = right margin</li><li>$this->pagedim[$this->page]['pb'] = auto page break</li><li>$this->pagedim[$this->page]['or'] = page orientation</li><li>$this->pagedim[$this->page]['olm'] = original left margin</li><li>$this->pagedim[$this->page]['orm'] = original right margin</li><li>$this->pagedim[$this->page]['Rotate'] = The number of degrees by which the page shall be rotated clockwise when displayed or printed. The value shall be a multiple of 90.</li><li>$this->pagedim[$this->page]['PZ'] = The page's preferred zoom (magnification) factor.</li><li>$this->pagedim[$this->page]['trans'] : the style and duration of the visual transition to use when moving from another page to the given page during a presentation<ul><li>$this->pagedim[$this->page]['trans']['Dur'] = The page's display duration (also called its advance timing): the maximum length of time, in seconds, that the page shall be displayed during presentations before the viewer application shall automatically advance to the next page.</li><li>$this->pagedim[$this->page]['trans']['S'] = transition style : Split, Blinds, Box, Wipe, Dissolve, Glitter, R, Fly, Push, Cover, Uncover, Fade</li><li>$this->pagedim[$this->page]['trans']['D'] = The duration of the transition effect, in seconds.</li><li>$this->pagedim[$this->page]['trans']['Dm'] = (Split and Blinds transition styles only) The dimension in which the specified transition effect shall occur: H = Horizontal, V = Vertical. Default value: H.</li><li>$this->pagedim[$this->page]['trans']['M'] = (Split, Box and Fly transition styles only) The direction of motion for the specified transition effect: I = Inward from the edges of the page, O = Outward from the center of the pageDefault value: I.</li><li>$this->pagedim[$this->page]['trans']['Di'] = (Wipe, Glitter, Fly, Cover, Uncover and Push transition styles only) The direction in which the specified transition effect shall moves, expressed in degrees counterclockwise starting from a left-to-right direction. If the value is a number, it shall be one of: 0 = Left to right, 90 = Bottom to top (Wipe only), 180 = Right to left (Wipe only), 270 = Top to bottom, 315 = Top-left to bottom-right (Glitter only). If the value is a name, it shall be None, which is relevant only for the Fly transition when the value of SS is not 1.0. Default value: 0.</li><li>$this->pagedim[$this->page]['trans']['SS'] = (Fly transition style only) The starting or ending scale at which the changes shall be drawn. If M specifies an inward transition, the scale of the changes drawn shall progress from SS to 1.0 over the course of the transition. If M specifies an outward transition, the scale of the changes drawn shall progress from 1.0 to SS over the course of the transition. Default: 1.0. </li><li>$this->pagedim[$this->page]['trans']['B'] = (Fly transition style only) If true, the area that shall be flown in is rectangular and opaque. Default: false.</li></ul></li><li>$this->pagedim[$this->page]['MediaBox'] : the boundaries of the physical medium on which the page shall be displayed or printed<ul><li>$this->pagedim[$this->page]['MediaBox']['llx'] = lower-left x coordinate in points</li><li>$this->pagedim[$this->page]['MediaBox']['lly'] = lower-left y coordinate in points</li><li>$this->pagedim[$this->page]['MediaBox']['urx'] = upper-right x coordinate in points</li><li>$this->pagedim[$this->page]['MediaBox']['ury'] = upper-right y coordinate in points</li></ul></li><li>$this->pagedim[$this->page]['CropBox'] : the visible region of default user space<ul><li>$this->pagedim[$this->page]['CropBox']['llx'] = lower-left x coordinate in points</li><li>$this->pagedim[$this->page]['CropBox']['lly'] = lower-left y coordinate in points</li><li>$this->pagedim[$this->page]['CropBox']['urx'] = upper-right x coordinate in points</li><li>$this->pagedim[$this->page]['CropBox']['ury'] = upper-right y coordinate in points</li></ul></li><li>$this->pagedim[$this->page]['BleedBox'] : the region to which the contents of the page shall be clipped when output in a production environment<ul><li>$this->pagedim[$this->page]['BleedBox']['llx'] = lower-left x coordinate in points</li><li>$this->pagedim[$this->page]['BleedBox']['lly'] = lower-left y coordinate in points</li><li>$this->pagedim[$this->page]['BleedBox']['urx'] = upper-right x coordinate in points</li><li>$this->pagedim[$this->page]['BleedBox']['ury'] = upper-right y coordinate in points</li></ul></li><li>$this->pagedim[$this->page]['TrimBox'] : the intended dimensions of the finished page after trimming<ul><li>$this->pagedim[$this->page]['TrimBox']['llx'] = lower-left x coordinate in points</li><li>$this->pagedim[$this->page]['TrimBox']['lly'] = lower-left y coordinate in points</li><li>$this->pagedim[$this->page]['TrimBox']['urx'] = upper-right x coordinate in points</li><li>$this->pagedim[$this->page]['TrimBox']['ury'] = upper-right y coordinate in points</li></ul></li><li>$this->pagedim[$this->page]['ArtBox'] : the extent of the page's meaningful content<ul><li>$this->pagedim[$this->page]['ArtBox']['llx'] = lower-left x coordinate in points</li><li>$this->pagedim[$this->page]['ArtBox']['lly'] = lower-left y coordinate in points</li><li>$this->pagedim[$this->page]['ArtBox']['urx'] = upper-right x coordinate in points</li><li>$this->pagedim[$this->page]['ArtBox']['ury'] = upper-right y coordinate in points</li></ul></li></ul>

param: $pagenum (int) page number (empty = current page)
author: Nicola Asuni
return: array of page dimensions.

getPageWidth($pagenum='')   X-Ref
Returns the page width in units.

param: $pagenum (int) page number (empty = current page)
author: Nicola Asuni
return: int page width.

getPageHeight($pagenum='')   X-Ref
Returns the page height in units.

param: $pagenum (int) page number (empty = current page)
author: Nicola Asuni
return: int page height.

getBreakMargin($pagenum='')   X-Ref
Returns the page break margin.

param: $pagenum (int) page number (empty = current page)
author: Nicola Asuni
return: int page break margin.

getScaleFactor()   X-Ref
Returns the scale factor (number of points in user unit).

author: Nicola Asuni
return: int scale factor.

SetMargins($left, $top, $right=-1, $keepmargins=false)   X-Ref
Defines the left, top and right margins.

param: $left (float) Left margin.
param: $top (float) Top margin.
param: $right (float) Right margin. Default value is the left one.
param: $keepmargins (boolean) if true overwrites the default page margins

SetLeftMargin($margin)   X-Ref
Defines the left margin. The method can be called before creating the first page. If the current abscissa gets out of page, it is brought back to the margin.

param: $margin (float) The margin.

SetTopMargin($margin)   X-Ref
Defines the top margin. The method can be called before creating the first page.

param: $margin (float) The margin.

SetRightMargin($margin)   X-Ref
Defines the right margin. The method can be called before creating the first page.

param: $margin (float) The margin.

SetCellPadding($pad)   X-Ref
Set the same internal Cell padding for top, right, bottom, left-

param: $pad (float) internal padding.

setCellPaddings($left='', $top='', $right='', $bottom='')   X-Ref
Set the internal Cell paddings.

param: $left (float) left padding
param: $top (float) top padding
param: $right (float) right padding
param: $bottom (float) bottom padding

getCellPaddings()   X-Ref
Get the internal Cell padding array.

return: array of padding values

setCellMargins($left='', $top='', $right='', $bottom='')   X-Ref
Set the internal Cell margins.

param: $left (float) left margin
param: $top (float) top margin
param: $right (float) right margin
param: $bottom (float) bottom margin

getCellMargins()   X-Ref
Get the internal Cell margin array.

return: array of margin values

adjustCellPadding($brd=0)   X-Ref
Adjust the internal Cell padding array to take account of the line width.

param: $brd (mixed) Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
return: array of adjustments

SetAutoPageBreak($auto, $margin=0)   X-Ref
Enables or disables the automatic page breaking mode. When enabling, the second parameter is the distance from the bottom of the page that defines the triggering limit. By default, the mode is on and the margin is 2 cm.

param: $auto (boolean) Boolean indicating if mode should be on or off.
param: $margin (float) Distance from the bottom of the page.

getAutoPageBreak()   X-Ref
Return the auto-page-break mode (true or false).

return: boolean auto-page-break mode

SetDisplayMode($zoom, $layout='SinglePage', $mode='UseNone')   X-Ref
Defines the way the document is to be displayed by the viewer.

param: $zoom (mixed) The zoom to use. It can be one of the following string values or a number indicating the zooming factor to use. <ul><li>fullpage: displays the entire page on screen </li><li>fullwidth: uses maximum width of window</li><li>real: uses real size (equivalent to 100% zoom)</li><li>default: uses viewer default mode</li></ul>
param: $layout (string) The page layout. Possible values are:<ul><li>SinglePage Display one page at a time</li><li>OneColumn Display the pages in one column</li><li>TwoColumnLeft Display the pages in two columns, with odd-numbered pages on the left</li><li>TwoColumnRight Display the pages in two columns, with odd-numbered pages on the right</li><li>TwoPageLeft (PDF 1.5) Display the pages two at a time, with odd-numbered pages on the left</li><li>TwoPageRight (PDF 1.5) Display the pages two at a time, with odd-numbered pages on the right</li></ul>
param: $mode (string) A name object specifying how the document should be displayed when opened:<ul><li>UseNone Neither document outline nor thumbnail images visible</li><li>UseOutlines Document outline visible</li><li>UseThumbs Thumbnail images visible</li><li>FullScreen Full-screen mode, with no menu bar, window controls, or any other window visible</li><li>UseOC (PDF 1.5) Optional content group panel visible</li><li>UseAttachments (PDF 1.6) Attachments panel visible</li></ul>

SetCompression($compress=true)   X-Ref
Activates or deactivates page compression. When activated, the internal representation of each page is compressed, which leads to a compression ratio of about 2 for the resulting document. Compression is on by default.
Note: the Zlib extension is required for this feature. If not present, compression will be turned off.

param: $compress (boolean) Boolean indicating if compression must be enabled.

setSRGBmode($mode=false)   X-Ref
Set flag to force sRGB_IEC61966-2.1 black scaled ICC color profile for the whole document.

param: $mode (boolean) If true force sRGB output intent.

SetDocInfoUnicode($unicode=true)   X-Ref
Turn on/off Unicode mode for document information dictionary (meta tags).
This has effect only when unicode mode is set to false.

param: $unicode (boolean) if true set the meta information in Unicode

SetTitle($title)   X-Ref
Defines the title of the document.

param: $title (string) The title.

SetSubject($subject)   X-Ref
Defines the subject of the document.

param: $subject (string) The subject.

SetAuthor($author)   X-Ref
Defines the author of the document.

param: $author (string) The name of the author.

SetKeywords($keywords)   X-Ref
Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.

param: $keywords (string) The list of keywords.

SetCreator($creator)   X-Ref
Defines the creator of the document. This is typically the name of the application that generates the PDF.

param: $creator (string) The name of the creator.

Error($msg)   X-Ref
Throw an exception or print an error message and die if the K_TCPDF_PARSER_THROW_EXCEPTION_ERROR constant is set to true.

param: $msg (string) The error message

Open()   X-Ref
This method begins the generation of the PDF document.
It is not necessary to call it explicitly because AddPage() does it automatically.
Note: no page is created by this method


Close()   X-Ref
Terminates the PDF document.
It is not necessary to call this method explicitly because Output() does it automatically.
If the document contains no page, AddPage() is called to prevent from getting an invalid document.


setPage($pnum, $resetmargins=false)   X-Ref
Move pointer at the specified document page and update page dimensions.

param: $pnum (int) page number (1 ... numpages)
param: $resetmargins (boolean) if true reset left, right, top margins and Y position.

lastPage($resetmargins=false)   X-Ref
Reset pointer to the last document page.

param: $resetmargins (boolean) if true reset left, right, top margins and Y position.

getPage()   X-Ref
Get current document page number.

return: int page number

getNumPages()   X-Ref
Get the total number of insered pages.

return: int number of pages

addTOCPage($orientation='', $format='', $keepmargins=false)   X-Ref
Adds a new TOC (Table Of Content) page to the document.

param: $orientation (string) page orientation.
param: $format (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().
param: $keepmargins (boolean) if true overwrites the default page margins with the current margins

endTOCPage()   X-Ref
Terminate the current TOC (Table Of Content) page


AddPage($orientation='', $format='', $keepmargins=false, $tocpage=false)   X-Ref
Adds a new page to the document. If a page is already present, the Footer() method is called first to output the footer (if enabled). Then the page is added, the current position set to the top-left corner according to the left and top margins (or top-right if in RTL mode), and Header() is called to display the header (if enabled).
The origin of the coordinate system is at the top-left corner (or top-right for RTL) and increasing ordinates go downwards.

param: $orientation (string) page orientation. Possible values are (case insensitive):<ul><li>P or PORTRAIT (default)</li><li>L or LANDSCAPE</li></ul>
param: $format (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().
param: $keepmargins (boolean) if true overwrites the default page margins with the current margins
param: $tocpage (boolean) if true set the tocpage state to true (the added page will be used to display Table Of Content).

endPage($tocpage=false)   X-Ref
Terminate the current page

param: $tocpage (boolean) if true set the tocpage state to false (end the page used to display Table Of Content).

startPage($orientation='', $format='', $tocpage=false)   X-Ref
Starts a new page to the document. The page must be closed using the endPage() function.
The origin of the coordinate system is at the top-left corner and increasing ordinates go downwards.

param: $orientation (string) page orientation. Possible values are (case insensitive):<ul><li>P or PORTRAIT (default)</li><li>L or LANDSCAPE</li></ul>
param: $format (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().
param: $tocpage (boolean) if true the page is designated to contain the Table-Of-Content.

setPageMark()   X-Ref
Set start-writing mark on current page stream used to put borders and fills.
Borders and fills are always created after content and inserted on the position marked by this method.
This function must be called after calling Image() function for a background image.
Background images must be always inserted before calling Multicell() or WriteHTMLCell() or WriteHTML() functions.


setContentMark($page=0)   X-Ref
Set start-writing mark on selected page.
Borders and fills are always created after content and inserted on the position marked by this method.

param: $page (int) page number (default is the current page)

setHeaderData($ln='', $lw=0, $ht='', $hs='', $tc=array(0,0,0)   X-Ref
Set header data.

param: $ln (string) header image logo
param: $lw (string) header image logo width in mm
param: $ht (string) string to print as title on document header
param: $hs (string) string to print on document header
param: $tc (array) RGB array color for text.
param: $lc (array) RGB array color for line.

setFooterData($tc=array(0,0,0)   X-Ref
Set footer data.

param: $tc (array) RGB array color for text.
param: $lc (array) RGB array color for line.

getHeaderData()   X-Ref
Returns header data:
<ul><li>$ret['logo'] = logo image</li><li>$ret['logo_width'] = width of the image logo in user units</li><li>$ret['title'] = header title</li><li>$ret['string'] = header description string</li></ul>

return: array()

setHeaderMargin($hm=10)   X-Ref
Set header margin.
(minimum distance between header and top page margin)

param: $hm (int) distance in user units

getHeaderMargin()   X-Ref
Returns header margin in user units.

return: float

setFooterMargin($fm=10)   X-Ref
Set footer margin.
(minimum distance between footer and bottom page margin)

param: $fm (int) distance in user units

getFooterMargin()   X-Ref
Returns footer margin in user units.

return: float

setPrintHeader($val=true)   X-Ref
Set a flag to print page header.

param: $val (boolean) set to true to print the page header (default), false otherwise.

setPrintFooter($val=true)   X-Ref
Set a flag to print page footer.

param: $val (boolean) set to true to print the page footer (default), false otherwise.

getImageRBX()   X-Ref
Return the right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image

return: float

getImageRBY()   X-Ref
Return the right-bottom (or left-bottom for RTL) corner Y coordinate of last inserted image

return: float

resetHeaderTemplate()   X-Ref
Reset the xobject template used by Header() method.


setHeaderTemplateAutoreset($val=true)   X-Ref
Set a flag to automatically reset the xobject template used by Header() method at each page.

param: $val (boolean) set to true to reset Header xobject template at each page, false otherwise.

Header()   X-Ref
This method is used to render the page header.
It is automatically called by AddPage() and could be overwritten in your own inherited class.


Footer()   X-Ref
This method is used to render the page footer.
It is automatically called by AddPage() and could be overwritten in your own inherited class.


setHeader()   X-Ref
This method is used to render the page header.


setFooter()   X-Ref
This method is used to render the page footer.


inPageBody()   X-Ref
Check if we are on the page body (excluding page header and footer).

return: true if we are not in page header nor in page footer, false otherwise.

setTableHeader()   X-Ref
This method is used to render the table header on new page (if any).


PageNo()   X-Ref
Returns the current page number.

return: int page number

getAllSpotColors()   X-Ref
Returns the array of spot colors.

return: (array) Spot colors array.

AddSpotColor($name, $c, $m, $y, $k)   X-Ref
Defines a new spot color.
It can be expressed in RGB components or gray scale.
The method can be called before the first page is created and the value is retained from page to page.

param: $name (string) Full name of the spot color.
param: $c (float) Cyan color for CMYK. Value between 0 and 100.
param: $m (float) Magenta color for CMYK. Value between 0 and 100.
param: $y (float) Yellow color for CMYK. Value between 0 and 100.
param: $k (float) Key (Black) color for CMYK. Value between 0 and 100.

setSpotColor($type, $name, $tint=100)   X-Ref
Set the spot color for the specified type ('draw', 'fill', 'text').

param: $type (string) Type of object affected by this color: ('draw', 'fill', 'text').
param: $name (string) Name of the spot color.
param: $tint (float) Intensity of the color (from 0 to 100 ; 100 = full intensity by default).
return: (string) PDF color command.

SetDrawSpotColor($name, $tint=100)   X-Ref
Defines the spot color used for all drawing operations (lines, rectangles and cell borders).

param: $name (string) Name of the spot color.
param: $tint (float) Intensity of the color (from 0 to 100 ; 100 = full intensity by default).

SetFillSpotColor($name, $tint=100)   X-Ref
Defines the spot color used for all filling operations (filled rectangles and cell backgrounds).

param: $name (string) Name of the spot color.
param: $tint (float) Intensity of the color (from 0 to 100 ; 100 = full intensity by default).

SetTextSpotColor($name, $tint=100)   X-Ref
Defines the spot color used for text.

param: $name (string) Name of the spot color.
param: $tint (int) Intensity of the color (from 0 to 100 ; 100 = full intensity by default).

setColorArray($type, $color, $ret=false)   X-Ref
Set the color array for the specified type ('draw', 'fill', 'text').
It can be expressed in RGB, CMYK or GRAY SCALE components.
The method can be called before the first page is created and the value is retained from page to page.

param: $type (string) Type of object affected by this color: ('draw', 'fill', 'text').
param: $color (array) Array of colors (1=gray, 3=RGB, 4=CMYK or 5=spotcolor=CMYK+name values).
param: $ret (boolean) If true do not send the PDF command.
return: (string) The PDF command or empty string.

SetDrawColorArray($color, $ret=false)   X-Ref
Defines the color used for all drawing operations (lines, rectangles and cell borders).
It can be expressed in RGB, CMYK or GRAY SCALE components.
The method can be called before the first page is created and the value is retained from page to page.

param: $color (array) Array of colors (1, 3 or 4 values).
param: $ret (boolean) If true do not send the PDF command.
return: string the PDF command

SetFillColorArray($color, $ret=false)   X-Ref
Defines the color used for all filling operations (filled rectangles and cell backgrounds).
It can be expressed in RGB, CMYK or GRAY SCALE components.
The method can be called before the first page is created and the value is retained from page to page.

param: $color (array) Array of colors (1, 3 or 4 values).
param: $ret (boolean) If true do not send the PDF command.

SetTextColorArray($color, $ret=false)   X-Ref
Defines the color used for text. It can be expressed in RGB components or gray scale.
The method can be called before the first page is created and the value is retained from page to page.

param: $color (array) Array of colors (1, 3 or 4 values).
param: $ret (boolean) If true do not send the PDF command.

setColor($type, $col1=0, $col2=-1, $col3=-1, $col4=-1, $ret=false, $name='')   X-Ref
Defines the color used by the specified type ('draw', 'fill', 'text').

param: $type (string) Type of object affected by this color: ('draw', 'fill', 'text').
param: $col1 (float) GRAY level for single color, or Red color for RGB (0-255), or CYAN color for CMYK (0-100).
param: $col2 (float) GREEN color for RGB (0-255), or MAGENTA color for CMYK (0-100).
param: $col3 (float) BLUE color for RGB (0-255), or YELLOW color for CMYK (0-100).
param: $col4 (float) KEY (BLACK) color for CMYK (0-100).
param: $ret (boolean) If true do not send the command.
param: $name (string) spot color name (if any)
return: (string) The PDF command or empty string.

SetDrawColor($col1=0, $col2=-1, $col3=-1, $col4=-1, $ret=false, $name='')   X-Ref
Defines the color used for all drawing operations (lines, rectangles and cell borders). It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.

param: $col1 (float) GRAY level for single color, or Red color for RGB (0-255), or CYAN color for CMYK (0-100).
param: $col2 (float) GREEN color for RGB (0-255), or MAGENTA color for CMYK (0-100).
param: $col3 (float) BLUE color for RGB (0-255), or YELLOW color for CMYK (0-100).
param: $col4 (float) KEY (BLACK) color for CMYK (0-100).
param: $ret (boolean) If true do not send the command.
param: $name (string) spot color name (if any)
return: string the PDF command

SetFillColor($col1=0, $col2=-1, $col3=-1, $col4=-1, $ret=false, $name='')   X-Ref
Defines the color used for all filling operations (filled rectangles and cell backgrounds). It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.

param: $col1 (float) GRAY level for single color, or Red color for RGB (0-255), or CYAN color for CMYK (0-100).
param: $col2 (float) GREEN color for RGB (0-255), or MAGENTA color for CMYK (0-100).
param: $col3 (float) BLUE color for RGB (0-255), or YELLOW color for CMYK (0-100).
param: $col4 (float) KEY (BLACK) color for CMYK (0-100).
param: $ret (boolean) If true do not send the command.
param: $name (string) Spot color name (if any).
return: (string) The PDF command.

SetTextColor($col1=0, $col2=-1, $col3=-1, $col4=-1, $ret=false, $name='')   X-Ref
Defines the color used for text. It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.

param: $col1 (float) GRAY level for single color, or Red color for RGB (0-255), or CYAN color for CMYK (0-100).
param: $col2 (float) GREEN color for RGB (0-255), or MAGENTA color for CMYK (0-100).
param: $col3 (float) BLUE color for RGB (0-255), or YELLOW color for CMYK (0-100).
param: $col4 (float) KEY (BLACK) color for CMYK (0-100).
param: $ret (boolean) If true do not send the command.
param: $name (string) Spot color name (if any).
return: (string) Empty string.

GetStringWidth($s, $fontname='', $fontstyle='', $fontsize=0, $getarray=false)   X-Ref
Returns the length of a string in user unit. A font must be selected.<br>

param: $s (string) The string whose length is to be computed
param: $fontname (string) Family font. It can be either a name defined by AddFont() or one of the standard families. It is also possible to pass an empty string, in that case, the current family is retained.
param: $fontstyle (string) Font style. Possible values are (case insensitive):<ul><li>empty string: regular</li><li>B: bold</li><li>I: italic</li><li>U: underline</li><li>D: line-through</li><li>O: overline</li></ul> or any combination. The default value is regular.
param: $fontsize (float) Font size in points. The default value is the current size.
param: $getarray (boolean) if true returns an array of characters widths, if false returns the total length.
author: Nicola Asuni
return: mixed int total string length or array of characted widths

GetArrStringWidth($sa, $fontname='', $fontstyle='', $fontsize=0, $getarray=false)   X-Ref
Returns the string length of an array of chars in user unit or an array of characters widths. A font must be selected.<br>

param: $sa (string) The array of chars whose total length is to be computed
param: $fontname (string) Family font. It can be either a name defined by AddFont() or one of the standard families. It is also possible to pass an empty string, in that case, the current family is retained.
param: $fontstyle (string) Font style. Possible values are (case insensitive):<ul><li>empty string: regular</li><li>B: bold</li><li>I: italic</li><li>U: underline</li><li>D: line through</li><li>O: overline</li></ul> or any combination. The default value is regular.
param: $fontsize (float) Font size in points. The default value is the current size.
param: $getarray (boolean) if true returns an array of characters widths, if false returns the total length.
author: Nicola Asuni
return: mixed int total string length or array of characted widths

GetCharWidth($char, $notlast=true)   X-Ref
Returns the length of the char in user unit for the current font considering current stretching and spacing (tracking).

param: $char (int) The char code whose length is to be returned
param: $notlast (boolean) If false ignore the font-spacing.
author: Nicola Asuni
return: float char width

getRawCharWidth($char)   X-Ref
Returns the length of the char in user unit for the current font.

param: $char (int) The char code whose length is to be returned
author: Nicola Asuni
return: float char width

GetNumChars($s)   X-Ref
Returns the numbero of characters in a string.

param: $s (string) The input string.
return: int number of characters

getFontsList()   X-Ref
Fill the list of available fonts ($this->fontlist).


AddFont($family, $style='', $fontfile='', $subset='default')   X-Ref
Imports a TrueType, Type1, core, or CID0 font and makes it available.
It is necessary to generate a font definition file first (read /fonts/utils/README.TXT).
The definition file (and the font file itself when embedding) must be present either in the current directory or in the one indicated by K_PATH_FONTS if the constant is defined. If it could not be found, the error "Could not include font definition file" is generated.

param: $family (string) Font family. The name can be chosen arbitrarily. If it is a standard family name, it will override the corresponding font.
param: $style (string) Font style. Possible values are (case insensitive):<ul><li>empty string: regular (default)</li><li>B: bold</li><li>I: italic</li><li>BI or IB: bold italic</li></ul>
param: $fontfile (string) The font definition file. By default, the name is built from the family and style, in lower case with no spaces.
param: $subset (mixed) if true embedd only a subset of the font (stores only the information related to the used characters); if false embedd full font; if 'default' uses the default value set using setFontSubsetting(). This option is valid only for TrueTypeUnicode fonts. If you want to enable users to change the document, set this parameter to false. If you subset the font, the person who receives your PDF would need to have your same font in order to make changes to your PDF. The file size of the PDF would also be smaller because you are embedding only part of a font.
return: array containing the font data, or false in case of error.

SetFont($family, $style='', $size=null, $fontfile='', $subset='default', $out=true)   X-Ref
Sets the font used to print character strings.
The font can be either a standard one or a font added via the AddFont() method. Standard fonts use Windows encoding cp1252 (Western Europe).
The method can be called before the first page is created and the font is retained from page to page.
If you just wish to change the current font size, it is simpler to call SetFontSize().
Note: for the standard fonts, the font metric files must be accessible. There are three possibilities for this:<ul><li>They are in the current directory (the one where the running script lies)</li><li>They are in one of the directories defined by the include_path parameter</li><li>They are in the directory defined by the K_PATH_FONTS constant</li></ul><br />

param: $family (string) Family font. It can be either a name defined by AddFont() or one of the standard Type1 families (case insensitive):<ul><li>times (Times-Roman)</li><li>timesb (Times-Bold)</li><li>timesi (Times-Italic)</li><li>timesbi (Times-BoldItalic)</li><li>helvetica (Helvetica)</li><li>helveticab (Helvetica-Bold)</li><li>helveticai (Helvetica-Oblique)</li><li>helveticabi (Helvetica-BoldOblique)</li><li>courier (Courier)</li><li>courierb (Courier-Bold)</li><li>courieri (Courier-Oblique)</li><li>courierbi (Courier-BoldOblique)</li><li>symbol (Symbol)</li><li>zapfdingbats (ZapfDingbats)</li></ul> It is also possible to pass an empty string. In that case, the current family is retained.
param: $style (string) Font style. Possible values are (case insensitive):<ul><li>empty string: regular</li><li>B: bold</li><li>I: italic</li><li>U: underline</li><li>D: line through</li><li>O: overline</li></ul> or any combination. The default value is regular. Bold and italic styles do not apply to Symbol and ZapfDingbats basic fonts or other fonts when not defined.
param: $size (float) Font size in points. The default value is the current size. If no size has been specified since the beginning of the document, the value taken is 12
param: $fontfile (string) The font definition file. By default, the name is built from the family and style, in lower case with no spaces.
param: $subset (mixed) if true embedd only a subset of the font (stores only the information related to the used characters); if false embedd full font; if 'default' uses the default value set using setFontSubsetting(). This option is valid only for TrueTypeUnicode fonts. If you want to enable users to change the document, set this parameter to false. If you subset the font, the person who receives your PDF would need to have your same font in order to make changes to your PDF. The file size of the PDF would also be smaller because you are embedding only part of a font.
param: $out (boolean) if true output the font size command, otherwise only set the font properties.
author: Nicola Asuni

SetFontSize($size, $out=true)   X-Ref
Defines the size of the current font.

param: $size (float) The font size in points.
param: $out (boolean) if true output the font size command, otherwise only set the font properties.

getFontBBox()   X-Ref
Returns the bounding box of the current font in user units.

return: array

getAbsFontMeasure($s)   X-Ref
Convert a relative font measure into absolute value.

param: $s (int) Font measure.
return: float Absolute measure.

getCharBBox($char)   X-Ref
Returns the glyph bounding box of the specified character in the current font in user units.

param: $char (int) Input character code.
return: mixed array(xMin, yMin, xMax, yMax) or FALSE if not defined.

getFontDescent($font, $style='', $size=0)   X-Ref
Return the font descent value

param: $font (string) font name
param: $style (string) font style
param: $size (float) The size (in points)
author: Nicola Asuni
return: int font descent

getFontAscent($font, $style='', $size=0)   X-Ref
Return the font ascent value.

param: $font (string) font name
param: $style (string) font style
param: $size (float) The size (in points)
author: Nicola Asuni
return: int font ascent

isCharDefined($char, $font='', $style='')   X-Ref
Return true in the character is present in the specified font.

param: $char (mixed) Character to check (integer value or string)
param: $font (string) Font name (family name).
param: $style (string) Font style.
return: (boolean) true if the char is defined, false otherwise.

replaceMissingChars($text, $font='', $style='', $subs=array()   X-Ref
Replace missing font characters on selected font with specified substitutions.

param: $text (string) Text to process.
param: $font (string) Font name (family name).
param: $style (string) Font style.
param: $subs (array) Array of possible character substitutions. The key is the character to check (integer value) and the value is a single intege value or an array of possible substitutes.
return: (string) Processed text.

SetDefaultMonospacedFont($font)   X-Ref
Defines the default monospaced font.

param: $font (string) Font name.

AddLink()   X-Ref
Creates a new internal link and returns its identifier. An internal link is a clickable area which directs to another place within the document.<br />
The identifier can then be passed to Cell(), Write(), Image() or Link(). The destination is defined with SetLink().


SetLink($link, $y=0, $page=-1)   X-Ref
Defines the page and position a link points to.

param: $link (int) The link identifier returned by AddLink()
param: $y (float) Ordinate of target position; -1 indicates the current position. The default value is 0 (top of page)
param: $page (int|string) Number of target page; -1 indicates the current page (default value). If you prefix a page number with the * character, then this page will not be changed when adding/deleting/moving pages.

Link($x, $y, $w, $h, $link, $spaces=0)   X-Ref
Puts a link on a rectangular area of the page.
Text or image links are generally put via Cell(), Write() or Image(), but this method can be useful for instance to define a clickable area inside an image.

param: $x (float) Abscissa of the upper-left corner of the rectangle
param: $y (float) Ordinate of the upper-left corner of the rectangle
param: $w (float) Width of the rectangle
param: $h (float) Height of the rectangle
param: $link (mixed) URL or identifier returned by AddLink()
param: $spaces (int) number of spaces on the text to link

Annotation($x, $y, $w, $h, $text, $opt=array('Subtype'=>'Text')   X-Ref
Puts a markup annotation on a rectangular area of the page.
!!!!THE ANNOTATION SUPPORT IS NOT YET FULLY IMPLEMENTED !!!!

param: $x (float) Abscissa of the upper-left corner of the rectangle
param: $y (float) Ordinate of the upper-left corner of the rectangle
param: $w (float) Width of the rectangle
param: $h (float) Height of the rectangle
param: $text (string) annotation text or alternate content
param: $opt (array) array of options (see section 8.4 of PDF reference 1.7).
param: $spaces (int) number of spaces on the text to link

_putEmbeddedFiles()   X-Ref
Embedd the attached files.


Text($x, $y, $txt, $fstroke=false, $fclip=false, $ffill=true, $border=0, $ln=0, $align='', $fill=false, $link='', $stretch=0, $ignore_min_height=false, $calign='T', $valign='M', $rtloff=false)   X-Ref
Prints a text cell at the specified position.
This method allows to place a string precisely on the page.

param: $x (float) Abscissa of the cell origin
param: $y (float) Ordinate of the cell origin
param: $txt (string) String to print
param: $fstroke (int) outline size in user units (false = disable)
param: $fclip (boolean) if true activate clipping mode (you must call StartTransform() before this function and StopTransform() to stop the clipping tranformation).
param: $ffill (boolean) if true fills the text
param: $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
param: $ln (int) Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right (or left for RTL languages)</li><li>1: to the beginning of the next line</li><li>2: below</li></ul>Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.
param: $align (string) Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align (default value)</li><li>C: center</li><li>R: right align</li><li>J: justify</li></ul>
param: $fill (boolean) Indicates if the cell background must be painted (true) or transparent (false).
param: $link (mixed) URL or identifier returned by AddLink().
param: $stretch (int) font stretch mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if text is larger than cell width</li><li>2 = forced horizontal scaling to fit cell width</li><li>3 = character spacing only if text is larger than cell width</li><li>4 = forced character spacing to fit cell width</li></ul> General font stretching and scaling values will be preserved when possible.
param: $ignore_min_height (boolean) if true ignore automatic minimum height value.
param: $calign (string) cell vertical alignment relative to the specified Y value. Possible values are:<ul><li>T : cell top</li><li>A : font top</li><li>L : font baseline</li><li>D : font bottom</li><li>B : cell bottom</li></ul>
param: $valign (string) text vertical alignment inside the cell. Possible values are:<ul><li>T : top</li><li>C : center</li><li>B : bottom</li></ul>
param: $rtloff (boolean) if true uses the page top-left corner as origin of axis for $x and $y initial position.

AcceptPageBreak()   X-Ref
Whenever a page break condition is met, the method is called, and the break is issued or not depending on the returned value.
The default implementation returns a value according to the mode selected by SetAutoPageBreak().<br />
This method is called automatically and should not be called directly by the application.

return: boolean

checkPageBreak($h=0, $y='', $addpage=true)   X-Ref
Add page if needed.

param: $h (float) Cell height. Default value: 0.
param: $y (mixed) starting y position, leave empty for current position.
param: $addpage (boolean) if true add a page, otherwise only return the true/false state
return: boolean true in case of page break, false otherwise.

Cell($w, $h=0, $txt='', $border=0, $ln=0, $align='', $fill=false, $link='', $stretch=0, $ignore_min_height=false, $calign='T', $valign='M')   X-Ref
Prints a cell (rectangular area) with optional borders, background color and character string. The upper-left corner of the cell corresponds to the current position. The text can be aligned or centered. After the call, the current position moves to the right or to the next line. It is possible to put a link on the text.<br />
If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.

param: $w (float) Cell width. If 0, the cell extends up to the right margin.
param: $h (float) Cell height. Default value: 0.
param: $txt (string) String to print. Default value: empty string.
param: $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
param: $ln (int) Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right (or left for RTL languages)</li><li>1: to the beginning of the next line</li><li>2: below</li></ul> Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.
param: $align (string) Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align (default value)</li><li>C: center</li><li>R: right align</li><li>J: justify</li></ul>
param: $fill (boolean) Indicates if the cell background must be painted (true) or transparent (false).
param: $link (mixed) URL or identifier returned by AddLink().
param: $stretch (int) font stretch mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if text is larger than cell width</li><li>2 = forced horizontal scaling to fit cell width</li><li>3 = character spacing only if text is larger than cell width</li><li>4 = forced character spacing to fit cell width</li></ul> General font stretching and scaling values will be preserved when possible.
param: $ignore_min_height (boolean) if true ignore automatic minimum height value.
param: $calign (string) cell vertical alignment relative to the specified Y value. Possible values are:<ul><li>T : cell top</li><li>C : center</li><li>B : cell bottom</li><li>A : font top</li><li>L : font baseline</li><li>D : font bottom</li></ul>
param: $valign (string) text vertical alignment inside the cell. Possible values are:<ul><li>T : top</li><li>C : center</li><li>B : bottom</li></ul>

getCellCode($w, $h=0, $txt='', $border=0, $ln=0, $align='', $fill=false, $link='', $stretch=0, $ignore_min_height=false, $calign='T', $valign='M')   X-Ref
Returns the PDF string code to print a cell (rectangular area) with optional borders, background color and character string. The upper-left corner of the cell corresponds to the current position. The text can be aligned or centered. After the call, the current position moves to the right or to the next line. It is possible to put a link on the text.<br />
If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.

param: $w (float) Cell width. If 0, the cell extends up to the right margin.
param: $h (float) Cell height. Default value: 0.
param: $txt (string) String to print. Default value: empty string.
param: $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
param: $ln (int) Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right (or left for RTL languages)</li><li>1: to the beginning of the next line</li><li>2: below</li></ul>Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.
param: $align (string) Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align (default value)</li><li>C: center</li><li>R: right align</li><li>J: justify</li></ul>
param: $fill (boolean) Indicates if the cell background must be painted (true) or transparent (false).
param: $link (mixed) URL or identifier returned by AddLink().
param: $stretch (int) font stretch mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if text is larger than cell width</li><li>2 = forced horizontal scaling to fit cell width</li><li>3 = character spacing only if text is larger than cell width</li><li>4 = forced character spacing to fit cell width</li></ul> General font stretching and scaling values will be preserved when possible.
param: $ignore_min_height (boolean) if true ignore automatic minimum height value.
param: $calign (string) cell vertical alignment relative to the specified Y value. Possible values are:<ul><li>T : cell top</li><li>C : center</li><li>B : cell bottom</li><li>A : font top</li><li>L : font baseline</li><li>D : font bottom</li></ul>
param: $valign (string) text vertical alignment inside the cell. Possible values are:<ul><li>T : top</li><li>M : middle</li><li>B : bottom</li></ul>
return: string containing cell code

replaceChar($oldchar, $newchar)   X-Ref
Replace a char if is defined on the current font.

param: $oldchar (int) Integer code (unicode) of the character to replace.
param: $newchar (int) Integer code (unicode) of the new character.
return: int the replaced char or the old char in case the new char i not defined

getCellBorder($x, $y, $w, $h, $brd)   X-Ref
Returns the code to draw the cell border

param: $x (float) X coordinate.
param: $y (float) Y coordinate.
param: $w (float) Cell width.
param: $h (float) Cell height.
param: $brd (mixed) Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
return: string containing cell border code

MultiCell($w, $h, $txt, $border=0, $align='J', $fill=false, $ln=1, $x='', $y='', $reseth=true, $stretch=0, $ishtml=false, $autopadding=true, $maxh=0, $valign='T', $fitcell=false)   X-Ref
This method allows printing text with line breaks.
They can be automatic (as soon as the text reaches the right border of the cell) or explicit (via the \n character). As many cells as necessary are output, one below the other.<br />
Text can be aligned, centered or justified. The cell block can be framed and the background painted.

param: $w (float) Width of cells. If 0, they extend up to the right margin of the page.
param: $h (float) Cell minimum height. The cell extends automatically if needed.
param: $txt (string) String to print
param: $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
param: $align (string) Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align</li><li>C: center</li><li>R: right align</li><li>J: justification (default value when $ishtml=false)</li></ul>
param: $fill (boolean) Indicates if the cell background must be painted (true) or transparent (false).
param: $ln (int) Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right</li><li>1: to the beginning of the next line [DEFAULT]</li><li>2: below</li></ul>
param: $x (float) x position in user units
param: $y (float) y position in user units
param: $reseth (boolean) if true reset the last cell height (default true).
param: $stretch (int) font stretch mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if text is larger than cell width</li><li>2 = forced horizontal scaling to fit cell width</li><li>3 = character spacing only if text is larger than cell width</li><li>4 = forced character spacing to fit cell width</li></ul> General font stretching and scaling values will be preserved when possible.
param: $ishtml (boolean) INTERNAL USE ONLY -- set to true if $txt is HTML content (default = false). Never set this parameter to true, use instead writeHTMLCell() or writeHTML() methods.
param: $autopadding (boolean) if true, uses internal padding and automatically adjust it to account for line width.
param: $maxh (float) maximum height. It should be >= $h and less then remaining space to the bottom of the page, or 0 for disable this feature. This feature works only when $ishtml=false.
param: $valign (string) Vertical alignment of text (requires $maxh = $h > 0). Possible values are:<ul><li>T: TOP</li><li>M: middle</li><li>B: bottom</li></ul>. This feature works only when $ishtml=false and the cell must fit in a single page.
param: $fitcell (boolean) if true attempt to fit all the text within the cell by reducing the font size (do not work in HTML mode). $maxh must be greater than 0 and equal to $h.
return: int Return the number of cells or 1 for html mode.

getNumLines($txt, $w=0, $reseth=false, $autopadding=true, $cellpadding='', $border=0)   X-Ref
This method return the estimated number of lines for print a simple text string using Multicell() method.

param: $txt (string) String for calculating his height
param: $w (float) Width of cells. If 0, they extend up to the right margin of the page.
param: $reseth (boolean) if true reset the last cell height (default false).
param: $autopadding (boolean) if true, uses internal padding and automatically adjust it to account for line width (default true).
param: $cellpadding (float) Internal cell padding, if empty uses default cell padding.
param: $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
author: Alexander Escalona Fern\E1ndez, Nicola Asuni
return: float Return the minimal height needed for multicell method for printing the $txt param.

getStringHeight($w, $txt, $reseth=false, $autopadding=true, $cellpadding='', $border=0)   X-Ref
This method return the estimated height needed for printing a simple text string using the Multicell() method.
Generally, if you want to know the exact height for a block of content you can use the following alternative technique:

param: $w (float) Width of cells. If 0, they extend up to the right margin of the page.
param: $txt (string) String for calculating his height
param: $reseth (boolean) if true reset the last cell height (default false).
param: $autopadding (boolean) if true, uses internal padding and automatically adjust it to account for line width (default true).
param: $cellpadding (float) Internal cell padding, if empty uses default cell padding.
param: $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
author: Nicola Asuni, Alexander Escalona Fern\E1ndez
return: float Return the minimal height needed for multicell method for printing the $txt param.

Write($h, $txt, $link='', $fill=false, $align='', $ln=false, $stretch=0, $firstline=false, $firstblock=false, $maxh=0, $wadj=0, $margin='')   X-Ref
This method prints text from the current position.<br />

param: $h (float) Line height
param: $txt (string) String to print
param: $link (mixed) URL or identifier returned by AddLink()
param: $fill (boolean) Indicates if the cell background must be painted (true) or transparent (false).
param: $align (string) Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align (default value)</li><li>C: center</li><li>R: right align</li><li>J: justify</li></ul>
param: $ln (boolean) if true set cursor at the bottom of the line, otherwise set cursor at the top of the line.
param: $stretch (int) font stretch mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if text is larger than cell width</li><li>2 = forced horizontal scaling to fit cell width</li><li>3 = character spacing only if text is larger than cell width</li><li>4 = forced character spacing to fit cell width</li></ul> General font stretching and scaling values will be preserved when possible.
param: $firstline (boolean) if true prints only the first line and return the remaining string.
param: $firstblock (boolean) if true the string is the starting of a line.
param: $maxh (float) maximum height. It should be >= $h and less then remaining space to the bottom of the page, or 0 for disable this feature.
param: $wadj (float) first line width will be reduced by this amount (used in HTML mode).
param: $margin (array) margin array of the parent container
return: mixed Return the number of cells or the remaining string if $firstline = true.

getRemainingWidth()   X-Ref
Returns the remaining width between the current position and margins.

return: int Return the remaining width

fitBlock($w, $h, $x, $y, $fitonpage=false)   X-Ref
Set the block dimensions accounting for page breaks and page/column fitting

param: $w (float) width
param: $h (float) height
param: $x (float) X coordinate
param: $y (float) Y coodiante
param: $fitonpage (boolean) if true the block is resized to not exceed page dimensions.
return: array($w, $h, $x, $y)

Image($file, $x='', $y='', $w=0, $h=0, $type='', $link='', $align='', $resize=false, $dpi=300, $palign='', $ismask=false, $imgmask=false, $border=0, $fitbox=false, $hidden=false, $fitonpage=false, $alt=false, $altimgs=array()   X-Ref
Puts an image in the page.
The upper-left corner must be given.
The dimensions can be specified in different ways:<ul>
<li>explicit width and height (expressed in user unit)</li>
<li>one explicit dimension, the other being calculated automatically in order to keep the original proportions</li>
<li>no explicit dimension, in which case the image is put at 72 dpi</li></ul>
Supported formats are JPEG and PNG images whitout GD library and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM;
The format can be specified explicitly or inferred from the file extension.<br />
It is possible to put a link on the image.<br />
Remark: if an image is used several times, only one copy will be embedded in the file.<br />

param: $file (string) Name of the file containing the image or a '@' character followed by the image data string. To link an image without embedding it on the document, set an asterisk character before the URL (i.e.: '*http://www.example.com/image.jpg').
param: $x (float) Abscissa of the upper-left corner (LTR) or upper-right corner (RTL).
param: $y (float) Ordinate of the upper-left corner (LTR) or upper-right corner (RTL).
param: $w (float) Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
param: $h (float) Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
param: $type (string) Image format. Possible values are (case insensitive): JPEG and PNG (whitout GD library) and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM;. If not specified, the type is inferred from the file extension.
param: $link (mixed) URL or identifier returned by AddLink().
param: $align (string) Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul>
param: $resize (mixed) If true resize (reduce) the image to fit $w and $h (requires GD or ImageMagick library); if false do not resize; if 2 force resize in all cases (upscaling and downscaling).
param: $dpi (int) dot-per-inch resolution used on resize
param: $palign (string) Allows to center or align the image on the current line. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul>
param: $ismask (boolean) true if this image is a mask, false otherwise
param: $imgmask (mixed) image object returned by this function or false
param: $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
param: $fitbox (mixed) If not false scale image dimensions proportionally to fit within the ($w, $h) box. $fitbox can be true or a 2 characters string indicating the image alignment inside the box. The first character indicate the horizontal alignment (L = left, C = center, R = right) the second character indicate the vertical algnment (T = top, M = middle, B = bottom).
param: $hidden (boolean) If true do not display the image.
param: $fitonpage (boolean) If true the image is resized to not exceed page dimensions.
param: $alt (boolean) If true the image will be added as alternative and not directly printed (the ID of the image will be returned).
param: $altimgs (array) Array of alternate images IDs. Each alternative image must be an array with two values: an integer representing the image ID (the value returned by the Image method) and a boolean value to indicate if the image is the default for printing.
return: image information

ImagePngAlpha($file, $x, $y, $wpx, $hpx, $w, $h, $type, $link, $align, $resize, $dpi, $palign, $filehash='')   X-Ref
Extract info from a PNG image with alpha channel using the Imagick or GD library.

param: $file (string) Name of the file containing the image.
param: $x (float) Abscissa of the upper-left corner.
param: $y (float) Ordinate of the upper-left corner.
param: $wpx (float) Original width of the image in pixels.
param: $hpx (float) original height of the image in pixels.
param: $w (float) Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
param: $h (float) Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
param: $type (string) Image format. Possible values are (case insensitive): JPEG and PNG (whitout GD library) and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM;. If not specified, the type is inferred from the file extension.
param: $link (mixed) URL or identifier returned by AddLink().
param: $align (string) Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul>
param: $resize (boolean) If true resize (reduce) the image to fit $w and $h (requires GD library).
param: $dpi (int) dot-per-inch resolution used on resize
param: $palign (string) Allows to center or align the image on the current line. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul>
param: $filehash (string) File hash used to build unique file names.
author: Nicola Asuni

getGDgamma($img, $c)   X-Ref
Get the GD-corrected PNG gamma value from alpha color

param: $img (int) GD image Resource ID.
param: $c (int) alpha color

Ln($h='', $cell=false)   X-Ref
Performs a line break.
The current abscissa goes back to the left margin and the ordinate increases by the amount passed in parameter.

param: $h (float) The height of the break. By default, the value equals the height of the last printed cell.
param: $cell (boolean) if true add the current left (or right o for RTL) padding to the X coordinate

GetX()   X-Ref
Returns the relative X value of current position.
The value is relative to the left border for LTR languages and to the right border for RTL languages.

return: float

GetAbsX()   X-Ref
Returns the absolute X value of current position.

return: float

GetY()   X-Ref
Returns the ordinate of the current position.

return: float

SetX($x, $rtloff=false)   X-Ref
Defines the abscissa of the current position.
If the passed value is negative, it is relative to the right of the page (or left if language is RTL).

param: $x (float) The value of the abscissa in user units.
param: $rtloff (boolean) if true always uses the page top-left corner as origin of axis.

SetY($y, $resetx=true, $rtloff=false)   X-Ref
Moves the current abscissa back to the left margin and sets the ordinate.
If the passed value is negative, it is relative to the bottom of the page.

param: $y (float) The value of the ordinate in user units.
param: $resetx (bool) if true (default) reset the X position.
param: $rtloff (boolean) if true always uses the page top-left corner as origin of axis.

SetXY($x, $y, $rtloff=false)   X-Ref
Defines the abscissa and ordinate of the current position.
If the passed values are negative, they are relative respectively to the right and bottom of the page.

param: $x (float) The value of the abscissa.
param: $y (float) The value of the ordinate.
param: $rtloff (boolean) if true always uses the page top-left corner as origin of axis.

SetAbsX($x)   X-Ref
Set the absolute X coordinate of the current pointer.

param: $x (float) The value of the abscissa in user units.

SetAbsY($y)   X-Ref
Set the absolute Y coordinate of the current pointer.

param: $y (float) (float) The value of the ordinate in user units.

SetAbsXY($x, $y)   X-Ref
Set the absolute X and Y coordinates of the current pointer.

param: $x (float) The value of the abscissa in user units.
param: $y (float) (float) The value of the ordinate in user units.

Output($name='doc.pdf', $dest='I')   X-Ref
Send the document to a given destination: string, local file or browser.
In the last case, the plug-in may be used (if present) or a download ("Save as" dialog box) may be forced.<br />
The method first calls Close() if necessary to terminate the document.

param: $name (string) The name of the file when saved. Note that special characters are removed and blanks characters are replaced with the underscore character.
param: $dest (string) Destination where to send the document. It can take one of the following values:<ul><li>I: send the file inline to the browser (default). The plug-in is used if available. The name given by name is used when one selects the "Save as" option on the link generating the PDF.</li><li>D: send to the browser and force a file download with the name given by name.</li><li>F: save to a local server file with the name given by name.</li><li>S: return the document as a string (name is ignored).</li><li>FI: equivalent to F + I option</li><li>FD: equivalent to F + D option</li><li>E: return the document as base64 mime multi-part email attachment (RFC 2045)</li></ul>
return: string

_destroy($destroyall=false, $preserve_objcopy=false)   X-Ref
Unset all class variables except the following critical variables.

param: $destroyall (boolean) if true destroys all class variables, otherwise preserves critical variables.
param: $preserve_objcopy (boolean) if true preserves the objcopy variable

_dochecks()   X-Ref
Check for locale-related bug


Class: file  - X-Ref

getInternalPageNumberAliases($a= '')   X-Ref
Return an array containing variations for the basic page number alias.

param: $a (string) Base alias.
return: array of page number aliases

getAllInternalPageNumberAliases()   X-Ref
Return an array containing all internal page aliases.

return: array of page number aliases

replaceRightShiftPageNumAliases($page, $aliases, $diff)   X-Ref
Replace right shift page number aliases with spaces to correct right alignment.
This works perfectly only when using monospaced fonts.

param: $page (string) Page content.
param: $aliases (array) Array of page aliases.
param: $diff (int) initial difference to add.
return: replaced page content.

setPageBoxTypes($boxes)   X-Ref
Set page boxes to be included on page descriptions.

param: $boxes (array) Array of page boxes to set on document: ('MediaBox', 'CropBox', 'BleedBox', 'TrimBox', 'ArtBox').

_putpages()   X-Ref
Output pages (and replace page number aliases).


_getannotsrefs($n)   X-Ref
Get references to page annotations.

param: $n (int) page number
author: Nicola Asuni
return: string

_putannotsobjs()   X-Ref
Output annotations objects for all pages.
!!! THIS METHOD IS NOT YET COMPLETED !!!
See section 12.5 of PDF 32000_2008 reference.

author: Nicola Asuni

_putAPXObject($w=0, $h=0, $stream='')   X-Ref
Put appearance streams XObject used to define annotation's appearance states.

param: $w (int) annotation width
param: $h (int) annotation height
param: $stream (string) appearance stream
return: int object ID

_putfonts()   X-Ref
Output fonts.

author: Nicola Asuni

_puttruetypeunicode($font)   X-Ref
Adds unicode fonts.<br>
Based on PDF Reference 1.3 (section 5)

param: $font (array) font data
author: Nicola Asuni

_putcidfont0($font)   X-Ref
Output CID-0 fonts.
A Type 0 CIDFont contains glyph descriptions based on the Adobe Type 1 font format

param: $font (array) font data
author: Andrew Whitehead, Nicola Asuni, Yukihiro Nakadaira

_putimages()   X-Ref
Output images.


_putxobjects()   X-Ref
Output Form XObjects Templates.

author: Nicola Asuni

_putspotcolors()   X-Ref
Output Spot Colors Resources.


_getxobjectdict()   X-Ref
Return XObjects Dictionary.

return: string XObjects dictionary

_putresourcedict()   X-Ref
Output Resources Dictionary.


_putresources()   X-Ref
Output Resources.


_putinfo()   X-Ref
Adds some Metadata information (Document Information Dictionary)
(see Chapter 14.3.3 Document Information Dictionary of PDF32000_2008.pdf Reference)

return: int object id

setExtraXMP($xmp)   X-Ref
Set additional XMP data to be added on the default XMP data just before the end of "x:xmpmeta" tag.
IMPORTANT: This data is added as-is without controls, so you have to validate your data before using this method!

param: $xmp (string) Custom XMP data.

setExtraXMPRDF($xmp)   X-Ref
Set additional XMP data to be added on the default XMP data just before the end of "rdf:RDF" tag.
IMPORTANT: This data is added as-is without controls, so you have to validate your data before using this method!

param: $xmp (string) Custom XMP RDF data.

_putXMP()   X-Ref
Put XMP data object and return ID.

return: (int) The object ID.

_putcatalog()   X-Ref
Output Catalog.

return: int object id

_putviewerpreferences()   X-Ref
Output viewer preferences.

author: Nicola asuni
return: string for viewer preferences

_putheader()   X-Ref
Output PDF File Header (7.5.2).


_enddoc()   X-Ref
Output end of document (EOF).


_beginpage($orientation='', $format='')   X-Ref
Initialize a new page.

param: $orientation (string) page orientation. Possible values are (case insensitive):<ul><li>P or PORTRAIT (default)</li><li>L or LANDSCAPE</li></ul>
param: $format (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().

_endpage()   X-Ref
Mark end of page.


_newobj()   X-Ref
Begin a new object and return the object number.

return: int object number

_getobj($objid='')   X-Ref
Return the starting object string for the selected object ID.

param: $objid (int) Object ID (leave empty to get a new ID).
return: string the starting object string

_dounderline($x, $y, $txt)   X-Ref
Underline text.

param: $x (int) X coordinate
param: $y (int) Y coordinate
param: $txt (string) text to underline

_dounderlinew($x, $y, $w)   X-Ref
Underline for rectangular text area.

param: $x (int) X coordinate
param: $y (int) Y coordinate
param: $w (int) width to underline

_dolinethrough($x, $y, $txt)   X-Ref
Line through text.

param: $x (int) X coordinate
param: $y (int) Y coordinate
param: $txt (string) text to linethrough

_dolinethroughw($x, $y, $w)   X-Ref
Line through for rectangular text area.

param: $x (int) X coordinate
param: $y (int) Y coordinate
param: $w (int) line length (width)

_dooverline($x, $y, $txt)   X-Ref
Overline text.

param: $x (int) X coordinate
param: $y (int) Y coordinate
param: $txt (string) text to overline

_dooverlinew($x, $y, $w)   X-Ref
Overline for rectangular text area.

param: $x (int) X coordinate
param: $y (int) Y coordinate
param: $w (int) width to overline

_datastring($s, $n=0)   X-Ref
Format a data string for meta information

param: $s (string) data string to escape.
param: $n (int) object ID
return: string escaped string.

setDocCreationTimestamp($time)   X-Ref
Set the document creation timestamp

param: $time (mixed) Document creation timestamp in seconds or date-time string.

setDocModificationTimestamp($time)   X-Ref
Set the document modification timestamp

param: $time (mixed) Document modification timestamp in seconds or date-time string.

getDocCreationTimestamp()   X-Ref
Returns document creation timestamp in seconds.

return: (int) Creation timestamp in seconds.

getDocModificationTimestamp()   X-Ref
Returns document modification timestamp in seconds.

return: (int) Modfication timestamp in seconds.

_datestring($n=0, $timestamp=0)   X-Ref
Returns a formatted date for meta information

param: $n (int) Object ID.
param: $timestamp (int) Timestamp to convert.
return: string escaped date string.

_textstring($s, $n=0)   X-Ref
Format a text string for meta information

param: $s (string) string to escape.
param: $n (int) object ID
return: string escaped string.

_getrawstream($s, $n=0)   X-Ref
get raw output stream.

param: $s (string) string to output.
param: $n (int) object reference for encryption mode
author: Nicola Asuni

_out($s)   X-Ref
Output a string to the document.

param: $s (string) string to output.

setHeaderFont($font)   X-Ref
Set header font.

param: $font (array) Array describing the basic font parameters: (family, style, size).

getHeaderFont()   X-Ref
Get header font.

return: array() Array describing the basic font parameters: (family, style, size).

setFooterFont($font)   X-Ref
Set footer font.

param: $font (array) Array describing the basic font parameters: (family, style, size).

getFooterFont()   X-Ref
Get Footer font.

return: array() Array describing the basic font parameters: (family, style, size).

setLanguageArray($language)   X-Ref
Set language array.

param: $language (array)

getPDFData()   X-Ref
Returns the PDF data.


addHtmlLink($url, $name, $fill=false, $firstline=false, $color='', $style=-1, $firstblock=false)   X-Ref
Output anchor link.

param: $url (string) link URL or internal link (i.e.: &lt;a href="#23,4.5"&gt;link to page 23 at 4.5 Y position&lt;/a&gt;)
param: $name (string) link name
param: $fill (boolean) Indicates if the cell background must be painted (true) or transparent (false).
param: $firstline (boolean) if true prints only the first line and return the remaining string.
param: $color (array) array of RGB text color
param: $style (string) font style (U, D, B, I)
param: $firstblock (boolean) if true the string is the starting of a line.
return: the number of cells used or the remaining text if $firstline = true;

pixelsToUnits($px)   X-Ref
Converts pixels to User's Units.

param: $px (int) pixels
return: float value in user's unit

unhtmlentities($text_to_convert)   X-Ref
Reverse function for htmlentities.
Convert entities in UTF-8.

param: $text_to_convert (string) Text to convert.
return: string converted text string

_objectkey($n)   X-Ref
Compute encryption key depending on object number where the encrypted data is stored.
This is used for all strings and streams without crypt filter specifier.

param: $n (int) object number
author: Nicola Asuni
return: int object key

_encrypt_data($n, $s)   X-Ref
Encrypt the input string.

param: $n (int) object number
param: $s (string) data string to encrypt
author: Nicola Asuni
return: encrypted string

_putencryption()   X-Ref
Put encryption on PDF document.

author: Nicola Asuni

_Uvalue()   X-Ref
Compute U value (used for encryption)

author: Nicola Asuni
return: string U value

_UEvalue()   X-Ref
Compute UE value (used for encryption)

author: Nicola Asuni
return: string UE value

_Ovalue()   X-Ref
Compute O value (used for encryption)

author: Nicola Asuni
return: string O value

_OEvalue()   X-Ref
Compute OE value (used for encryption)

author: Nicola Asuni
return: string OE value

_fixAES256Password($password)   X-Ref
Convert password for AES-256 encryption mode

param: $password (string) password
author: Nicola Asuni
return: string password

_generateencryptionkey()   X-Ref
Compute encryption key

author: Nicola Asuni

SetProtection($permissions=array('print', 'modify', 'copy', 'annot-forms', 'fill-forms', 'extract', 'assemble', 'print-high')   X-Ref
Set document protection
Remark: the protection against modification is for people who have the full Acrobat product.
If you don't set any password, the document will open as usual. If you set a user password, the PDF viewer will ask for it before displaying the document. The master password, if different from the user one, can be used to get full access.
Note: protecting a document requires to encrypt it, which increases the processing time a lot. This can cause a PHP time-out in some cases, especially if the document contains images or fonts.

param: $permissions (Array) the set of permissions (specify the ones you want to block):<ul><li>print : Print the document;</li><li>modify : Modify the contents of the document by operations other than those controlled by 'fill-forms', 'extract' and 'assemble';</li><li>copy : Copy or otherwise extract text and graphics from the document;</li><li>annot-forms : Add or modify text annotations, fill in interactive form fields, and, if 'modify' is also set, create or modify interactive form fields (including signature fields);</li><li>fill-forms : Fill in existing interactive form fields (including signature fields), even if 'annot-forms' is not specified;</li><li>extract : Extract text and graphics (in support of accessibility to users with disabilities or for other purposes);</li><li>assemble : Assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images), even if 'modify' is not set;</li><li>print-high : Print the document to a representation from which a faithful digital copy of the PDF content could be generated. When this is not set, printing is limited to a low-level representation of the appearance, possibly of degraded quality.</li><li>owner : (inverted logic - only for public-key) when set permits change of encryption and enables all other permissions.</li></ul>
param: $user_pass (String) user password. Empty by default.
param: $owner_pass (String) owner password. If not specified, a random value is used.
param: $mode (int) encryption strength: 0 = RC4 40 bit; 1 = RC4 128 bit; 2 = AES 128 bit; 3 = AES 256 bit.
param: $pubkeys (String) array of recipients containing public-key certificates ('c') and permissions ('p'). For example: array(array('c' => 'file://../examples/data/cert/tcpdf.crt', 'p' => array('print')))
author: Nicola Asuni

StartTransform()   X-Ref
Starts a 2D tranformation saving current graphic state.
This function must be called before scaling, mirroring, translation, rotation and skewing.
Use StartTransform() before, and StopTransform() after the transformations to restore the normal behavior.


StopTransform()   X-Ref
Stops a 2D tranformation restoring previous graphic state.
This function must be called after scaling, mirroring, translation, rotation and skewing.
Use StartTransform() before, and StopTransform() after the transformations to restore the normal behavior.


ScaleX($s_x, $x='', $y='')   X-Ref
Horizontal Scaling.

param: $s_x (float) scaling factor for width as percent. 0 is not allowed.
param: $x (int) abscissa of the scaling center. Default is current x position
param: $y (int) ordinate of the scaling center. Default is current y position

ScaleY($s_y, $x='', $y='')   X-Ref
Vertical Scaling.

param: $s_y (float) scaling factor for height as percent. 0 is not allowed.
param: $x (int) abscissa of the scaling center. Default is current x position
param: $y (int) ordinate of the scaling center. Default is current y position

ScaleXY($s, $x='', $y='')   X-Ref
Vertical and horizontal proportional Scaling.

param: $s (float) scaling factor for width and height as percent. 0 is not allowed.
param: $x (int) abscissa of the scaling center. Default is current x position
param: $y (int) ordinate of the scaling center. Default is current y position

Scale($s_x, $s_y, $x='', $y='')   X-Ref
Vertical and horizontal non-proportional Scaling.

param: $s_x (float) scaling factor for width as percent. 0 is not allowed.
param: $s_y (float) scaling factor for height as percent. 0 is not allowed.
param: $x (int) abscissa of the scaling center. Default is current x position
param: $y (int) ordinate of the scaling center. Default is current y position

MirrorH($x='')   X-Ref
Horizontal Mirroring.

param: $x (int) abscissa of the point. Default is current x position

MirrorV($y='')   X-Ref
Verical Mirroring.

param: $y (int) ordinate of the point. Default is current y position

MirrorP($x='',$y='')   X-Ref
Point reflection mirroring.

param: $x (int) abscissa of the point. Default is current x position
param: $y (int) ordinate of the point. Default is current y position

MirrorL($angle=0, $x='',$y='')   X-Ref
Reflection against a straight line through point (x, y) with the gradient angle (angle).

param: $angle (float) gradient angle of the straight line. Default is 0 (horizontal line).
param: $x (int) abscissa of the point. Default is current x position
param: $y (int) ordinate of the point. Default is current y position

TranslateX($t_x)   X-Ref
Translate graphic object horizontally.

param: $t_x (int) movement to the right (or left for RTL)

TranslateY($t_y)   X-Ref
Translate graphic object vertically.

param: $t_y (int) movement to the bottom

Translate($t_x, $t_y)   X-Ref
Translate graphic object horizontally and vertically.

param: $t_x (int) movement to the right
param: $t_y (int) movement to the bottom

Rotate($angle, $x='', $y='')   X-Ref
Rotate object.

param: $angle (float) angle in degrees for counter-clockwise rotation
param: $x (int) abscissa of the rotation center. Default is current x position
param: $y (int) ordinate of the rotation center. Default is current y position

SkewX($angle_x, $x='', $y='')   X-Ref
Skew horizontally.

param: $angle_x (float) angle in degrees between -90 (skew to the left) and 90 (skew to the right)
param: $x (int) abscissa of the skewing center. default is current x position
param: $y (int) ordinate of the skewing center. default is current y position

SkewY($angle_y, $x='', $y='')   X-Ref
Skew vertically.

param: $angle_y (float) angle in degrees between -90 (skew to the bottom) and 90 (skew to the top)
param: $x (int) abscissa of the skewing center. default is current x position
param: $y (int) ordinate of the skewing center. default is current y position

Skew($angle_x, $angle_y, $x='', $y='')   X-Ref
Skew.

param: $angle_x (float) angle in degrees between -90 (skew to the left) and 90 (skew to the right)
param: $angle_y (float) angle in degrees between -90 (skew to the bottom) and 90 (skew to the top)
param: $x (int) abscissa of the skewing center. default is current x position
param: $y (int) ordinate of the skewing center. default is current y position

Transform($tm)   X-Ref
Apply graphic transformations.

param: $tm (array) transformation matrix

SetLineWidth($width)   X-Ref
Defines the line width. By default, the value equals 0.2 mm. The method can be called before the first page is created and the value is retained from page to page.

param: $width (float) The width.

GetLineWidth()   X-Ref
Returns the current the line width.

return: int Line width

SetLineStyle($style, $ret=false)   X-Ref
Set line style.

param: $style (array) Line style. Array with keys among the following:
param: $ret (boolean) if true do not send the command.
return: string the PDF command

_outPoint($x, $y)   X-Ref
Begin a new subpath by moving the current point to coordinates (x, y), omitting any connecting line segment.

param: $x (float) Abscissa of point.
param: $y (float) Ordinate of point.

_outLine($x, $y)   X-Ref
Append a straight line segment from the current point to the point (x, y).
The new current point shall be (x, y).

param: $x (float) Abscissa of end point.
param: $y (float) Ordinate of end point.

_outRect($x, $y, $w, $h, $op)   X-Ref
Append a rectangle to the current path as a complete subpath, with lower-left corner (x, y) and dimensions widthand height in user space.

param: $x (float) Abscissa of upper-left corner.
param: $y (float) Ordinate of upper-left corner.
param: $w (float) Width.
param: $h (float) Height.
param: $op (string) options

_outCurve($x1, $y1, $x2, $y2, $x3, $y3)   X-Ref
Append a cubic Bezier curve to the current path. The curve shall extend from the current point to the point (x3, y3), using (x1, y1) and (x2, y2) as the Bezier control points.
The new current point shall be (x3, y3).

param: $x1 (float) Abscissa of control point 1.
param: $y1 (float) Ordinate of control point 1.
param: $x2 (float) Abscissa of control point 2.
param: $y2 (float) Ordinate of control point 2.
param: $x3 (float) Abscissa of end point.
param: $y3 (float) Ordinate of end point.

_outCurveV($x2, $y2, $x3, $y3)   X-Ref
Append a cubic Bezier curve to the current path. The curve shall extend from the current point to the point (x3, y3), using the current point and (x2, y2) as the Bezier control points.
The new current point shall be (x3, y3).

param: $x2 (float) Abscissa of control point 2.
param: $y2 (float) Ordinate of control point 2.
param: $x3 (float) Abscissa of end point.
param: $y3 (float) Ordinate of end point.

_outCurveY($x1, $y1, $x3, $y3)   X-Ref
Append a cubic Bezier curve to the current path. The curve shall extend from the current point to the point (x3, y3), using (x1, y1) and (x3, y3) as the Bezier control points.
The new current point shall be (x3, y3).

param: $x1 (float) Abscissa of control point 1.
param: $y1 (float) Ordinate of control point 1.
param: $x3 (float) Abscissa of end point.
param: $y3 (float) Ordinate of end point.

Line($x1, $y1, $x2, $y2, $style=array()   X-Ref
Draws a line between two points.

param: $x1 (float) Abscissa of first point.
param: $y1 (float) Ordinate of first point.
param: $x2 (float) Abscissa of second point.
param: $y2 (float) Ordinate of second point.
param: $style (array) Line style. Array like for SetLineStyle(). Default value: default line style (empty array).

Rect($x, $y, $w, $h, $style='', $border_style=array()   X-Ref
Draws a rectangle.

param: $x (float) Abscissa of upper-left corner.
param: $y (float) Ordinate of upper-left corner.
param: $w (float) Width.
param: $h (float) Height.
param: $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
param: $border_style (array) Border style of rectangle. Array with keys among the following:
param: $fill_color (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array).

Curve($x0, $y0, $x1, $y1, $x2, $y2, $x3, $y3, $style='', $line_style=array()   X-Ref
Draws a Bezier curve.
The Bezier curve is a tangent to the line between the control points at
either end of the curve.

param: $x0 (float) Abscissa of start point.
param: $y0 (float) Ordinate of start point.
param: $x1 (float) Abscissa of control point 1.
param: $y1 (float) Ordinate of control point 1.
param: $x2 (float) Abscissa of control point 2.
param: $y2 (float) Ordinate of control point 2.
param: $x3 (float) Abscissa of end point.
param: $y3 (float) Ordinate of end point.
param: $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
param: $line_style (array) Line style of curve. Array like for SetLineStyle(). Default value: default line style (empty array).
param: $fill_color (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array).

Polycurve($x0, $y0, $segments, $style='', $line_style=array()   X-Ref
Draws a poly-Bezier curve.
Each Bezier curve segment is a tangent to the line between the control points at
either end of the curve.

param: $x0 (float) Abscissa of start point.
param: $y0 (float) Ordinate of start point.
param: $segments (float) An array of bezier descriptions. Format: array(x1, y1, x2, y2, x3, y3).
param: $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
param: $line_style (array) Line style of curve. Array like for SetLineStyle(). Default value: default line style (empty array).
param: $fill_color (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array).

Ellipse($x0, $y0, $rx, $ry='', $angle=0, $astart=0, $afinish=360, $style='', $line_style=array()   X-Ref
Draws an ellipse.
An ellipse is formed from n Bezier curves.

param: $x0 (float) Abscissa of center point.
param: $y0 (float) Ordinate of center point.
param: $rx (float) Horizontal radius.
param: $ry (float) Vertical radius (if ry = 0 then is a circle, see Circle()). Default value: 0.
param: $angle: (float) Angle oriented (anti-clockwise). Default value: 0.
param: $astart: (float) Angle start of draw line. Default value: 0.
param: $afinish: (float) Angle finish of draw line. Default value: 360.
param: $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
param: $line_style (array) Line style of ellipse. Array like for SetLineStyle(). Default value: default line style (empty array).
param: $fill_color (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array).
param: $nc (integer) Number of curves used to draw a 90 degrees portion of ellipse.
author: Nicola Asuni

_outellipticalarc($xc, $yc, $rx, $ry, $xang=0, $angs=0, $angf=360, $pie=false, $nc=2, $startpoint=true, $ccw=true, $svg=false)   X-Ref
Append an elliptical arc to the current path.
An ellipse is formed from n Bezier curves.

param: $xc (float) Abscissa of center point.
param: $yc (float) Ordinate of center point.
param: $rx (float) Horizontal radius.
param: $ry (float) Vertical radius (if ry = 0 then is a circle, see Circle()). Default value: 0.
param: $xang: (float) Angle between the X-axis and the major axis of the ellipse. Default value: 0.
param: $angs: (float) Angle start of draw line. Default value: 0.
param: $angf: (float) Angle finish of draw line. Default value: 360.
param: $pie (boolean) if true do not mark the border point (used to draw pie sectors).
param: $nc (integer) Number of curves used to draw a 90 degrees portion of ellipse.
param: $startpoint (boolean) if true output a starting point.
param: $ccw (boolean) if true draws in counter-clockwise.
param: $svg (boolean) if true the angles are in svg mode (already calculated).
author: Nicola Asuni
return: array bounding box coordinates (x min, y min, x max, y max)

Circle($x0, $y0, $r, $angstr=0, $angend=360, $style='', $line_style=array()   X-Ref
Draws a circle.
A circle is formed from n Bezier curves.

param: $x0 (float) Abscissa of center point.
param: $y0 (float) Ordinate of center point.
param: $r (float) Radius.
param: $angstr: (float) Angle start of draw line. Default value: 0.
param: $angend: (float) Angle finish of draw line. Default value: 360.
param: $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
param: $line_style (array) Line style of circle. Array like for SetLineStyle(). Default value: default line style (empty array).
param: $fill_color (array) Fill color. Format: array(red, green, blue). Default value: default color (empty array).
param: $nc (integer) Number of curves used to draw a 90 degrees portion of circle.

PolyLine($p, $style='', $line_style=array()   X-Ref
Draws a polygonal line

param: $p (array) Points 0 to ($np - 1). Array with values (x0, y0, x1, y1,..., x(np-1), y(np - 1))
param: $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
param: $line_style (array) Line style of polygon. Array with keys among the following:
param: $fill_color (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array).

Polygon($p, $style='', $line_style=array()   X-Ref
Draws a polygon.

param: $p (array) Points 0 to ($np - 1). Array with values (x0, y0, x1, y1,..., x(np-1), y(np - 1))
param: $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
param: $line_style (array) Line style of polygon. Array with keys among the following:
param: $fill_color (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array).
param: $closed (boolean) if true the polygon is closes, otherwise will remain open

RegularPolygon($x0, $y0, $r, $ns, $angle=0, $draw_circle=false, $style='', $line_style=array()   X-Ref
Draws a regular polygon.

param: $x0 (float) Abscissa of center point.
param: $y0 (float) Ordinate of center point.
param: $r: (float) Radius of inscribed circle.
param: $ns (integer) Number of sides.
param: $angle (float) Angle oriented (anti-clockwise). Default value: 0.
param: $draw_circle (boolean) Draw inscribed circle or not. Default value: false.
param: $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
param: $line_style (array) Line style of polygon sides. Array with keys among the following:
param: $fill_color (array) Fill color. Format: array(red, green, blue). Default value: default color (empty array).
param: $circle_style (string) Style of rendering of inscribed circle (if draws). Possible values are:
param: $circle_outLine_style (array) Line style of inscribed circle (if draws). Array like for SetLineStyle(). Default value: default line style (empty array).
param: $circle_fill_color (array) Fill color of inscribed circle (if draws). Format: array(red, green, blue). Default value: default color (empty array).

StarPolygon($x0, $y0, $r, $nv, $ng, $angle=0, $draw_circle=false, $style='', $line_style=array()   X-Ref
Draws a star polygon

param: $x0 (float) Abscissa of center point.
param: $y0 (float) Ordinate of center point.
param: $r (float) Radius of inscribed circle.
param: $nv (integer) Number of vertices.
param: $ng (integer) Number of gap (if ($ng % $nv = 1) then is a regular polygon).
param: $angle: (float) Angle oriented (anti-clockwise). Default value: 0.
param: $draw_circle: (boolean) Draw inscribed circle or not. Default value is false.
param: $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
param: $line_style (array) Line style of polygon sides. Array with keys among the following:
param: $fill_color (array) Fill color. Format: array(red, green, blue). Default value: default color (empty array).
param: $circle_style (string) Style of rendering of inscribed circle (if draws). Possible values are:
param: $circle_outLine_style (array) Line style of inscribed circle (if draws). Array like for SetLineStyle(). Default value: default line style (empty array).
param: $circle_fill_color (array) Fill color of inscribed circle (if draws). Format: array(red, green, blue). Default value: default color (empty array).

RoundedRect($x, $y, $w, $h, $r, $round_corner='1111', $style='', $border_style=array()   X-Ref
Draws a rounded rectangle.

param: $x (float) Abscissa of upper-left corner.
param: $y (float) Ordinate of upper-left corner.
param: $w (float) Width.
param: $h (float) Height.
param: $r (float) the radius of the circle used to round off the corners of the rectangle.
param: $round_corner (string) Draws rounded corner or not. String with a 0 (not rounded i-corner) or 1 (rounded i-corner) in i-position. Positions are, in order and begin to 0: top right, bottom right, bottom left and top left. Default value: all rounded corner ("1111").
param: $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
param: $border_style (array) Border style of rectangle. Array like for SetLineStyle(). Default value: default line style (empty array).
param: $fill_color (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array).

RoundedRectXY($x, $y, $w, $h, $rx, $ry, $round_corner='1111', $style='', $border_style=array()   X-Ref
Draws a rounded rectangle.

param: $x (float) Abscissa of upper-left corner.
param: $y (float) Ordinate of upper-left corner.
param: $w (float) Width.
param: $h (float) Height.
param: $rx (float) the x-axis radius of the ellipse used to round off the corners of the rectangle.
param: $ry (float) the y-axis radius of the ellipse used to round off the corners of the rectangle.
param: $round_corner (string) Draws rounded corner or not. String with a 0 (not rounded i-corner) or 1 (rounded i-corner) in i-position. Positions are, in order and begin to 0: top right, bottom right, bottom left and top left. Default value: all rounded corner ("1111").
param: $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
param: $border_style (array) Border style of rectangle. Array like for SetLineStyle(). Default value: default line style (empty array).
param: $fill_color (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array).

Arrow($x0, $y0, $x1, $y1, $head_style=0, $arm_size=5, $arm_angle=15)   X-Ref
Draws a grahic arrow.

param: $x0 (float) Abscissa of first point.
param: $y0 (float) Ordinate of first point.
param: $x1 (float) Abscissa of second point.
param: $y1 (float) Ordinate of second point.
param: $head_style (int) (0 = draw only arrowhead arms, 1 = draw closed arrowhead, but no fill, 2 = closed and filled arrowhead, 3 = filled arrowhead)
param: $arm_size (float) length of arrowhead arms
param: $arm_angle (int) angle between an arm and the shaft
author: Piotr Galecki, Nicola Asuni, Andy Meier

setDestination($name, $y=-1, $page='', $x=-1)   X-Ref
Add a Named Destination.
NOTE: destination names are unique, so only last entry will be saved.

param: $name (string) Destination name.
param: $y (float) Y position in user units of the destiantion on the selected page (default = -1 = current position; 0 = page start;).
param: $page (int|string) Target page number (leave empty for current page). If you prefix a page number with the * character, then this page will not be changed when adding/deleting/moving pages.
param: $x (float) X position in user units of the destiantion on the selected page (default = -1 = current position;).
author: Christian Deligant, Nicola Asuni
return: (string) Stripped named destination identifier or false in case of error.

getDestination()   X-Ref
Return the Named Destination array.

author: Nicola Asuni
return: (array) Named Destination array.

_putdests()   X-Ref
Insert Named Destinations.

author: Johannes G\FCntert, Nicola Asuni

setBookmark($txt, $level=0, $y=-1, $page='', $style='', $color=array(0,0,0)   X-Ref
Adds a bookmark - alias for Bookmark().

param: $txt (string) Bookmark description.
param: $level (int) Bookmark level (minimum value is 0).
param: $y (float) Y position in user units of the bookmark on the selected page (default = -1 = current position; 0 = page start;).
param: $page (int|string) Target page number (leave empty for current page). If you prefix a page number with the * character, then this page will not be changed when adding/deleting/moving pages.
param: $style (string) Font style: B = Bold, I = Italic, BI = Bold + Italic.
param: $color (array) RGB color array (values from 0 to 255).
param: $x (float) X position in user units of the bookmark on the selected page (default = -1 = current position;).
param: $link (mixed) URL, or numerical link ID, or named destination (# character followed by the destination name), or embedded file (* character followed by the file name).

Bookmark($txt, $level=0, $y=-1, $page='', $style='', $color=array(0,0,0)   X-Ref
Adds a bookmark.

param: $txt (string) Bookmark description.
param: $level (int) Bookmark level (minimum value is 0).
param: $y (float) Y position in user units of the bookmark on the selected page (default = -1 = current position; 0 = page start;).
param: $page (int|string) Target page number (leave empty for current page). If you prefix a page number with the * character, then this page will not be changed when adding/deleting/moving pages.
param: $style (string) Font style: B = Bold, I = Italic, BI = Bold + Italic.
param: $color (array) RGB color array (values from 0 to 255).
param: $x (float) X position in user units of the bookmark on the selected page (default = -1 = current position;).
param: $link (mixed) URL, or numerical link ID, or named destination (# character followed by the destination name), or embedded file (* character followed by the file name).

sortBookmarks()   X-Ref
Sort bookmarks for page and key.


_putbookmarks()   X-Ref
Create a bookmark PDF string.

author: Olivier Plathey, Nicola Asuni

IncludeJS($script)   X-Ref
Adds a javascript

param: $script (string) Javascript code
author: Johannes G\FCntert, Nicola Asuni

addJavascriptObject($script, $onload=false)   X-Ref
Adds a javascript object and return object ID

param: $script (string) Javascript code
param: $onload (boolean) if true executes this object when opening the document
author: Nicola Asuni
return: int internal object ID

_putjavascript()   X-Ref
Create a javascript PDF string.

author: Johannes G\FCntert, Nicola Asuni

_addfield($type, $name, $x, $y, $w, $h, $prop)   X-Ref
Adds a javascript form field.

param: $type (string) field type
param: $name (string) field name
param: $x (int) horizontal position
param: $y (int) vertical position
param: $w (int) width
param: $h (int) height
param: $prop (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
author: Denis Van Nuffelen, Nicola Asuni

setFormDefaultProp($prop=array()   X-Ref
Set default properties for form fields.

param: $prop (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
author: Nicola Asuni

getFormDefaultProp()   X-Ref
Return the default properties for form fields.

author: Nicola Asuni
return: array $prop javascript field properties. Possible values are described on official Javascript for Acrobat API reference.

TextField($name, $w, $h, $prop=array()   X-Ref
Creates a text field

param: $name (string) field name
param: $w (float) Width of the rectangle
param: $h (float) Height of the rectangle
param: $prop (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
param: $opt (array) annotation parameters. Possible values are described on official PDF32000_2008 reference.
param: $x (float) Abscissa of the upper-left corner of the rectangle
param: $y (float) Ordinate of the upper-left corner of the rectangle
param: $js (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered).
author: Nicola Asuni

RadioButton($name, $w, $prop=array()   X-Ref
Creates a RadioButton field.

param: $name (string) Field name.
param: $w (int) Width of the radio button.
param: $prop (array) Javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
param: $opt (array) Annotation parameters. Possible values are described on official PDF32000_2008 reference.
param: $onvalue (string) Value to be returned if selected.
param: $checked (boolean) Define the initial state.
param: $x (float) Abscissa of the upper-left corner of the rectangle
param: $y (float) Ordinate of the upper-left corner of the rectangle
param: $js (boolean) If true put the field using JavaScript (requires Acrobat Writer to be rendered).
author: Nicola Asuni

ListBox($name, $w, $h, $values, $prop=array()   X-Ref
Creates a List-box field

param: $name (string) field name
param: $w (int) width
param: $h (int) height
param: $values (array) array containing the list of values.
param: $prop (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
param: $opt (array) annotation parameters. Possible values are described on official PDF32000_2008 reference.
param: $x (float) Abscissa of the upper-left corner of the rectangle
param: $y (float) Ordinate of the upper-left corner of the rectangle
param: $js (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered).
author: Nicola Asuni

ComboBox($name, $w, $h, $values, $prop=array()   X-Ref
Creates a Combo-box field

param: $name (string) field name
param: $w (int) width
param: $h (int) height
param: $values (array) array containing the list of values.
param: $prop (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
param: $opt (array) annotation parameters. Possible values are described on official PDF32000_2008 reference.
param: $x (float) Abscissa of the upper-left corner of the rectangle
param: $y (float) Ordinate of the upper-left corner of the rectangle
param: $js (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered).
author: Nicola Asuni

CheckBox($name, $w, $checked=false, $prop=array()   X-Ref
Creates a CheckBox field

param: $name (string) field name
param: $w (int) width
param: $checked (boolean) define the initial state.
param: $prop (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
param: $opt (array) annotation parameters. Possible values are described on official PDF32000_2008 reference.
param: $onvalue (string) value to be returned if selected.
param: $x (float) Abscissa of the upper-left corner of the rectangle
param: $y (float) Ordinate of the upper-left corner of the rectangle
param: $js (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered).
author: Nicola Asuni

Button($name, $w, $h, $caption, $action, $prop=array()   X-Ref
Creates a button field

param: $name (string) field name
param: $w (int) width
param: $h (int) height
param: $caption (string) caption.
param: $action (mixed) action triggered by pressing the button. Use a string to specify a javascript action. Use an array to specify a form action options as on section 12.7.5 of PDF32000_2008.
param: $prop (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
param: $opt (array) annotation parameters. Possible values are described on official PDF32000_2008 reference.
param: $x (float) Abscissa of the upper-left corner of the rectangle
param: $y (float) Ordinate of the upper-left corner of the rectangle
param: $js (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered).
author: Nicola Asuni

_putsignature()   X-Ref
Add certification signature (DocMDP or UR3)
You can set only one signature type

author: Nicola Asuni

setUserRights($enable=true,$document='/FullSave',$annots='/Create/Delete/Modify/Copy/Import/Export',$form='/Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemplate',$signature='/Modify',$ef='/Create/Delete/Modify/Import',$formex='')   X-Ref
Set User's Rights for PDF Reader
WARNING: This is experimental and currently do not work.
Check the PDF Reference 8.7.1 Transform Methods,
Table 8.105 Entries in the UR transform parameters dictionary

param: $enable (boolean) if true enable user's rights on PDF reader
param: $document (string) Names specifying additional document-wide usage rights for the document. The only defined value is "/FullSave", which permits a user to save the document along with modified form and/or annotation data.
param: $annots (string) Names specifying additional annotation-related usage rights for the document. Valid names in PDF 1.5 and later are /Create/Delete/Modify/Copy/Import/Export, which permit the user to perform the named operation on annotations.
param: $form (string) Names specifying additional form-field-related usage rights for the document. Valid names are: /Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemplate
param: $signature (string) Names specifying additional signature-related usage rights for the document. The only defined value is /Modify, which permits a user to apply a digital signature to an existing signature form field or clear a signed signature form field.
param: $ef (string) Names specifying additional usage rights for named embedded files in the document. Valid names are /Create/Delete/Modify/Import, which permit the user to perform the named operation on named embedded files
param: $formex (string) Names specifying additional form-field-related usage rights. The only valid name is BarcodePlaintext, which permits text form field data to be encoded as a plaintext two-dimensional barcode.
author: Nicola Asuni

setSignature($signing_cert='', $private_key='', $private_key_password='', $extracerts='', $cert_type=2, $info=array()   X-Ref
Enable document signature (requires the OpenSSL Library).
The digital signature improve document authenticity and integrity and allows o enable extra features on Acrobat Reader.
To create self-signed signature: openssl req -x509 -nodes -days 365000 -newkey rsa:1024 -keyout tcpdf.crt -out tcpdf.crt
To export crt to p12: openssl pkcs12 -export -in tcpdf.crt -out tcpdf.p12
To convert pfx certificate to pem: openssl pkcs12 -in tcpdf.pfx -out tcpdf.crt -nodes

param: $signing_cert (mixed) signing certificate (string or filename prefixed with 'file://')
param: $private_key (mixed) private key (string or filename prefixed with 'file://')
param: $private_key_password (string) password
param: $extracerts (string) specifies the name of a file containing a bunch of extra certificates to include in the signature which can for example be used to help the recipient to verify the certificate that you used.
param: $cert_type (int) The access permissions granted for this document. Valid values shall be: 1 = No changes to the document shall be permitted; any change to the document shall invalidate the signature; 2 = Permitted changes shall be filling in forms, instantiating page templates, and signing; other changes shall invalidate the signature; 3 = Permitted changes shall be the same as for 2, as well as annotation creation, deletion, and modification; other changes shall invalidate the signature.
param: $info (array) array of option information: Name, Location, Reason, ContactInfo.
param: $approval (string) Enable approval signature eg. for PDF incremental update
author: Nicola Asuni

setSignatureAppearance($x=0, $y=0, $w=0, $h=0, $page=-1, $name='')   X-Ref
Set the digital signature appearance (a cliccable rectangle area to get signature properties)

param: $x (float) Abscissa of the upper-left corner.
param: $y (float) Ordinate of the upper-left corner.
param: $w (float) Width of the signature area.
param: $h (float) Height of the signature area.
param: $page (int) option page number (if < 0 the current page is used).
param: $name (string) Name of the signature.
author: Nicola Asuni

addEmptySignatureAppearance($x=0, $y=0, $w=0, $h=0, $page=-1, $name='')   X-Ref
Add an empty digital signature appearance (a cliccable rectangle area to get signature properties)

param: $x (float) Abscissa of the upper-left corner.
param: $y (float) Ordinate of the upper-left corner.
param: $w (float) Width of the signature area.
param: $h (float) Height of the signature area.
param: $page (int) option page number (if < 0 the current page is used).
param: $name (string) Name of the signature.
author: Nicola Asuni

getSignatureAppearanceArray($x=0, $y=0, $w=0, $h=0, $page=-1, $name='')   X-Ref
Get the array that defines the signature appearance (page and rectangle coordinates).

param: $x (float) Abscissa of the upper-left corner.
param: $y (float) Ordinate of the upper-left corner.
param: $w (float) Width of the signature area.
param: $h (float) Height of the signature area.
param: $page (int) option page number (if < 0 the current page is used).
param: $name (string) Name of the signature.
author: Nicola Asuni
return: (array) Array defining page and rectangle coordinates of signature appearance.

setTimeStamp($tsa_host='', $tsa_username='', $tsa_password='', $tsa_cert='')   X-Ref
Enable document timestamping (requires the OpenSSL Library).
The trusted timestamping improve document security that means that no one should be able to change the document once it has been recorded.
Use with digital signature only!

param: $tsa_host (string) Time Stamping Authority (TSA) server (prefixed with 'https://')
param: $tsa_username (string) Specifies the username for TSA authorization (optional) OR specifies the TSA authorization PEM file (see: example_66.php, optional)
param: $tsa_password (string) Specifies the password for TSA authorization (optional)
param: $tsa_cert (string) Specifies the location of TSA certificate for authorization (optional for cURL)
author: Richard Stockinger

applyTSA($signature)   X-Ref
NOT YET IMPLEMENTED
Request TSA for a timestamp

param: $signature (string) Digital signature as binary string
author: Richard Stockinger
return: (string) Timestamped digital signature

startPageGroup($page='')   X-Ref
Create a new page group.
NOTE: call this function before calling AddPage()

param: $page (int) starting group page (leave empty for next page).

setStartingPageNumber($num=1)   X-Ref
Set the starting page number.

param: $num (int) Starting page number.

getAliasRightShift()   X-Ref
Returns the string alias used right align page numbers.
If the current font is unicode type, the returned string wil contain an additional open curly brace.

return: string

getAliasNbPages()   X-Ref
Returns the string alias used for the total number of pages.
If the current font is unicode type, the returned string is surrounded by additional curly braces.
This alias will be replaced by the total number of pages in the document.

return: string

getAliasNumPage()   X-Ref
Returns the string alias used for the page number.
If the current font is unicode type, the returned string is surrounded by additional curly braces.
This alias will be replaced by the page number.

return: string

getPageGroupAlias()   X-Ref
Return the alias for the total number of pages in the current page group.
If the current font is unicode type, the returned string is surrounded by additional curly braces.
This alias will be replaced by the total number of pages in this group.

return: alias of the current page group

getPageNumGroupAlias()   X-Ref
Return the alias for the page number on the current page group.
If the current font is unicode type, the returned string is surrounded by additional curly braces.
This alias will be replaced by the page number (relative to the belonging group).

return: alias of the current page group

getGroupPageNo()   X-Ref
Return the current page in the group.

return: current page in the group

getGroupPageNoFormatted()   X-Ref
Returns the current group page number formatted as a string.


PageNoFormatted()   X-Ref
Returns the current page number formatted as a string.


_putocg()   X-Ref
Put pdf layers.


startLayer($name='', $print=true, $view=true, $lock=true)   X-Ref
Start a new pdf layer.

param: $name (string) Layer name (only a-z letters and numbers). Leave empty for automatic name.
param: $print (boolean|null) Set to TRUE to print this layer, FALSE to not print and NULL to not set this option
param: $view (boolean) Set to true to view this layer.
param: $lock (boolean) If true lock the layer

endLayer()   X-Ref
End the current PDF layer.


setVisibility($v)   X-Ref
Set the visibility of the successive elements.
This can be useful, for instance, to put a background
image or color that will show on screen but won't print.

param: $v (string) visibility mode. Legal values are: all, print, screen or view.

addExtGState($parms)   X-Ref
Add transparency parameters to the current extgstate

param: $parms (array) parameters
return: the number of extgstates

setExtGState($gs)   X-Ref
Add an extgstate

param: $gs (array) extgstate

_putextgstates()   X-Ref
Put extgstates for object transparency


setOverprint($stroking=true, $nonstroking='', $mode=0)   X-Ref
Set overprint mode for stroking (OP) and non-stroking (op) painting operations.
(Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).

param: $stroking (boolean) If true apply overprint for stroking operations.
param: $nonstroking (boolean) If true apply overprint for painting operations other than stroking.
param: $mode (integer) Overprint mode: (0 = each source colour component value replaces the value previously painted for the corresponding device colorant; 1 = a tint value of 0.0 for a source colour component shall leave the corresponding component of the previously painted colour unchanged).

getOverprint()   X-Ref
Get the overprint mode array (OP, op, OPM).
(Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).

return: array.

setAlpha($stroking=1, $bm='Normal', $nonstroking='', $ais=false)   X-Ref
Set alpha for stroking (CA) and non-stroking (ca) operations.

param: $stroking (float) Alpha value for stroking operations: real value from 0 (transparent) to 1 (opaque).
param: $bm (string) blend mode, one of the following: Normal, Multiply, Screen, Overlay, Darken, Lighten, ColorDodge, ColorBurn, HardLight, SoftLight, Difference, Exclusion, Hue, Saturation, Color, Luminosity
param: $nonstroking (float) Alpha value for non-stroking operations: real value from 0 (transparent) to 1 (opaque).
param: $ais (boolean)

getAlpha()   X-Ref
Get the alpha mode array (CA, ca, BM, AIS).
(Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).

return: array.

setJPEGQuality($quality)   X-Ref
Set the default JPEG compression quality (1-100)

param: $quality (int) JPEG quality, integer between 1 and 100

setDefaultTableColumns($cols=4)   X-Ref
Set the default number of columns in a row for HTML tables.

param: $cols (int) number of columns

setCellHeightRatio($h)   X-Ref
Set the height of the cell (line height) respect the font height.

param: $h (int) cell proportion respect font height (typical value = 1.25).

getCellHeightRatio()   X-Ref
return the height of cell repect font height.


setPDFVersion($version='1.7')   X-Ref
Set the PDF version (check PDF reference for valid values).

param: $version (string) PDF document version.

setViewerPreferences($preferences)   X-Ref
Set the viewer preferences dictionary controlling the way the document is to be presented on the screen or in print.
(see Section 8.1 of PDF reference, "Viewer Preferences").
<ul><li>HideToolbar boolean (Optional) A flag specifying whether to hide the viewer application's tool bars when the document is active. Default value: false.</li><li>HideMenubar boolean (Optional) A flag specifying whether to hide the viewer application's menu bar when the document is active. Default value: false.</li><li>HideWindowUI boolean (Optional) A flag specifying whether to hide user interface elements in the document's window (such as scroll bars and navigation controls), leaving only the document's contents displayed. Default value: false.</li><li>FitWindow boolean (Optional) A flag specifying whether to resize the document's window to fit the size of the first displayed page. Default value: false.</li><li>CenterWindow boolean (Optional) A flag specifying whether to position the document's window in the center of the screen. Default value: false.</li><li>DisplayDocTitle boolean (Optional; PDF 1.4) A flag specifying whether the window's title bar should display the document title taken from the Title entry of the document information dictionary (see Section 10.2.1, "Document Information Dictionary"). If false, the title bar should instead display the name of the PDF file containing the document. Default value: false.</li><li>NonFullScreenPageMode name (Optional) The document's page mode, specifying how to display the document on exiting full-screen mode:<ul><li>UseNone Neither document outline nor thumbnail images visible</li><li>UseOutlines Document outline visible</li><li>UseThumbs Thumbnail images visible</li><li>UseOC Optional content group panel visible</li></ul>This entry is meaningful only if the value of the PageMode entry in the catalog dictionary (see Section 3.6.1, "Document Catalog") is FullScreen; it is ignored otherwise. Default value: UseNone.</li><li>ViewArea name (Optional; PDF 1.4) The name of the page boundary representing the area of a page to be displayed when viewing the document on the screen. Valid values are (see Section 10.10.1, "Page Boundaries").:<ul><li>MediaBox</li><li>CropBox (default)</li><li>BleedBox</li><li>TrimBox</li><li>ArtBox</li></ul></li><li>ViewClip name (Optional; PDF 1.4) The name of the page boundary to which the contents of a page are to be clipped when viewing the document on the screen. Valid values are (see Section 10.10.1, "Page Boundaries").:<ul><li>MediaBox</li><li>CropBox (default)</li><li>BleedBox</li><li>TrimBox</li><li>ArtBox</li></ul></li><li>PrintArea name (Optional; PDF 1.4) The name of the page boundary representing the area of a page to be rendered when printing the document. Valid values are (see Section 10.10.1, "Page Boundaries").:<ul><li>MediaBox</li><li>CropBox (default)</li><li>BleedBox</li><li>TrimBox</li><li>ArtBox</li></ul></li><li>PrintClip name (Optional; PDF 1.4) The name of the page boundary to which the contents of a page are to be clipped when printing the document. Valid values are (see Section 10.10.1, "Page Boundaries").:<ul><li>MediaBox</li><li>CropBox (default)</li><li>BleedBox</li><li>TrimBox</li><li>ArtBox</li></ul></li><li>PrintScaling name (Optional; PDF 1.6) The page scaling option to be selected when a print dialog is displayed for this document. Valid values are: <ul><li>None, which indicates that the print dialog should reflect no page scaling</li><li>AppDefault (default), which indicates that applications should use the current print scaling</li></ul></li><li>Duplex name (Optional; PDF 1.7) The paper handling option to use when printing the file from the print dialog. The following values are valid:<ul><li>Simplex - Print single-sided</li><li>DuplexFlipShortEdge - Duplex and flip on the short edge of the sheet</li><li>DuplexFlipLongEdge - Duplex and flip on the long edge of the sheet</li></ul>Default value: none</li><li>PickTrayByPDFSize boolean (Optional; PDF 1.7) A flag specifying whether the PDF page size is used to select the input paper tray. This setting influences only the preset values used to populate the print dialog presented by a PDF viewer application. If PickTrayByPDFSize is true, the check box in the print dialog associated with input paper tray is checked. Note: This setting has no effect on Mac OS systems, which do not provide the ability to pick the input tray by size.</li><li>PrintPageRange array (Optional; PDF 1.7) The page numbers used to initialize the print dialog box when the file is printed. The first page of the PDF file is denoted by 1. Each pair consists of the first and last pages in the sub-range. An odd number of integers causes this entry to be ignored. Negative numbers cause the entire array to be ignored. Default value: as defined by PDF viewer application</li><li>NumCopies integer (Optional; PDF 1.7) The number of copies to be printed when the print dialog is opened for this file. Supported values are the integers 2 through 5. Values outside this range are ignored. Default value: as defined by PDF viewer application, but typically 1</li></ul>

param: $preferences (array) array of options.
author: Nicola Asuni

colorRegistrationBar($x, $y, $w, $h, $transition=true, $vertical=false, $colors='A,R,G,B,C,M,Y,K')   X-Ref
Paints color transition registration bars

param: $x (float) abscissa of the top left corner of the rectangle.
param: $y (float) ordinate of the top left corner of the rectangle.
param: $w (float) width of the rectangle.
param: $h (float) height of the rectangle.
param: $transition (boolean) if true prints tcolor transitions to white.
param: $vertical (boolean) if true prints bar vertically.
param: $colors (string) colors to print separated by comma. Valid values are: A,W,R,G,B,C,M,Y,K,RGB,CMYK,ALL,ALLSPOT,<SPOT_COLOR_NAME>. Where: A = grayscale black, W = grayscale white, R = RGB red, G RGB green, B RGB blue, C = CMYK cyan, M = CMYK magenta, Y = CMYK yellow, K = CMYK key/black, RGB = RGB registration color, CMYK = CMYK registration color, ALL = Spot registration color, ALLSPOT = print all defined spot colors, <SPOT_COLOR_NAME> = name of the spot color to print.
author: Nicola Asuni

cropMark($x, $y, $w, $h, $type='T,R,B,L', $color=array(100,100,100,100,'All')   X-Ref
Paints crop marks.

param: $x (float) abscissa of the crop mark center.
param: $y (float) ordinate of the crop mark center.
param: $w (float) width of the crop mark.
param: $h (float) height of the crop mark.
param: $type (string) type of crop mark, one symbol per type separated by comma: T = TOP, F = BOTTOM, L = LEFT, R = RIGHT, TL = A = TOP-LEFT, TR = B = TOP-RIGHT, BL = C = BOTTOM-LEFT, BR = D = BOTTOM-RIGHT.
param: $color (array) crop mark color (default spot registration color).
author: Nicola Asuni

registrationMark($x, $y, $r, $double=false, $cola=array(100,100,100,100,'All')   X-Ref
Paints a registration mark

param: $x (float) abscissa of the registration mark center.
param: $y (float) ordinate of the registration mark center.
param: $r (float) radius of the crop mark.
param: $double (boolean) if true print two concentric crop marks.
param: $cola (array) crop mark color (default spot registration color 'All').
param: $colb (array) second crop mark color (default spot registration color 'None').
author: Nicola Asuni

registrationMarkCMYK($x, $y, $r)   X-Ref
Paints a CMYK registration mark

param: $x (float) abscissa of the registration mark center.
param: $y (float) ordinate of the registration mark center.
param: $r (float) radius of the crop mark.
author: Nicola Asuni

LinearGradient($x, $y, $w, $h, $col1=array()   X-Ref
Paints a linear colour gradient.

param: $x (float) abscissa of the top left corner of the rectangle.
param: $y (float) ordinate of the top left corner of the rectangle.
param: $w (float) width of the rectangle.
param: $h (float) height of the rectangle.
param: $col1 (array) first color (Grayscale, RGB or CMYK components).
param: $col2 (array) second color (Grayscale, RGB or CMYK components).
param: $coords (array) array of the form (x1, y1, x2, y2) which defines the gradient vector (see linear_gradient_coords.jpg). The default value is from left to right (x1=0, y1=0, x2=1, y2=0).
author: Andreas W\FCrmser, Nicola Asuni

RadialGradient($x, $y, $w, $h, $col1=array()   X-Ref
Paints a radial colour gradient.

param: $x (float) abscissa of the top left corner of the rectangle.
param: $y (float) ordinate of the top left corner of the rectangle.
param: $w (float) width of the rectangle.
param: $h (float) height of the rectangle.
param: $col1 (array) first color (Grayscale, RGB or CMYK components).
param: $col2 (array) second color (Grayscale, RGB or CMYK components).
param: $coords (array) array of the form (fx, fy, cx, cy, r) where (fx, fy) is the starting point of the gradient with color1, (cx, cy) is the center of the circle with color2, and r is the radius of the circle (see radial_gradient_coords.jpg). (fx, fy) should be inside the circle, otherwise some areas will not be defined.
author: Andreas W\FCrmser, Nicola Asuni

CoonsPatchMesh($x, $y, $w, $h, $col1=array()   X-Ref
Paints a coons patch mesh.

param: $x (float) abscissa of the top left corner of the rectangle.
param: $y (float) ordinate of the top left corner of the rectangle.
param: $w (float) width of the rectangle.
param: $h (float) height of the rectangle.
param: $col1 (array) first color (lower left corner) (RGB components).
param: $col2 (array) second color (lower right corner) (RGB components).
param: $col3 (array) third color (upper right corner) (RGB components).
param: $col4 (array) fourth color (upper left corner) (RGB components).
param: $coords (array) <ul><li>for one patch mesh: array(float x1, float y1, .... float x12, float y12): 12 pairs of coordinates (normally from 0 to 1) which specify the Bezier control points that define the patch. First pair is the lower left edge point, next is its right control point (control point 2). Then the other points are defined in the order: control point 1, edge point, control point 2 going counter-clockwise around the patch. Last (x12, y12) is the first edge point's left control point (control point 1).</li><li>for two or more patch meshes: array[number of patches]: arrays with the following keys for each patch: f: where to put that patch (0 = first patch, 1, 2, 3 = right, top and left of precedent patch - I didn't figure this out completely - just try and error ;-) points: 12 pairs of coordinates of the Bezier control points as above for the first patch, 8 pairs of coordinates for the following patches, ignoring the coordinates already defined by the precedent patch (I also didn't figure out the order of these - also: try and see what's happening) colors: must be 4 colors for the first patch, 2 colors for the following patches</li></ul>
param: $coords_min (array) minimum value used by the coordinates. If a coordinate's value is smaller than this it will be cut to coords_min. default: 0
param: $coords_max (array) maximum value used by the coordinates. If a coordinate's value is greater than this it will be cut to coords_max. default: 1
param: $antialias (boolean) A flag indicating whether to filter the shading function to prevent aliasing artifacts.
author: Andreas W\FCrmser, Nicola Asuni

Clip($x, $y, $w, $h)   X-Ref
Set a rectangular clipping area.

param: $x (float) abscissa of the top left corner of the rectangle (or top right corner for RTL mode).
param: $y (float) ordinate of the top left corner of the rectangle.
param: $w (float) width of the rectangle.
param: $h (float) height of the rectangle.
author: Andreas W\FCrmser, Nicola Asuni

Gradient($type, $coords, $stops, $background=array()   X-Ref
Output gradient.

param: $type (int) type of gradient (1 Function-based shading; 2 Axial shading; 3 Radial shading; 4 Free-form Gouraud-shaded triangle mesh; 5 Lattice-form Gouraud-shaded triangle mesh; 6 Coons patch mesh; 7 Tensor-product patch mesh). (Not all types are currently supported)
param: $coords (array) array of coordinates.
param: $stops (array) array gradient color components: color = array of GRAY, RGB or CMYK color components; offset = (0 to 1) represents a location along the gradient vector; exponent = exponent of the exponential interpolation function (default = 1).
param: $background (array) An array of colour components appropriate to the colour space, specifying a single background colour value.
param: $antialias (boolean) A flag indicating whether to filter the shading function to prevent aliasing artifacts.
author: Nicola Asuni

_putshaders()   X-Ref
Output gradient shaders.

author: Nicola Asuni

PieSector($xc, $yc, $r, $a, $b, $style='FD', $cw=true, $o=90)   X-Ref
Draw the sector of a circle.
It can be used for instance to render pie charts.

param: $xc (float) abscissa of the center.
param: $yc (float) ordinate of the center.
param: $r (float) radius.
param: $a (float) start angle (in degrees).
param: $b (float) end angle (in degrees).
param: $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
param: $cw: (float) indicates whether to go clockwise (default: true).
param: $o: (float) origin of angles (0 for 3 o'clock, 90 for noon, 180 for 9 o'clock, 270 for 6 o'clock). Default: 90.
author: Maxime Delorme, Nicola Asuni

PieSectorXY($xc, $yc, $rx, $ry, $a, $b, $style='FD', $cw=false, $o=0, $nc=2)   X-Ref
Draw the sector of an ellipse.
It can be used for instance to render pie charts.

param: $xc (float) abscissa of the center.
param: $yc (float) ordinate of the center.
param: $rx (float) the x-axis radius.
param: $ry (float) the y-axis radius.
param: $a (float) start angle (in degrees).
param: $b (float) end angle (in degrees).
param: $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
param: $cw: (float) indicates whether to go clockwise.
param: $o: (float) origin of angles (0 for 3 o'clock, 90 for noon, 180 for 9 o'clock, 270 for 6 o'clock).
param: $nc (integer) Number of curves used to draw a 90 degrees portion of arc.
author: Maxime Delorme, Nicola Asuni

ImageEps($file, $x='', $y='', $w=0, $h=0, $link='', $useBoundingBox=true, $align='', $palign='', $border=0, $fitonpage=false, $fixoutvals=false)   X-Ref
Embed vector-based Adobe Illustrator (AI) or AI-compatible EPS files.
NOTE: EPS is not yet fully implemented, use the setRasterizeVectorImages() method to enable/disable rasterization of vector images using ImageMagick library.
Only vector drawing is supported, not text or bitmap.
Although the script was successfully tested with various AI format versions, best results are probably achieved with files that were exported in the AI3 format (tested with Illustrator CS2, Freehand MX and Photoshop CS2).

param: $file (string) Name of the file containing the image or a '@' character followed by the EPS/AI data string.
param: $x (float) Abscissa of the upper-left corner.
param: $y (float) Ordinate of the upper-left corner.
param: $w (float) Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
param: $h (float) Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
param: $link (mixed) URL or identifier returned by AddLink().
param: $useBoundingBox (boolean) specifies whether to position the bounding box (true) or the complete canvas (false) at location (x,y). Default value is true.
param: $align (string) Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul>
param: $palign (string) Allows to center or align the image on the current line. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul>
param: $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
param: $fitonpage (boolean) if true the image is resized to not exceed page dimensions.
param: $fixoutvals (boolean) if true remove values outside the bounding box.
author: Valentin Schmidt, Nicola Asuni

setBarcode($bc='')   X-Ref
Set document barcode.

param: $bc (string) barcode

getBarcode()   X-Ref
Get current barcode.

return: string

write1DBarcode($code, $type, $x='', $y='', $w='', $h='', $xres='', $style=array()   X-Ref
Print a Linear Barcode.

param: $code (string) code to print
param: $type (string) type of barcode (see tcpdf_barcodes_1d.php for supported formats).
param: $x (int) x position in user units (empty string = current x position)
param: $y (int) y position in user units (empty string = current y position)
param: $w (int) width in user units (empty string = remaining page width)
param: $h (int) height in user units (empty string = remaining page height)
param: $xres (float) width of the smallest bar in user units (empty string = default value = 0.4mm)
param: $style (array) array of options:<ul>
param: $align (string) Indicates the alignment of the pointer next to barcode insertion relative to barcode height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul>
author: Nicola Asuni

write2DBarcode($code, $type, $x='', $y='', $w='', $h='', $style=array()   X-Ref
Print 2D Barcode.

param: $code (string) code to print
param: $type (string) type of barcode (see tcpdf_barcodes_2d.php for supported formats).
param: $x (int) x position in user units
param: $y (int) y position in user units
param: $w (int) width in user units
param: $h (int) height in user units
param: $style (array) array of options:<ul>
param: $align (string) Indicates the alignment of the pointer next to barcode insertion relative to barcode height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul>
param: $distort (boolean) if true distort the barcode to fit width and height, otherwise preserve aspect ratio
author: Nicola Asuni

getMargins()   X-Ref
Returns an array containing current margins:
<ul>
</ul>

return: array containing all margins measures

getOriginalMargins()   X-Ref
Returns an array containing original margins:
<ul>
</ul>

return: array containing all margins measures

getFontSize()   X-Ref
Returns the current font size.

return: current font size

getFontSizePt()   X-Ref
Returns the current font size in points unit.

return: current font size in points unit

getFontFamily()   X-Ref
Returns the current font family name.

return: string current font family name

getFontStyle()   X-Ref
Returns the current font style.

return: string current font style

fixHTMLCode($html, $default_css='', $tagvs='', $tidy_options='')   X-Ref
Cleanup HTML code (requires HTML Tidy library).

param: $html (string) htmlcode to fix
param: $default_css (string) CSS commands to add
param: $tagvs (array) parameters for setHtmlVSpace method
param: $tidy_options (array) options for tidy_parse_string function
author: Nicola Asuni
return: string XHTML code cleaned up

getCSSBorderWidth($width)   X-Ref
Returns the border width from CSS property

param: $width (string) border width
return: int with in user units

getCSSBorderDashStyle($style)   X-Ref
Returns the border dash style from CSS property

param: $style (string) border style to convert
return: int sash style (return -1 in case of none or hidden border)

getCSSBorderStyle($cssborder)   X-Ref
Returns the border style array from CSS border properties

param: $cssborder (string) border properties
return: array containing border properties

getCSSPadding($csspadding, $width=0)   X-Ref
Get the internal Cell padding from CSS attribute.

param: $csspadding (string) padding properties
param: $width (float) width of the containing element
return: array of cell paddings

getCSSMargin($cssmargin, $width=0)   X-Ref
Get the internal Cell margin from CSS attribute.

param: $cssmargin (string) margin properties
param: $width (float) width of the containing element
return: array of cell margins

getCSSBorderMargin($cssbspace, $width=0)   X-Ref
Get the border-spacing from CSS attribute.

param: $cssbspace (string) border-spacing CSS properties
param: $width (float) width of the containing element
return: array of border spacings

getCSSFontSpacing($spacing, $parent=0)   X-Ref
Returns the letter-spacing value from CSS value

param: $spacing (string) letter-spacing value
param: $parent (float) font spacing (tracking) value of the parent element
return: float quantity to increases or decreases the space between characters in a text.

getCSSFontStretching($stretch, $parent=100)   X-Ref
Returns the percentage of font stretching from CSS value

param: $stretch (string) stretch mode
param: $parent (float) stretch value of the parent element
return: float font stretching percentage

getHTMLFontUnits($val, $refsize=12, $parent_size=12, $defaultunit='pt')   X-Ref
Convert HTML string containing font size value to points

param: $val (string) String containing font size value and unit.
param: $refsize (float) Reference font size in points.
param: $parent_size (float) Parent font size in points.
param: $defaultunit (string) Default unit (can be one of the following: %, em, ex, px, in, mm, pc, pt).
return: float value in points

getHtmlDomArray($html)   X-Ref
Returns the HTML DOM array.

param: $html (string) html code
return: array

getSpaceString()   X-Ref
Returns the string used to find spaces

author: Nicola Asuni
return: string

getHashForTCPDFtagParams($data)   X-Ref
Return an hash code used to ensure that the serialized data has been generated by this TCPDF instance.

param: $data (string) serialized data
return: string

serializeTCPDFtagParameters($data)   X-Ref
Serialize an array of parameters to be used with TCPDF tag in HTML code.

param: $data (array) parameters array
return: string containing serialized data

unserializeTCPDFtagParameters($data)   X-Ref
Unserialize parameters to be used with TCPDF tag in HTML code.

param: $data (string) serialized data
return: array containing unserialized data

writeHTMLCell($w, $h, $x, $y, $html='', $border=0, $ln=0, $fill=false, $reseth=true, $align='', $autopadding=true)   X-Ref
Prints a cell (rectangular area) with optional borders, background color and html text string.
The upper-left corner of the cell corresponds to the current position. After the call, the current position moves to the right or to the next line.<br />
If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
IMPORTANT: The HTML must be well formatted - try to clean-up it using an application like HTML-Tidy before submitting.
Supported tags are: a, b, blockquote, br, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, img, li, ol, p, pre, small, span, strong, sub, sup, table, tcpdf, td, th, thead, tr, tt, u, ul
NOTE: all the HTML attributes must be enclosed in double-quote.

param: $w (float) Cell width. If 0, the cell extends up to the right margin.
param: $h (float) Cell minimum height. The cell extends automatically if needed.
param: $x (float) upper-left corner X coordinate
param: $y (float) upper-left corner Y coordinate
param: $html (string) html text to print. Default value: empty string.
param: $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
param: $ln (int) Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right (or left for RTL language)</li><li>1: to the beginning of the next line</li><li>2: below</li></ul>
param: $fill (boolean) Indicates if the cell background must be painted (true) or transparent (false).
param: $reseth (boolean) if true reset the last cell height (default true).
param: $align (string) Allows to center or align the text. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul>
param: $autopadding (boolean) if true, uses internal padding and automatically adjust it to account for line width.

writeHTML($html, $ln=true, $fill=false, $reseth=false, $cell=false, $align='')   X-Ref
Allows to preserve some HTML formatting (limited support).<br />
IMPORTANT: The HTML must be well formatted - try to clean-up it using an application like HTML-Tidy before submitting.
Supported tags are: a, b, blockquote, br, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, img, li, ol, p, pre, small, span, strong, sub, sup, table, tcpdf, td, th, thead, tr, tt, u, ul
NOTE: all the HTML attributes must be enclosed in double-quote.

param: $html (string) text to display
param: $ln (boolean) if true add a new line after text (default = true)
param: $fill (boolean) Indicates if the background must be painted (true) or transparent (false).
param: $reseth (boolean) if true reset the last cell height (default false).
param: $cell (boolean) if true add the current left (or right for RTL) padding to each Write (default false).
param: $align (string) Allows to center or align the text. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul>

openHTMLTagHandler($dom, $key, $cell)   X-Ref
Process opening tags.

param: $dom (array) html dom array
param: $key (int) current element id
param: $cell (boolean) if true add the default left (or right if RTL) padding to each new line (default false).
return: $dom array

closeHTMLTagHandler($dom, $key, $cell, $maxbottomliney=0)   X-Ref
Process closing tags.

param: $dom (array) html dom array
param: $key (int) current element id
param: $cell (boolean) if true add the default left (or right if RTL) padding to each new line (default false).
param: $maxbottomliney (int) maximum y value of current line
return: $dom array

addHTMLVertSpace($hbz=0, $hb=0, $cell=false, $firsttag=false, $lasttag=false)   X-Ref
Add vertical spaces if needed.

param: $hbz (string) Distance between current y and line bottom.
param: $hb (string) The height of the break.
param: $cell (boolean) if true add the default left (or right if RTL) padding to each new line (default false).
param: $firsttag (boolean) set to true when the tag is the first.
param: $lasttag (boolean) set to true when the tag is the last.

getBorderStartPosition()   X-Ref
Return the starting coordinates to draw an html border

return: array containing top-left border coordinates

drawHTMLTagBorder($tag, $xmax)   X-Ref
Draw an HTML block border and fill

param: $tag (array) array of tag properties.
param: $xmax (int) end X coordinate for border.

setLIsymbol($symbol='!')   X-Ref
Set the default bullet to be used as LI bullet symbol

param: $symbol (string) character or string to be used (legal values are: '' = automatic, '!' = auto bullet, '#' = auto numbering, 'disc', 'disc', 'circle', 'square', '1', 'decimal', 'decimal-leading-zero', 'i', 'lower-roman', 'I', 'upper-roman', 'a', 'lower-alpha', 'lower-latin', 'A', 'upper-alpha', 'upper-latin', 'lower-greek', 'img|type|width|height|image.ext')

SetBooklet($booklet=true, $inner=-1, $outer=-1)   X-Ref
Set the booklet mode for double-sided pages.

param: $booklet (boolean) true set the booklet mode on, false otherwise.
param: $inner (float) Inner page margin.
param: $outer (float) Outer page margin.

swapMargins($reverse=true)   X-Ref
Swap the left and right margins.

param: $reverse (boolean) if true swap left and right margins.

setHtmlVSpace($tagvs)   X-Ref
Set the vertical spaces for HTML tags.
The array must have the following structure (example):
$tagvs = array('h1' => array(0 => array('h' => '', 'n' => 2), 1 => array('h' => 1.3, 'n' => 1)));
The first array level contains the tag names,
the second level contains 0 for opening tags or 1 for closing tags,
the third level contains the vertical space unit (h) and the number spaces to add (n).
If the h parameter is not specified, default values are used.

param: $tagvs (array) array of tags and relative vertical spaces.

setListIndentWidth($width)   X-Ref
Set custom width for list indentation.

param: $width (float) width of the indentation. Use negative value to disable it.

setOpenCell($isopen)   X-Ref
Set the top/bottom cell sides to be open or closed when the cell cross the page.

param: $isopen (boolean) if true keeps the top/bottom border open for the cell sides that cross the page.

setHtmlLinksStyle($color=array(0,0,255)   X-Ref
Set the color and font style for HTML links.

param: $color (array) RGB array of colors
param: $fontstyle (string) additional font styles to add

getHTMLUnitToUnits($htmlval, $refsize=1, $defaultunit='px', $points=false)   X-Ref
Convert HTML string containing value and unit of measure to user's units or points.

param: $htmlval (string) String containing values and unit.
param: $refsize (string) Reference value in points.
param: $defaultunit (string) Default unit (can be one of the following: %, em, ex, px, in, mm, pc, pt).
param: $points (boolean) If true returns points, otherwise returns value in user's units.
return: float value in user's unit or point if $points=true

putHtmlListBullet($listdepth, $listtype='', $size=10)   X-Ref
Output an HTML list bullet or ordered item symbol

param: $listdepth (int) list nesting level
param: $listtype (string) type of list
param: $size (float) current font size

getGraphicVars()   X-Ref
Returns current graphic variables as array.

return: array of graphic variables

setGraphicVars($gvars, $extended=false)   X-Ref
Set graphic variables.

param: $gvars (array) array of graphic variablesto restore
param: $extended (boolean) if true restore extended graphic variables

_outSaveGraphicsState()   X-Ref
Outputs the "save graphics state" operator 'q'


_outRestoreGraphicsState()   X-Ref
Outputs the "restore graphics state" operator 'Q'


setBuffer($data)   X-Ref
Set buffer content (always append data).

param: $data (string) data

replaceBuffer($data)   X-Ref
Replace the buffer content

param: $data (string) data

getBuffer()   X-Ref
Get buffer content.

return: string buffer content

setPageBuffer($page, $data, $append=false)   X-Ref
Set page buffer content.

param: $page (int) page number
param: $data (string) page data
param: $append (boolean) if true append data, false replace.

getPageBuffer($page)   X-Ref
Get page buffer content.

param: $page (int) page number
return: string page buffer content or false in case of error

setImageBuffer($image, $data)   X-Ref
Set image buffer content.

param: $image (string) image key
param: $data (array) image data
return: int image index number

setImageSubBuffer($image, $key, $data)   X-Ref
Set image buffer content for a specified sub-key.

param: $image (string) image key
param: $key (string) image sub-key
param: $data (array) image data

getImageBuffer($image)   X-Ref
Get image buffer content.

param: $image (string) image key
return: string image buffer content or false in case of error

setFontBuffer($font, $data)   X-Ref
Set font buffer content.

param: $font (string) font key
param: $data (array) font data

setFontSubBuffer($font, $key, $data)   X-Ref
Set font buffer content.

param: $font (string) font key
param: $key (string) font sub-key
param: $data (array) font data

getFontBuffer($font)   X-Ref
Get font buffer content.

param: $font (string) font key
return: string font buffer content or false in case of error

movePage($frompage, $topage)   X-Ref
Move a page to a previous position.

param: $frompage (int) number of the source page
param: $topage (int) number of the destination page (must be less than $frompage)
return: true in case of success, false in case of error.

deletePage($page)   X-Ref
Remove the specified page.

param: $page (int) page to remove
return: true in case of success, false in case of error.

copyPage($page=0)   X-Ref
Clone the specified page to a new page.

param: $page (int) number of page to copy (0 = current page)
return: true in case of success, false in case of error.

addTOC($page='', $numbersfont='', $filler='.', $toc_name='TOC', $style='', $color=array(0,0,0)   X-Ref
Output a Table of Content Index (TOC).
This method must be called after all Bookmarks were set.
Before calling this method you have to open the page using the addTOCPage() method.
After calling this method you have to call endTOCPage() to close the TOC page.
You can override this method to achieve different styles.

param: $page (int) page number where this TOC should be inserted (leave empty for current page).
param: $numbersfont (string) set the font for page numbers (please use monospaced font for better alignment).
param: $filler (string) string used to fill the space between text and page number.
param: $toc_name (string) name to use for TOC bookmark.
param: $style (string) Font style for title: B = Bold, I = Italic, BI = Bold + Italic.
param: $color (array) RGB color array for bookmark title (values from 0 to 255).
author: Nicola Asuni

addHTMLTOC($page='', $toc_name='TOC', $templates=array()   X-Ref
Output a Table Of Content Index (TOC) using HTML templates.
This method must be called after all Bookmarks were set.
Before calling this method you have to open the page using the addTOCPage() method.
After calling this method you have to call endTOCPage() to close the TOC page.

param: $page (int) page number where this TOC should be inserted (leave empty for current page).
param: $toc_name (string) name to use for TOC bookmark.
param: $templates (array) array of html templates. Use: "#TOC_DESCRIPTION#" for bookmark title, "#TOC_PAGE_NUMBER#" for page number.
param: $correct_align (boolean) if true correct the number alignment (numbers must be in monospaced font like courier and right aligned on LTR, or left aligned on RTL)
param: $style (string) Font style for title: B = Bold, I = Italic, BI = Bold + Italic.
param: $color (array) RGB color array for title (values from 0 to 255).
author: Nicola Asuni

startTransaction()   X-Ref
Stores a copy of the current TCPDF object used for undo operation.


commitTransaction()   X-Ref
Delete the copy of the current TCPDF object used for undo operation.


rollbackTransaction($self=false)   X-Ref
This method allows to undo the latest transaction by returning the latest saved TCPDF object with startTransaction().

param: $self (boolean) if true restores current class object to previous state without the need of reassignment via the returned value.
return: TCPDF object.

setEqualColumns($numcols=0, $width=0, $y='')   X-Ref
Set multiple columns of the same size

param: $numcols (int) number of columns (set to zero to disable columns mode)
param: $width (int) column width
param: $y (int) column starting Y position (leave empty for current Y position)

resetColumns()   X-Ref
Remove columns and reset page margins.


setColumnsArray($columns)   X-Ref
Set columns array.
Each column is represented by an array of arrays with the following keys: (w = width, s = space between columns, y = column top position).

param: $columns (array)

selectColumn($col='')   X-Ref
Set position at a given column

param: $col (int) column number (from 0 to getNumberOfColumns()-1); empty string = current column.

getColumn()   X-Ref
Return the current column number

return: int current column number

getNumberOfColumns()   X-Ref
Return the current number of columns.

return: int number of columns

setTextRenderingMode($stroke=0, $fill=true, $clip=false)   X-Ref
Set Text rendering mode.

param: $stroke (int) outline size in user units (0 = disable).
param: $fill (boolean) if true fills the text (default).
param: $clip (boolean) if true activate clipping mode

setTextShadow($params=array('enabled'=>false, 'depth_w'=>0, 'depth_h'=>0, 'color'=>false, 'opacity'=>1, 'blend_mode'=>'Normal')   X-Ref
Set parameters for drop shadow effect for text.

param: $params (array) Array of parameters: enabled (boolean) set to true to enable shadow; depth_w (float) shadow width in user units; depth_h (float) shadow height in user units; color (array) shadow color or false to use the stroke color; opacity (float) Alpha value: real value from 0 (transparent) to 1 (opaque); blend_mode (string) blend mode, one of the following: Normal, Multiply, Screen, Overlay, Darken, Lighten, ColorDodge, ColorBurn, HardLight, SoftLight, Difference, Exclusion, Hue, Saturation, Color, Luminosity.

getTextShadow()   X-Ref
Return the text shadow parameters array.

return: Array of parameters.

hyphenateWord($word, $patterns, $dictionary=array()   X-Ref
Returns an array of chars containing soft hyphens.

param: $word (array) array of chars
param: $patterns (array) Array of hypenation patterns.
param: $dictionary (array) Array of words to be returned without applying the hyphenation algorithm.
param: $leftmin (int) Minimum number of character to leave on the left of the word without applying the hyphens.
param: $rightmin (int) Minimum number of character to leave on the right of the word without applying the hyphens.
param: $charmin (int) Minimum word length to apply the hyphenation algorithm.
param: $charmax (int) Maximum length of broken piece of word.
author: Nicola Asuni
return: array text with soft hyphens

hyphenateText($text, $patterns, $dictionary=array()   X-Ref
Returns text with soft hyphens.

param: $text (string) text to process
param: $patterns (mixed) Array of hypenation patterns or a TEX file containing hypenation patterns. TEX patterns can be downloaded from http://www.ctan.org/tex-archive/language/hyph-utf8/tex/generic/hyph-utf8/patterns/
param: $dictionary (array) Array of words to be returned without applying the hyphenation algorithm.
param: $leftmin (int) Minimum number of character to leave on the left of the word without applying the hyphens.
param: $rightmin (int) Minimum number of character to leave on the right of the word without applying the hyphens.
param: $charmin (int) Minimum word length to apply the hyphenation algorithm.
param: $charmax (int) Maximum length of broken piece of word.
author: Nicola Asuni
return: array text with soft hyphens

setRasterizeVectorImages($mode)   X-Ref
Enable/disable rasterization of vector images using ImageMagick library.

param: $mode (boolean) if true enable rasterization, false otherwise.

setFontSubsetting($enable=true)   X-Ref
Enable or disable default option for font subsetting.

param: $enable (boolean) if true enable font subsetting by default.
author: Nicola Asuni

getFontSubsetting()   X-Ref
Return the default option for font subsetting.

author: Nicola Asuni
return: boolean default font subsetting state.

stringLeftTrim($str, $replace='')   X-Ref
Left trim the input string

param: $str (string) string to trim
param: $replace (string) string that replace spaces.
author: Nicola Asuni
return: left trimmed string

stringRightTrim($str, $replace='')   X-Ref
Right trim the input string

param: $str (string) string to trim
param: $replace (string) string that replace spaces.
author: Nicola Asuni
return: right trimmed string

stringTrim($str, $replace='')   X-Ref
Trim the input string

param: $str (string) string to trim
param: $replace (string) string that replace spaces.
author: Nicola Asuni
return: trimmed string

isUnicodeFont()   X-Ref
Return true if the current font is unicode type.

author: Nicola Asuni
return: true for unicode font, false otherwise.

getFontFamilyName($fontfamily)   X-Ref
Return normalized font name

param: $fontfamily (string) property string containing font family names
author: Nicola Asuni
return: string normalized font name

startTemplate($w=0, $h=0, $group=false)   X-Ref
Start a new XObject Template.
An XObject Template is a PDF block that is a self-contained description of any sequence of graphics objects (including path objects, text objects, and sampled images).
An XObject Template may be painted multiple times, either on several pages or at several locations on the same page and produces the same results each time, subject only to the graphics state at the time it is invoked.
Note: X,Y coordinates will be reset to 0,0.

param: $w (int) Template width in user units (empty string or zero = page width less margins).
param: $h (int) Template height in user units (empty string or zero = page height less margins).
param: $group (mixed) Set transparency group. Can be a boolean value or an array specifying optional parameters: 'CS' (solour space name), 'I' (boolean flag to indicate isolated group) and 'K' (boolean flag to indicate knockout group).
author: Nicola Asuni
return: int the XObject Template ID in case of success or false in case of error.

endTemplate()   X-Ref
End the current XObject Template started with startTemplate() and restore the previous graphic state.
An XObject Template is a PDF block that is a self-contained description of any sequence of graphics objects (including path objects, text objects, and sampled images).
An XObject Template may be painted multiple times, either on several pages or at several locations on the same page and produces the same results each time, subject only to the graphics state at the time it is invoked.

author: Nicola Asuni
return: int the XObject Template ID in case of success or false in case of error.

printTemplate($id, $x='', $y='', $w=0, $h=0, $align='', $palign='', $fitonpage=false)   X-Ref
Print an XObject Template.
You can print an XObject Template inside the currently opened Template.
An XObject Template is a PDF block that is a self-contained description of any sequence of graphics objects (including path objects, text objects, and sampled images).
An XObject Template may be painted multiple times, either on several pages or at several locations on the same page and produces the same results each time, subject only to the graphics state at the time it is invoked.

param: $id (string) The ID of XObject Template to print.
param: $x (int) X position in user units (empty string = current x position)
param: $y (int) Y position in user units (empty string = current y position)
param: $w (int) Width in user units (zero = remaining page width)
param: $h (int) Height in user units (zero = remaining page height)
param: $align (string) Indicates the alignment of the pointer next to template insertion relative to template height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul>
param: $palign (string) Allows to center or align the template on the current line. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul>
param: $fitonpage (boolean) If true the template is resized to not exceed page dimensions.
author: Nicola Asuni

setFontStretching($perc=100)   X-Ref
Set the percentage of character stretching.

param: $perc (int) percentage of stretching (100 = no stretching)
author: Nicola Asuni

getFontStretching()   X-Ref
Get the percentage of character stretching.

author: Nicola Asuni
return: float stretching value

setFontSpacing($spacing=0)   X-Ref
Set the amount to increase or decrease the space between characters in a text.

param: $spacing (float) amount to increase or decrease the space between characters in a text (0 = default spacing)
author: Nicola Asuni

getFontSpacing()   X-Ref
Get the amount to increase or decrease the space between characters in a text.

author: Nicola Asuni
return: int font spacing (tracking) value

getPageRegions()   X-Ref
Return an array of no-write page regions

author: Nicola Asuni
return: array of no-write page regions

setPageRegions($regions=array()   X-Ref
Set no-write regions on page.
A no-write region is a portion of the page with a rectangular or trapezium shape that will not be covered when writing text or html code.
A region is always aligned on the left or right side of the page ad is defined using a vertical segment.
You can set multiple regions for the same page.

param: $regions (array) array of no-write regions. For each region you can define an array as follow: ('page' => page number or empy for current page, 'xt' => X top, 'yt' => Y top, 'xb' => X bottom, 'yb' => Y bottom, 'side' => page side 'L' = left or 'R' = right). Omit this parameter to remove all regions.
author: Nicola Asuni

addPageRegion($region)   X-Ref
Add a single no-write region on selected page.
A no-write region is a portion of the page with a rectangular or trapezium shape that will not be covered when writing text or html code.
A region is always aligned on the left or right side of the page ad is defined using a vertical segment.
You can set multiple regions for the same page.

param: $region (array) array of a single no-write region array: ('page' => page number or empy for current page, 'xt' => X top, 'yt' => Y top, 'xb' => X bottom, 'yb' => Y bottom, 'side' => page side 'L' = left or 'R' = right).
author: Nicola Asuni

removePageRegion($key)   X-Ref
Remove a single no-write region.

param: $key (int) region key
author: Nicola Asuni

checkPageRegions($h, $x, $y)   X-Ref
Check page for no-write regions and adapt current coordinates and page margins if necessary.
A no-write region is a portion of the page with a rectangular or trapezium shape that will not be covered when writing text or html code.
A region is always aligned on the left or right side of the page ad is defined using a vertical segment.

param: $h (float) height of the text/image/object to print in user units
param: $x (float) current X coordinate in user units
param: $y (float) current Y coordinate in user units
author: Nicola Asuni
return: array($x, $y)

ImageSVG($file, $x='', $y='', $w=0, $h=0, $link='', $align='', $palign='', $border=0, $fitonpage=false)   X-Ref
Embedd a Scalable Vector Graphics (SVG) image.
NOTE: SVG standard is not yet fully implemented, use the setRasterizeVectorImages() method to enable/disable rasterization of vector images using ImageMagick library.

param: $file (string) Name of the SVG file or a '@' character followed by the SVG data string.
param: $x (float) Abscissa of the upper-left corner.
param: $y (float) Ordinate of the upper-left corner.
param: $w (float) Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
param: $h (float) Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
param: $link (mixed) URL or identifier returned by AddLink().
param: $align (string) Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul> If the alignment is an empty string, then the pointer will be restored on the starting SVG position.
param: $palign (string) Allows to center or align the image on the current line. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul>
param: $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
param: $fitonpage (boolean) if true the image is resized to not exceed page dimensions.
author: Nicola Asuni

convertSVGtMatrix($tm)   X-Ref
Convert SVG transformation matrix to PDF.

param: $tm (array) original SVG transformation matrix
return: array transformation matrix

SVGTransform($tm)   X-Ref
Apply SVG graphic transformation matrix.

param: $tm (array) original SVG transformation matrix

setSVGStyles($svgstyle, $prevsvgstyle, $x=0, $y=0, $w=1, $h=1, $clip_function='', $clip_params=array()   X-Ref
Apply the requested SVG styles (*** TO BE COMPLETED ***)

param: $svgstyle (array) array of SVG styles to apply
param: $prevsvgstyle (array) array of previous SVG style
param: $x (int) X origin of the bounding box
param: $y (int) Y origin of the bounding box
param: $w (int) width of the bounding box
param: $h (int) height of the bounding box
param: $clip_function (string) clip function
param: $clip_params (array) array of parameters for clipping function
author: Nicola Asuni
return: object style

SVGPath($d, $style='')   X-Ref
Draws an SVG path

param: $d (string) attribute d of the path SVG element
param: $style (string) Style of rendering. Possible values are:
author: Nicola Asuni
return: array of container box measures (x, y, w, h)

removeTagNamespace($name)   X-Ref
Return the tag name without the namespace

param: $name (string) Tag name

startSVGElementHandler($parser, $name, $attribs, $ctm=array()   X-Ref
Sets the opening SVG element handler function for the XML parser. (*** TO BE COMPLETED ***)

param: $parser (resource) The first parameter, parser, is a reference to the XML parser calling the handler.
param: $name (string) The second parameter, name, contains the name of the element for which this handler is called. If case-folding is in effect for this parser, the element name will be in uppercase letters.
param: $attribs (array) The third parameter, attribs, contains an associative array with the element's attributes (if any). The keys of this array are the attribute names, the values are the attribute values. Attribute names are case-folded on the same criteria as element names. Attribute values are not case-folded. The original order of the attributes can be retrieved by walking through attribs the normal way, using each(). The first key in the array was the first attribute, and so on.
param: $ctm (array) tranformation matrix for clipping mode (starting transformation matrix).
author: Nicola Asuni

endSVGElementHandler($parser, $name)   X-Ref
Sets the closing SVG element handler function for the XML parser.

param: $parser (resource) The first parameter, parser, is a reference to the XML parser calling the handler.
param: $name (string) The second parameter, name, contains the name of the element for which this handler is called. If case-folding is in effect for this parser, the element name will be in uppercase letters.
author: Nicola Asuni

segSVGContentHandler($parser, $data)   X-Ref
Sets the character data handler function for the XML parser.

param: $parser (resource) The first parameter, parser, is a reference to the XML parser calling the handler.
param: $data (string) The second parameter, data, contains the character data as a string.
author: Nicola Asuni