Index
A
- $ TCPDF#autopagebreak — Property in class TCPDF
Automatic page break flag.
- $ TCPDF#alpha — Property in class TCPDF
- TCPDF::ambientPageContent() — Method in class TCPDF
Raw PDF operators for the ambient text state that must open every page content stream: the engine re-emits the current font (carrying its spacing/stretching) when it adds a page, so the facade only needs to carry the legacy text color across page breaks.
- TCPDF::advanceToNextPage() — Method in class TCPDF
Move to the top of the next page for an automatic break, reusing an already-created page when one exists.
- TCPDF::applyHtmlTextShadow() — Method in class TCPDF
Emulate the legacy text shadow for engine-rendered HTML content.
- TCPDF::attachLink() — Method in class TCPDF
Register an external link annotation for the given rectangle.
- TCPDF::applyBookmarkDisplayMode() — Method in class TCPDF
Match legacy TCPDF: when bookmark outlines are present the document opens with the outline (bookmark) panel visible (/PageMode /UseOutlines).
- TCPDF::addTOCPage() — Method in class TCPDF
- TCPDF::AddPage() — Method in class TCPDF
- TCPDF::AddSpotColor() — Method in class TCPDF
- TCPDF::AddFont() — Method in class TCPDF
- TCPDF::AddLink() — Method in class TCPDF
- TCPDF::Annotation() — Method in class TCPDF
- TCPDF::AcceptPageBreak() — Method in class TCPDF
- TCPDF::addHtmlLink() — Method in class TCPDF
- TCPDF::Arrow() — Method in class TCPDF
- TCPDF::addJavascriptObject() — Method in class TCPDF
- TCPDF::attachAnnotRef() — Method in class TCPDF
Attach a freshly created annotation/form-field widget to the current page so the engine emits it in the page's /Annots array.
- TCPDF::advanceFormFieldX() — Method in class TCPDF
Advance the horizontal cursor after placing a form field, matching the legacy behaviour where each field method shifts the current X position by the field width (RTL-aware). The shift is applied to the live cursor regardless of any explicit x/y override, exactly as legacy TCPDF does.
- TCPDF::addEmptySignatureAppearance() — Method in class TCPDF
- TCPDF::advanceAfterBarcode() — Method in class TCPDF
Advance the cursor next to a drawn barcode for the legacy $align value.
- TCPDF::absolutizeMarkupPath() — Method in class TCPDF
Make a relative local markup resource path absolute.
- TCPDF::addTOC() — Method in class TCPDF
- TCPDF::addHTMLTOC() — Method in class TCPDF
- TCPDF::addPageRegion() — Method in class TCPDF
- TCPDF::applyNoWriteRegionsForFlow() — Method in class TCPDF
(Re)build the engine banded writable regions for the current page from its legacy no-write areas, using $bandheight as the height of each horizontal slice, then select the region that contains the current Y so the flow starts at the cursor and hugs the obstacles band by band. The text/HTML engine then advances region -> region -> fresh full-width page on its own.
- TCPDF_ENGINE::anchorPageRegionsToContentTop() — Method in class TCPDF_ENGINE
Anchor the page regions (columns) at the content top margin.
B
- $ TCPDF#bmargin — Property in class TCPDF
Page-break bottom margin in user units.
- $ TCPDF#bookletmode — Property in class TCPDF
Booklet mode flag.
- TCPDF::buildPageData() — Method in class TCPDF
Build the engine page data array for a new page.
- TCPDF::breakIfNeeded() — Method in class TCPDF
Trigger an automatic page break when the given height does not fit.
- TCPDF::Bookmark() — Method in class TCPDF
- TCPDF::Button() — Method in class TCPDF
- TCPDF::barcodeBoxX() — Method in class TCPDF
Left edge of a barcode box for the legacy position keyword (L/C/R or the current abscissa for the empty/default case).
- TCPDF::barcodeBox() — Method in class TCPDF
Background fill and/or border around a barcode box.
C
- $ TCPDF#charencoding — Property in class TCPDF
Document encoding (only 'UTF-8' is supported by the engine).
- $ TCPDF#curorientation — Property in class TCPDF
Current page orientation.
- $ TCPDF#curformat — Property in class TCPDF
Current page format.
- $ TCPDF#cellheightratio — Property in class TCPDF
Cell height ratio (line height = font size * ratio).
- $ TCPDF#cellpadding — Property in class TCPDF
- $ TCPDF#cellmargin — Property in class TCPDF
- TCPDF::colorSpecFromLegacy() — Method in class TCPDF
Convert a legacy color definition (component list or array) to an engine color specification string.
- TCPDF::colorSpecFromComponents() — Method in class TCPDF
Convert legacy color components (setColor-style) to a spec string.
- TCPDF::currentLineStyle() — Method in class TCPDF
Current line style as an engine style array (lineWidth, lineColor, ...).
- TCPDF::coordOrCursor() — Method in class TCPDF
Resolve a legacy optional coordinate ('' or null means current position).
- TCPDF::completeSideStyles() — Method in class TCPDF
Complete partial per-side styles with the current graph style defaults (the engine HTML renderer requires fully-populated style arrays).
- TCPDF::cellCalignShift() — Method in class TCPDF
Legacy $calign cell vertical alignment: the amount (user units) by which the cell box top is shifted UP relative to the current text line. The font-relative modes (A/L/D) depend on $valign, mirroring getCellCode().
- TCPDF::cellBBoxCount() — Method in class TCPDF
Number of entries currently on the engine cell bounding-box stack.
- TCPDF::cellBBoxBottomSince() — Method in class TCPDF
Lowest bottom edge (user units) among the cell bounding boxes pushed on the engine stack after the given index.
- TCPDF::cellBoxOutput() — Method in class TCPDF
PDF code for a cell background fill and the requested border sides.
- TCPDF::Close() — Method in class TCPDF
- TCPDF::Cell() — Method in class TCPDF
- TCPDF::currentFontMetric() — Method in class TCPDF
Return the current font metric array (inserting the default when missing).
- TCPDF::Curve() — Method in class TCPDF
- TCPDF::Circle() — Method in class TCPDF
- TCPDF::ComboBox() — Method in class TCPDF
- TCPDF::CheckBox() — Method in class TCPDF
- TCPDF::colorRegistrationBar() — Method in class TCPDF
- TCPDF::cropMark() — Method in class TCPDF
- TCPDF::CoonsPatchMesh() — Method in class TCPDF
- TCPDF::coonsPatchArray() — Method in class TCPDF
Convert a legacy Coons patch-mesh array (per-patch 'f', 'points', and 'colors' with 0-255 r/g/b keys) to the engine shape (normalized red/green/blue floats).
- TCPDF::cssBoxValues() — Method in class TCPDF
Parse a CSS shorthand box value (top right bottom left) into user units.
- TCPDF::cssSafeMarkupPath() — Method in class TCPDF
Return a markup resource path that survives CSS lowercasing.
- TCPDF::copyPage() — Method in class TCPDF
- TCPDF::commitTransaction() — Method in class TCPDF
- TCPDF::currentPageNoWriteAreas() — Method in class TCPDF
The legacy no-write areas registered for the current page, in the engine setNoWriteRegions() input format (xt/yt/xb/yb/side).
D
- $ TCPDF#docunit — Property in class TCPDF
Unit of measure ('pt', 'mm', 'cm', 'in').
- $ TCPDF#deforientation — Property in class TCPDF
Default page orientation ('P' or 'L').
- $ TCPDF#defformat — Property in class TCPDF
Default page format (format name string or [width, height] in user units).
- $ TCPDF#docstate — Property in class TCPDF
Document state: 0 = not started, 1 = open, 2 = has pages, 3 = closed.
- $ TCPDF#drawcolorspec — Property in class TCPDF
Draw (stroke) color: engine color specification string.
- $ TCPDF#drawcolorlegacy — Property in class TCPDF
- $ TCPDF#decortotalpages — Property in class TCPDF
Total number of pages, available while rendering deferred decorations.
- $ TCPDF#docbarcode — Property in class TCPDF
Document barcode string (printed in the footer when set).
- $ TCPDF#doctimestamps — Property in class TCPDF
- $ TCPDF#displaymode — Property in class TCPDF
- TCPDF::drawHtmlCellSegments() — Method in class TCPDF
Draw the per-page border/fill segments of an auto-height HTML cell that flowed across pages (the engine skips the cell box in that case).
- TCPDF::decorateAllPages() — Method in class TCPDF
Render the deferred page decorations (headers and footers) on every page. Called once when the document is closed: at that time the total page count is known, so the default footer can print real numbers.
- TCPDF::drawBarcode1D() — Method in class TCPDF
Render a 1D barcode with the legacy geometry: bars, the optional human-readable label and the vertical padding all fit inside the requested height (barh = height - text_height - 2*vpadding) instead of the label being appended below it. Bar drawing is delegated to the engine; the box, label and cursor advance mirror write1DBarcode().
- TCPDF::drawBarcode2D() — Method in class TCPDF
Render a 2D barcode with the legacy geometry: the barcode cells are inset inside the requested box by the (auto) padding quiet-zone and the aspect ratio is preserved unless $distort is set. Mirrors write2DBarcode().
- TCPDF::deletePage() — Method in class TCPDF
E
- $ TCPDF#eng — Property in class TCPDF
The tc-lib-pdf engine that renders the actual document.
- TCPDF::engineInit() — Method in class TCPDF
Create (or re-create) the tc-lib-pdf engine for the given unit.
- TCPDF::engine() — Method in class TCPDF
Return the engine instance.
- TCPDF::emitToPage() — Method in class TCPDF
Append raw PDF content to the current page (no-op when no page exists).
- TCPDF::engineOutlines() — Method in class TCPDF
Bookmark outline entries collected by the engine.
- TCPDF::engineShadow() — Method in class TCPDF
Current engine text shadow array (or null when disabled).
- TCPDF::Error() — Method in class TCPDF
- TCPDF::endTOCPage() — Method in class TCPDF
- TCPDF::endPage() — Method in class TCPDF
- TCPDF::EmbedFile() — Method in class TCPDF
- TCPDF::EmbedFileFromString() — Method in class TCPDF
- TCPDF::Ellipse() — Method in class TCPDF
- TCPDF::endLayer() — Method in class TCPDF
- TCPDF::emitBarcode() — Method in class TCPDF
Render a barcode at the given position via the engine.
- TCPDF::equalColumnRegions() — Method in class TCPDF
Legacy equal-column geometry: the requested width is capped to an even share of the content width and the remainder becomes the inter-column gutters.
- TCPDF::endTemplate() — Method in class TCPDF
F
- $ TCPDF#fontfamily — Property in class TCPDF
Current font family (normalized lowercase).
- $ TCPDF#fontstyle — Property in class TCPDF
Current font style letters (subset of 'B', 'I').
- $ TCPDF#fontdecor — Property in class TCPDF
- $ TCPDF#fontsizept — Property in class TCPDF
Current font size in points.
- $ TCPDF#fontmetric — Property in class TCPDF
- $ TCPDF#fontsubsetting — Property in class TCPDF
Default font subsetting mode for setFont (legacy default: true).
- $ TCPDF#fontspacing — Property in class TCPDF
Extra font spacing (user units) applied via the engine font stack.
- $ TCPDF#fontstretching — Property in class TCPDF
Font stretching percentage (100 = none).
- $ TCPDF#fillcolorspec — Property in class TCPDF
Fill color: engine color specification string.
- $ TCPDF#fillcolorlegacy — Property in class TCPDF
- $ TCPDF#footerdata — Property in class TCPDF
- $ TCPDF#footermargin — Property in class TCPDF
Footer margin (minimum distance between footer and bottom page margin).
- $ TCPDF#footerfont — Property in class TCPDF
- $ TCPDF#formdefaultprop — Property in class TCPDF
- TCPDF::fileAllowedPaths() — Method in class TCPDF
Local paths the engine may read files from. The legacy API loaded images and fonts from application-relative locations, so in addition to the engine defaults this allows the configured TCPDF paths, the current working directory and the running script directory.
- TCPDF::fileOptions() — Method in class TCPDF
Assemble the file-access options handed to the engine's shared file helper (tc-lib-file). These drive the upstream security sandbox that governs which local paths and remote hosts external resources (images, fonts, SVG, ...) may be loaded from.
- TCPDF::forcedTextDir() — Method in class TCPDF
Forced text direction for the engine ('' = inherit document direction).
- TCPDF::Footer() — Method in class TCPDF
- TCPDF::formFieldValues() — Method in class TCPDF
Normalize legacy list/combo values: either a list of strings or a list of [export, display] pairs (the engine requires a homogeneous list).
- TCPDF::formFieldOptions() — Method in class TCPDF
Normalize legacy form-field (prop, opt) pairs for the engine.
- TCPDF::fitBarcodeBlock() — Method in class TCPDF
Move to the next page when a barcode of the given height would not fit below the current Y, preserving the abscissa. Returns the Y to draw at.
- TCPDF::fixHTMLCode() — Method in class TCPDF
G
- TCPDF::getRTL() — Method in class TCPDF
- TCPDF::getCellHeight() — Method in class TCPDF
Return the cell height for the given font size.
- TCPDF::getLastH() — Method in class TCPDF
- TCPDF::getImageScale() — Method in class TCPDF
- TCPDF::getPageDimensions() — Method in class TCPDF
- TCPDF::getPageWidth() — Method in class TCPDF
Return the page width in user units.
- TCPDF::getPageHeight() — Method in class TCPDF
Return the page height in user units.
- TCPDF::getBreakMargin() — Method in class TCPDF
Return the automatic page-break bottom margin.
- TCPDF::getScaleFactor() — Method in class TCPDF
- TCPDF::getCellPaddings() — Method in class TCPDF
- TCPDF::getCellMargins() — Method in class TCPDF
- TCPDF::getAutoPageBreak() — Method in class TCPDF
- TCPDF::getPage() — Method in class TCPDF
- TCPDF::getNumPages() — Method in class TCPDF
- TCPDF::getHeaderData() — Method in class TCPDF
- TCPDF::getHeaderMargin() — Method in class TCPDF
- TCPDF::getFooterMargin() — Method in class TCPDF
- TCPDF::getImageRBX() — Method in class TCPDF
- TCPDF::getImageRBY() — Method in class TCPDF
- TCPDF::getAllSpotColors() — Method in class TCPDF
- TCPDF::GetStringWidth() — Method in class TCPDF
Return the length of a string in user units.
- TCPDF::GetArrStringWidth() — Method in class TCPDF
Return the width of a character array in user units.
- TCPDF::GetCharWidth() — Method in class TCPDF
- TCPDF::getRawCharWidth() — Method in class TCPDF
- TCPDF::GetNumChars() — Method in class TCPDF
- TCPDF::getFontBBox() — Method in class TCPDF
- TCPDF::getAbsFontMeasure() — Method in class TCPDF
- TCPDF::getCharBBox() — Method in class TCPDF
- TCPDF::getFontDescent() — Method in class TCPDF
- TCPDF::getFontAscent() — Method in class TCPDF
- TCPDF::getNumLines() — Method in class TCPDF
Estimate the number of lines needed to print the given text.
- TCPDF::getStringHeight() — Method in class TCPDF
- TCPDF::GetX() — Method in class TCPDF
- TCPDF::GetAbsX() — Method in class TCPDF
- TCPDF::GetY() — Method in class TCPDF
- TCPDF::getPDFData() — Method in class TCPDF
- TCPDF::getDocCreationTimestamp() — Method in class TCPDF
- TCPDF::getDocModificationTimestamp() — Method in class TCPDF
- TCPDF::getHeaderFont() — Method in class TCPDF
- TCPDF::getFooterFont() — Method in class TCPDF
- TCPDF::GetLineWidth() — Method in class TCPDF
- TCPDF::getDestination() — Method in class TCPDF
- TCPDF::getFormDefaultProp() — Method in class TCPDF
- TCPDF::getAliasRightShift() — Method in class TCPDF
- TCPDF::getAliasNbPages() — Method in class TCPDF
- TCPDF::getAliasNumPage() — Method in class TCPDF
- TCPDF::getPageGroupAlias() — Method in class TCPDF
- TCPDF::getPageNumGroupAlias() — Method in class TCPDF
- TCPDF::getGroupPageNo() — Method in class TCPDF
- TCPDF::getGroupPageNoFormatted() — Method in class TCPDF
- TCPDF::getOverprint() — Method in class TCPDF
- TCPDF::getAlpha() — Method in class TCPDF
- TCPDF::getCellHeightRatio() — Method in class TCPDF
- TCPDF::Gradient() — Method in class TCPDF
- TCPDF::getBarcode() — Method in class TCPDF
- TCPDF::getMargins() — Method in class TCPDF
- TCPDF::getOriginalMargins() — Method in class TCPDF
- TCPDF::getFontSize() — Method in class TCPDF
- TCPDF::getFontSizePt() — Method in class TCPDF
- TCPDF::getFontFamily() — Method in class TCPDF
- TCPDF::getFontStyle() — Method in class TCPDF
- TCPDF::getCSSPadding() — Method in class TCPDF
- TCPDF::getCSSMargin() — Method in class TCPDF
- TCPDF::getCSSBorderMargin() — Method in class TCPDF
- TCPDF::getHTMLFontUnits() — Method in class TCPDF
- TCPDF::getHTMLUnitToUnits() — Method in class TCPDF
- TCPDF::getColumn() — Method in class TCPDF
- TCPDF::getNumberOfColumns() — Method in class TCPDF
- TCPDF::getTextShadow() — Method in class TCPDF
- TCPDF::getFontSubsetting() — Method in class TCPDF
- TCPDF::getFontFamilyName() — Method in class TCPDF
- TCPDF::getFontStretching() — Method in class TCPDF
- TCPDF::getFontSpacing() — Method in class TCPDF
- TCPDF::getPageRegions() — Method in class TCPDF
H
- $ TCPDF#headerdata — Property in class TCPDF
- $ TCPDF#headermargin — Property in class TCPDF
Header margin (minimum distance between header and top page margin).
- $ TCPDF#headerfont — Property in class TCPDF
- $ TCPDF#htmllinkcolor — Property in class TCPDF
- $ TCPDF#htmllinkstyle — Property in class TCPDF
HTML link font style letters.
- $ TCPDF#htmlnopadding — Property in class TCPDF
True while rendering HTML that must ignore the current cell padding (legacy writeHTML without $cell).
- TCPDF::halignToEngine() — Method in class TCPDF
Map a legacy horizontal alignment letter to the engine convention.
- TCPDF::Header() — Method in class TCPDF
- TCPDF::hyphenateText() — Method in class TCPDF
I
- $ TCPDF#inheaderfooter — Property in class TCPDF
True while rendering the page header or footer.
- $ TCPDF#imgscale — Property in class TCPDF
Image scale ratio (used when width/height are not specified).
- $ TCPDF#imagerbx — Property in class TCPDF
Bottom-right X coordinate of the last inserted image.
- $ TCPDF#imagerby — Property in class TCPDF
Bottom-right Y coordinate of the last inserted image.
- $ TCPDF#imagemasks — Property in class TCPDF
- $ TCPDF#imagemaskseq — Property in class TCPDF
Sequence for image mask handles.
- $ TCPDF#internallinks — Property in class TCPDF
- TCPDF::insertPageContent() — Method in class TCPDF
Insert a PDF content chunk at the given position of an engine page content stream, so it paints behind the chunks that follow it.
- TCPDF::isRTLTextDir() — Method in class TCPDF
- TCPDF::isCharDefined() — Method in class TCPDF
- TCPDF::Image() — Method in class TCPDF
- TCPDF::imagePixelSize() — Method in class TCPDF
Return the pixel size of an image file or '@'-prefixed data stream.
- TCPDF::IncludeJS() — Method in class TCPDF
- TCPDF::ImageEps() — Method in class TCPDF
[BREAKING CHANGE] EPS/AI vector import is not supported.
- TCPDF::inheritHtmlBackgrounds() — Method in class TCPDF
Flatten styled inline elements that contain nested inline children.
- TCPDF::inColumnMode() — Method in class TCPDF
True when the current page is split into multiple column regions.
- TCPDF::isUnicodeFont() — Method in class TCPDF
- TCPDF::ImageSVG() — Method in class TCPDF
J
- $ TCPDF#jpegquality — Property in class TCPDF
JPEG quality used when re-encoding images.
K
- $ TCPDF#kratio — Property in class TCPDF
Scale factor: number of points per user unit.
L
- $ TCPDF#lmargin — Property in class TCPDF
Left margin in user units.
- $ TCPDF#lasth — Property in class TCPDF
Height of the last printed cell (user units).
- $ TCPDF#linewidth — Property in class TCPDF
Current line width in user units.
- $ TCPDF#linestyle — Property in class TCPDF
- $ TCPDF#langdata — Property in class TCPDF
Language dependent strings (legacy $l array): built-in English defaults, overridable via the K_TCPDF_DEFAULT_LANGUAGE constant or setLanguageArray().
- TCPDF::legacyColorComponents() — Method in class TCPDF
Sanitize a legacy color component array (numbers, optional spot name).
- TCPDF::legacyBorderCellMetrics() — Method in class TCPDF
Mirror legacy adjustCellPadding(): a cell border reserves a minimum cell padding so the stroke does not overlap the text, and the optional position mode decides how much of the stroke falls inside the cell box:
- ext : the whole stroke is painted outside -> 0 padding, the border rectangle grows outward;
- int : the whole stroke is painted inside -> a full line-width padding, the border rectangle shrinks inward;
- normal : the stroke straddles the edge -> half line-width.
- TCPDF::lastPage() — Method in class TCPDF
- TCPDF::Link() — Method in class TCPDF
- TCPDF::legacyRowPitch() — Method in class TCPDF
Map the legacy text row pitch onto the engine text-cell inputs.
- TCPDF::Ln() — Method in class TCPDF
- TCPDF::Line() — Method in class TCPDF
- TCPDF::ListBox() — Method in class TCPDF
- TCPDF::LinearGradient() — Method in class TCPDF
M
- $ TCPDF#monospacedfont — Property in class TCPDF
Default monospaced font family.
- TCPDF::movePageContentToFront() — Method in class TCPDF
Move the content chunks appended after the given index to the front of the page stream, so they paint behind the page body. Used for deferred header rendering: the legacy engine painted headers at page-start time, i.e. under the body content.
- TCPDF::MultiCell() — Method in class TCPDF
- TCPDF::mergeImageAlphaMask() — Method in class TCPDF
Apply a legacy 8-bit soft mask to an image by writing it into the image's alpha channel, then return the merged PNG content. The engine's import path then splits that alpha back out into a /SMask (the only soft-mask mechanism tc-lib-pdf-image exposes), reproducing legacy's separate-mask Image() call. Returns null when the images cannot be read (caller falls back to the unmasked file).
- TCPDF::MirrorH() — Method in class TCPDF
- TCPDF::MirrorV() — Method in class TCPDF
- TCPDF::MirrorP() — Method in class TCPDF
- TCPDF::MirrorL() — Method in class TCPDF
- TCPDF::movePage() — Method in class TCPDF
N
- $ TCPDF#nameddests — Property in class TCPDF
- $ TCPDF#nextpagegroup — Property in class TCPDF
Page group number for the next added page (0 = default group).
- $ TCPDF#nowriteareas — Property in class TCPDF
Legacy no-write page regions (setPageRegions()): rectangular/trapezoidal exclusion zones that flowing text and HTML must avoid. Stored verbatim in the legacy form and converted to engine banded writable regions at flow time (see applyNoWriteRegionsForFlow()).
- TCPDF::normalizeOrientation() — Method in class TCPDF
Normalize a legacy orientation value to 'P' or 'L'.
- TCPDF::normalizePdfaMode() — Method in class TCPDF
Map the legacy $pdfa constructor flag onto an engine conformance mode.
- TCPDF::naturalOrdWidth() — Method in class TCPDF
Raw PDF code that renders the current font's natural (unstretched, unspaced) measurement of the given text width in user units.
- TCPDF::normalizeHtmlMarkup() — Method in class TCPDF
Adapt legacy-tolerant HTML markup for the stricter engine renderer.
- TCPDF::noWriteBandFromHtml() — Method in class TCPDF
Band height (one writable slice) for a no-write region flow of HTML: the cell height of the body (outermost) font size declared in the fragment, falling back to the current font. A slice should be about one body line tall so the bands hug the obstacle without wasting vertical space (which would push too much text onto the continuation page); larger inline runs sit in the tall merged region at the top rather than at a band boundary.
O
- $ TCPDF#orig_lmargin — Property in class TCPDF
Original margins (used by header/footer rendering).
- $ TCPDF#orig_rmargin — Property in class TCPDF
Original right margin in user units.
- $ TCPDF#overprint — Property in class TCPDF
- $ TCPDF#openlayers — Property in class TCPDF
Number of currently open optional-content layers.
- TCPDF::Open() — Method in class TCPDF
- TCPDF::Output() — Method in class TCPDF
P
- $ TCPDF#pdfamode — Property in class TCPDF
PDF/A mode passed to the engine ('' = disabled).
- $ TCPDF#pdfraw — Property in class TCPDF
Cached raw PDF output (built once at close time).
- $ TCPDF#posx — Property in class TCPDF
Current abscissa (user units, from left page edge).
- $ TCPDF#posy — Property in class TCPDF
Current ordinate (user units, from top page edge).
- $ TCPDF#printheader — Property in class TCPDF
Print header flag.
- $ TCPDF#printfooter — Property in class TCPDF
Print footer flag.
- $ TCPDF#pagegroupsused — Property in class TCPDF
True when page groups are in use.
- $ TCPDF#pagecolumns — Property in class TCPDF
Columns requested via setEqualColumns() for subsequently added pages.
- $ TCPDF#pagecolumnwidth — Property in class TCPDF
Column width requested via setEqualColumns() (0 = divide the content width evenly).
- $ TCPDF#pageregions — Property in class TCPDF
- $ TCPDF#pagedecor — Property in class TCPDF
- TCPDF::pageContentImageBottom() — Method in class TCPDF
Lowest bottom edge (user units from the page top) of the images placed in the content chunks appended after the given index.
- TCPDF::pageContentCount() — Method in class TCPDF
Number of raw content chunks of the given engine page.
- TCPDF::PageNo() — Method in class TCPDF
- TCPDF::preserveBlankLines() — Method in class TCPDF
Fill the empty lines of a multi-line text with a single space.
- TCPDF::pixelsToUnits() — Method in class TCPDF
- TCPDF::Polycurve() — Method in class TCPDF
- TCPDF::PolyLine() — Method in class TCPDF
- TCPDF::Polygon() — Method in class TCPDF
- TCPDF::PageNoFormatted() — Method in class TCPDF
- TCPDF::PieSector() — Method in class TCPDF
- TCPDF::PieSectorXY() — Method in class TCPDF
- TCPDF::printTemplate() — Method in class TCPDF
- $ TCPDF_ENGINE#pagecontexthook — Property in class TCPDF_ENGINE
Facade callback returning the raw PDF operators for the ambient text state to prepend to every new page content stream.
R
- $ TCPDF#rmargin — Property in class TCPDF
Right margin in user units.
- $ TCPDF#rtlmode — Property in class TCPDF
RTL direction flag.
- TCPDF::refreshFontState() — Method in class TCPDF
Re-apply the current font to the engine font stack so it carries the up-to-date spacing/stretching.
- TCPDF::resolveLocalFile() — Method in class TCPDF
Canonicalize a local file path before handing it to the engine.
- TCPDF::resetLastH() — Method in class TCPDF
- TCPDF::resetHeaderTemplate() — Method in class TCPDF
- TCPDF::replaceMissingChars() — Method in class TCPDF
- TCPDF::Rotate() — Method in class TCPDF
- TCPDF::Rect() — Method in class TCPDF
- TCPDF::RegularPolygon() — Method in class TCPDF
- TCPDF::RoundedRect() — Method in class TCPDF
- TCPDF::RoundedRectXY() — Method in class TCPDF
- TCPDF::RadioButton() — Method in class TCPDF
- TCPDF::registerTemplateExtGState() — Method in class TCPDF
Register the ExtGState referenced by the given command with the open XObject template resource dictionary.
- TCPDF::registrationMark() — Method in class TCPDF
- TCPDF::registrationMarkCMYK() — Method in class TCPDF
- TCPDF::RadialGradient() — Method in class TCPDF
- TCPDF::rollbackTransaction() — Method in class TCPDF
- TCPDF::resetColumns() — Method in class TCPDF
- TCPDF::removePageRegion() — Method in class TCPDF
S
- $ TCPDF#startingpagenumber — Property in class TCPDF
Starting page number (used by PageNoFormatted).
- TCPDF::stylesFromLegacyBorder() — Method in class TCPDF
Build the engine per-side styles array from a legacy border argument.
- TCPDF::styleFromLegacyLineStyle() — Method in class TCPDF
Convert a legacy line style array (width, cap, join, dash, phase, color) to an engine style array.
- TCPDF::shapeModeFromLegacy() — Method in class TCPDF
Map a legacy shape style letter combination to an engine paint mode.
- TCPDF::shapeStyleFromLegacy() — Method in class TCPDF
Build the engine style for a legacy (line_style, fill_color) pair.
- TCPDF::segmentStylesFromLegacy() — Method in class TCPDF
Convert a legacy per-segment/per-side style list to engine styles.
- TCPDF::setEngineOutlines() — Method in class TCPDF
Replace the engine bookmark outline entries (used to remap page targets after the TOC pages are relocated).
- TCPDF::stretchedCellText() — Method in class TCPDF
PDF code for a stretched cell text run (legacy Cell stretch modes).
- TCPDF::setPageUnit() — Method in class TCPDF
- TCPDF::setPageOrientation() — Method in class TCPDF
- TCPDF::setSpacesRE() — Method in class TCPDF
- TCPDF::setRTL() — Method in class TCPDF
- TCPDF::setTempRTL() — Method in class TCPDF
- TCPDF::setLastH() — Method in class TCPDF
- TCPDF::setImageScale() — Method in class TCPDF
- TCPDF::setMargins() — Method in class TCPDF
- TCPDF::setLeftMargin() — Method in class TCPDF
- TCPDF::setTopMargin() — Method in class TCPDF
- TCPDF::setRightMargin() — Method in class TCPDF
- TCPDF::setCellPadding() — Method in class TCPDF
- TCPDF::setCellPaddings() — Method in class TCPDF
- TCPDF::setCellMargins() — Method in class TCPDF
- TCPDF::setAutoPageBreak() — Method in class TCPDF
- TCPDF::setDisplayMode() — Method in class TCPDF
- TCPDF::setCompression() — Method in class TCPDF
- TCPDF::setSRGBmode() — Method in class TCPDF
- TCPDF::setDocInfoUnicode() — Method in class TCPDF
- TCPDF::setTitle() — Method in class TCPDF
- TCPDF::setSubject() — Method in class TCPDF
- TCPDF::setAuthor() — Method in class TCPDF
- TCPDF::setKeywords() — Method in class TCPDF
- TCPDF::setCreator() — Method in class TCPDF
- TCPDF::setAllowLocalFiles() — Method in class TCPDF
- TCPDF::setPage() — Method in class TCPDF
- TCPDF::startPage() — Method in class TCPDF
- TCPDF::setPageMark() — Method in class TCPDF
- TCPDF::setHeaderData() — Method in class TCPDF
- TCPDF::setFooterData() — Method in class TCPDF
- TCPDF::setHeaderMargin() — Method in class TCPDF
- TCPDF::setFooterMargin() — Method in class TCPDF
- TCPDF::setPrintHeader() — Method in class TCPDF
- TCPDF::setPrintFooter() — Method in class TCPDF
- TCPDF::setHeaderTemplateAutoreset() — Method in class TCPDF
- TCPDF::setSpotColor() — Method in class TCPDF
- TCPDF::setDrawSpotColor() — Method in class TCPDF
- TCPDF::setFillSpotColor() — Method in class TCPDF
- TCPDF::setTextSpotColor() — Method in class TCPDF
- TCPDF::setColorArray() — Method in class TCPDF
- TCPDF::setDrawColorArray() — Method in class TCPDF
- TCPDF::setFillColorArray() — Method in class TCPDF
- TCPDF::setTextColorArray() — Method in class TCPDF
- TCPDF::setColor() — Method in class TCPDF
- TCPDF::setDrawColor() — Method in class TCPDF
- TCPDF::setFillColor() — Method in class TCPDF
- TCPDF::setTextColor() — Method in class TCPDF
- TCPDF::setFont() — Method in class TCPDF
- TCPDF::setFontSize() — Method in class TCPDF
- TCPDF::setDefaultMonospacedFont() — Method in class TCPDF
- TCPDF::setLink() — Method in class TCPDF
- TCPDF::setX() — Method in class TCPDF
- TCPDF::setY() — Method in class TCPDF
- TCPDF::setXY() — Method in class TCPDF
- TCPDF::setAbsX() — Method in class TCPDF
- TCPDF::setAbsY() — Method in class TCPDF
- TCPDF::setAbsXY() — Method in class TCPDF
- TCPDF::setExtraXMP() — Method in class TCPDF
- TCPDF::setExtraXMPRDF() — Method in class TCPDF
- TCPDF::setExtraXMPPdfaextension() — Method in class TCPDF
- TCPDF::setDocCreationTimestamp() — Method in class TCPDF
- TCPDF::setDocModificationTimestamp() — Method in class TCPDF
- TCPDF::setHeaderFont() — Method in class TCPDF
- TCPDF::setFooterFont() — Method in class TCPDF
- TCPDF::setLanguageArray() — Method in class TCPDF
- TCPDF::setProtection() — Method in class TCPDF
- TCPDF::StartTransform() — Method in class TCPDF
- TCPDF::StopTransform() — Method in class TCPDF
- TCPDF::ScaleX() — Method in class TCPDF
- TCPDF::ScaleY() — Method in class TCPDF
- TCPDF::ScaleXY() — Method in class TCPDF
- TCPDF::Scale() — Method in class TCPDF
- TCPDF::SkewX() — Method in class TCPDF
- TCPDF::SkewY() — Method in class TCPDF
- TCPDF::Skew() — Method in class TCPDF
- TCPDF::setLineWidth() — Method in class TCPDF
- TCPDF::setLineStyle() — Method in class TCPDF
- TCPDF::StarPolygon() — Method in class TCPDF
- TCPDF::setDestination() — Method in class TCPDF
- TCPDF::setBookmark() — Method in class TCPDF
- TCPDF::setFormDefaultProp() — Method in class TCPDF
- TCPDF::setUserRights() — Method in class TCPDF
- TCPDF::setSignature() — Method in class TCPDF
- TCPDF::setSignatureAppearance() — Method in class TCPDF
- TCPDF::setTimeStamp() — Method in class TCPDF
- TCPDF::startPageGroup() — Method in class TCPDF
- TCPDF::setStartingPageNumber() — Method in class TCPDF
- TCPDF::startLayer() — Method in class TCPDF
- TCPDF::setVisibility() — Method in class TCPDF
- TCPDF::setOverprint() — Method in class TCPDF
- TCPDF::setAlpha() — Method in class TCPDF
- TCPDF::setJPEGQuality() — Method in class TCPDF
- TCPDF::setDefaultTableColumns() — Method in class TCPDF
- TCPDF::setCellHeightRatio() — Method in class TCPDF
- TCPDF::setPDFVersion() — Method in class TCPDF
- TCPDF::setViewerPreferences() — Method in class TCPDF
- TCPDF::setBarcode() — Method in class TCPDF
- TCPDF::serializeTCPDFtag() — Method in class TCPDF
- TCPDF::setLIsymbol() — Method in class TCPDF
- TCPDF::setBooklet() — Method in class TCPDF
- TCPDF::setHtmlVSpace() — Method in class TCPDF
- TCPDF::setListIndentWidth() — Method in class TCPDF
- TCPDF::setOpenCell() — Method in class TCPDF
- TCPDF::setHtmlLinksStyle() — Method in class TCPDF
- TCPDF::startTransaction() — Method in class TCPDF
- TCPDF::setEnginePageRegions() — Method in class TCPDF
Replace the region (column) layout of the current engine page.
- TCPDF::setEqualColumns() — Method in class TCPDF
- TCPDF::setColumnsArray() — Method in class TCPDF
- TCPDF::selectColumn() — Method in class TCPDF
- TCPDF::setTextRenderingMode() — Method in class TCPDF
- TCPDF::setTextShadow() — Method in class TCPDF
- TCPDF::setRasterizeVectorImages() — Method in class TCPDF
- TCPDF::setFontSubsetting() — Method in class TCPDF
- TCPDF::stringLeftTrim() — Method in class TCPDF
- TCPDF::stringRightTrim() — Method in class TCPDF
- TCPDF::stringTrim() — Method in class TCPDF
- TCPDF::startTemplate() — Method in class TCPDF
- TCPDF::setFontStretching() — Method in class TCPDF
- TCPDF::setFontSpacing() — Method in class TCPDF
- TCPDF::setPageRegions() — Method in class TCPDF
- TCPDF::selectRegionAtY() — Method in class TCPDF
Select the (top-to-bottom ordered) writable region of the current page whose vertical span contains $y, so a flow that starts at the cursor begins in the right band. Falls back to the first region when $y sits above them all.
- TCPDF_ENGINE::setPageContext() — Method in class TCPDF_ENGINE
T
- TCPDF
- $ TCPDF#tmargin — Property in class TCPDF
Top margin in user units.
- $ TCPDF#textcolorspec — Property in class TCPDF
Text color: engine color specification string.
- $ TCPDF#textcolorlegacy — Property in class TCPDF
- $ TCPDF#tmprtl — Property in class TCPDF
Temporary RTL mode ('R', 'L' or false).
- $ TCPDF#textrendermode — Property in class TCPDF
- $ TCPDF#textshadow — Property in class TCPDF
- $ TCPDF#tocpage — Property in class TCPDF
True when the current page is a TOC page.
- $ TCPDF#transactionsnapshot — Property in class TCPDF
Snapshot of the facade object used by the transaction API.
- TCPDF::Text() — Method in class TCPDF
- TCPDF::TranslateX() — Method in class TCPDF
- TCPDF::TranslateY() — Method in class TCPDF
- TCPDF::Translate() — Method in class TCPDF
- TCPDF::TextField() — Method in class TCPDF
- TCPDF_ENGINE
U
- $ TCPDF#unicode — Property in class TCPDF
Unicode mode flag.
- TCPDF::unhtmlentities() — Method in class TCPDF
V
- TCPDF::valignToEngine() — Method in class TCPDF
Map a legacy text vertical alignment letter to the engine convention.
W
- TCPDF::Write() — Method in class TCPDF
- TCPDF::write1DBarcode() — Method in class TCPDF
- TCPDF::write2DBarcode() — Method in class TCPDF
- TCPDF::writeHTMLCell() — Method in class TCPDF
- TCPDF::writeHtmlWithTcpdfTags() — Method in class TCPDF
Render HTML containing embedded
method calls (K_TCPDF_CALLS_IN_HTML feature): the markup is split at the tags, each chunk is rendered normally and each tag invokes the serialized facade method when listed in K_ALLOWED_TCPDF_TAGS. - TCPDF::writeHTML() — Method in class TCPDF
X
- $ TCPDF#xobjtid — Property in class TCPDF
Identifier of the currently open XObject template ('' = none).
- $ TCPDF#xobjheight — Property in class TCPDF
Height of the currently open XObject template in user units.
_
- TCPDF::__construct() — Method in class TCPDF
- TCPDF::__destruct() — Method in class TCPDF
- TCPDF::__get() — Method in class TCPDF
Legacy protected properties historically read by TCPDF subclasses (e.g. $this->AutoPageBreak, $this->lMargin), mapped to facade state.
- TCPDF::__isset() — Method in class TCPDF