Table of contents
class TCPDF
Source: tcpdf.php:41
Methods
__construct()
public __construct(
mixed $_orientation = 'P',
mixed $_unit = 'mm',
mixed $_format = 'A4',
mixed $_unicode = true,
mixed $_encoding = 'UTF-8',
mixed $_diskcache = false,
mixed $_pdfa = false
)
Parameters:
$_orientation(mixed)$_unit(mixed)$_format(mixed)$_unicode(mixed)$_encoding(mixed)$_diskcache(mixed)$_pdfa(mixed)
Source: tcpdf.php:347
__destruct()
public __destruct()
Source: tcpdf.php:393
__get()
Legacy protected properties historically read by TCPDF subclasses (e.g. $this->AutoPageBreak, $this->lMargin), mapped to facade state.
public __get(mixed $name)
Parameters:
$name(mixed)
Source: tcpdf.php:402
__isset()
public __isset(mixed $name)
Parameters:
$name(mixed)
See: __get()
Source: tcpdf.php:435
AcceptPageBreak()
public AcceptPageBreak(): bool
Returns: bool: True when an automatic page break is allowed.
Source: tcpdf.php:3477
addEmptySignatureAppearance()
public addEmptySignatureAppearance(
mixed $_x = 0,
mixed $_y = 0,
mixed $_w = 0,
mixed $_h = 0,
mixed $_page = -1,
mixed $_name = ''
)
Parameters:
$_x(mixed)$_y(mixed)$_w(mixed)$_h(mixed)$_page(mixed)$_name(mixed)
Source: tcpdf.php:5919
AddFont()
public AddFont(
mixed $_family,
mixed $_style = '',
mixed $_fontfile = '',
mixed $_subset = 'default'
)
Parameters:
$_family(mixed)$_style(mixed)$_fontfile(mixed)$_subset(mixed)
Source: tcpdf.php:3188
addHtmlLink()
public addHtmlLink(
mixed $_url,
mixed $_name,
mixed $_fill = false,
mixed $_firstline = false,
mixed $_color = null,
mixed $_style = -1,
mixed $_firstblock = false
)
Parameters:
$_url(mixed)$_name(mixed)$_fill(mixed)$_firstline(mixed)$_color(mixed)$_style(mixed)$_firstblock(mixed)
Source: tcpdf.php:4820
addHTMLTOC()
public addHTMLTOC(
mixed $_page = null,
mixed $_toc_name = 'TOC',
mixed $_templates = [],
mixed $_correct_align = true,
mixed $_style = '',
mixed $_color = [0, 0, 0]
)
Parameters:
$_page(mixed)$_toc_name(mixed)$_templates(mixed)$_correct_align(mixed)$_style(mixed)$_color(mixed)
Source: tcpdf.php:8061
addJavascriptObject()
public addJavascriptObject(mixed $_script, mixed $_onload = false)
Parameters:
$_script(mixed)$_onload(mixed)
Source: tcpdf.php:5519
AddLink()
public AddLink()
Source: tcpdf.php:3356
AddPage()
public AddPage(
mixed $_orientation = '',
mixed $_format = '',
mixed $_keepmargins = false,
mixed $_tocpage = false
)
Parameters:
$_orientation(mixed)$_format(mixed)$_keepmargins(mixed)$_tocpage(mixed)
Source: tcpdf.php:2701
addPageRegion()
public addPageRegion(mixed $_region)
Parameters:
$_region(mixed)
Source: tcpdf.php:8606
AddSpotColor()
public AddSpotColor(mixed $_name, mixed $_c, mixed $_m, mixed $_y, mixed $_k)
Parameters:
$_name(mixed)$_c(mixed)$_m(mixed)$_y(mixed)$_k(mixed)
Source: tcpdf.php:2953
addTOC()
public addTOC(
mixed $_page = null,
mixed $_numbersfont = '',
mixed $_filler = '.',
mixed $_toc_name = 'TOC',
mixed $_style = '',
mixed $_color = [0, 0, 0]
)
Parameters:
$_page(mixed)$_numbersfont(mixed)$_filler(mixed)$_toc_name(mixed)$_style(mixed)$_color(mixed)
Source: tcpdf.php:7947
addTOCPage()
public addTOCPage(
mixed $_orientation = '',
mixed $_format = '',
mixed $_keepmargins = false
)
Parameters:
$_orientation(mixed)$_format(mixed)$_keepmargins(mixed)
Source: tcpdf.php:2691
Annotation()
public Annotation(
mixed $_x,
mixed $_y,
mixed $_w,
mixed $_h,
mixed $_text,
mixed $_opt = ['Subtype' => 'Text'],
mixed $_spaces = 0
)
Parameters:
$_x(mixed)$_y(mixed)$_w(mixed)$_h(mixed)$_text(mixed)$_opt(mixed)$_spaces(mixed)
Source: tcpdf.php:3386
Arrow()
public Arrow(
mixed $_x0,
mixed $_y0,
mixed $_x1,
mixed $_y1,
mixed $_head_style = 0,
mixed $_arm_size = 5,
mixed $_arm_angle = 15
)
Parameters:
$_x0(mixed)$_y0(mixed)$_x1(mixed)$_y1(mixed)$_head_style(mixed)$_arm_size(mixed)$_arm_angle(mixed)
Source: tcpdf.php:5429
Bookmark()
public Bookmark(
mixed $_txt,
mixed $_level = 0,
mixed $_y = -1,
mixed $_page = '',
mixed $_style = '',
mixed $_color = [0, 0, 0],
mixed $_x = -1,
mixed $_link = ''
)
Parameters:
$_txt(mixed)$_level(mixed)$_y(mixed)$_page(mixed)$_style(mixed)$_color(mixed)$_x(mixed)$_link(mixed)
Source: tcpdf.php:5480
Button()
public Button(
mixed $_name,
mixed $_w,
mixed $_h,
mixed $_caption,
mixed $_action,
mixed $_prop = [],
mixed $_opt = [],
mixed $_x = null,
mixed $_y = null,
mixed $_js = false
)
Parameters:
$_name(mixed)$_w(mixed)$_h(mixed)$_caption(mixed)$_action(mixed)$_prop(mixed)$_opt(mixed)$_x(mixed)$_y(mixed)$_js(mixed)
Source: tcpdf.php:5785
Cell()
public Cell(
mixed $_w,
mixed $_h = 0,
mixed $_txt = '',
mixed $_border = 0,
mixed $_ln = 0,
mixed $_align = '',
mixed $_fill = false,
mixed $_link = '',
mixed $_stretch = 0,
mixed $_ignore_min_height = false,
mixed $_calign = 'T',
mixed $_valign = 'M'
)
Parameters:
$_w(mixed)$_h(mixed)$_txt(mixed)$_border(mixed)$_ln(mixed)$_align(mixed)$_fill(mixed)$_link(mixed)$_stretch(mixed)$_ignore_min_height(mixed)$_calign(mixed)$_valign(mixed)
Source: tcpdf.php:3482
CheckBox()
public CheckBox(
mixed $_name,
mixed $_w,
mixed $_checked = false,
mixed $_prop = [],
mixed $_opt = [],
mixed $_onvalue = 'Yes',
mixed $_x = null,
mixed $_y = null,
mixed $_js = false
)
Parameters:
$_name(mixed)$_w(mixed)$_checked(mixed)$_prop(mixed)$_opt(mixed)$_onvalue(mixed)$_x(mixed)$_y(mixed)$_js(mixed)
Source: tcpdf.php:5748
Circle()
public Circle(
mixed $_x0,
mixed $_y0,
mixed $_r,
mixed $_angstr = 0,
mixed $_angend = 360,
mixed $_style = '',
mixed $_line_style = [],
mixed $_fill_color = [],
mixed $_nc = 2
)
Parameters:
$_x0(mixed)$_y0(mixed)$_r(mixed)$_angstr(mixed)$_angend(mixed)$_style(mixed)$_line_style(mixed)$_fill_color(mixed)$_nc(mixed)
Source: tcpdf.php:5264
Close()
public Close()
Source: tcpdf.php:2603
colorRegistrationBar()
public colorRegistrationBar(
mixed $_x,
mixed $_y,
mixed $_w,
mixed $_h,
mixed $_transition = true,
mixed $_vertical = false,
mixed $_colors = 'A,R,G,B,C,M,Y,K'
)
Parameters:
$_x(mixed)$_y(mixed)$_w(mixed)$_h(mixed)$_transition(mixed)$_vertical(mixed)$_colors(mixed)
Source: tcpdf.php:6201
ComboBox()
public ComboBox(
mixed $_name,
mixed $_w,
mixed $_h,
mixed $_values,
mixed $_prop = [],
mixed $_opt = [],
mixed $_x = null,
mixed $_y = null,
mixed $_js = false
)
Parameters:
$_name(mixed)$_w(mixed)$_h(mixed)$_values(mixed)$_prop(mixed)$_opt(mixed)$_x(mixed)$_y(mixed)$_js(mixed)
Source: tcpdf.php:5719
commitTransaction()
public commitTransaction()
Source: tcpdf.php:8103
CoonsPatchMesh()
public CoonsPatchMesh(
mixed $_x,
mixed $_y,
mixed $_w,
mixed $_h,
mixed $_col1 = [],
mixed $_col2 = [],
mixed $_col3 = [],
mixed $_col4 = [],
mixed $_coords = [0.0, 0.0, 0.33, 0.0, 0.67, 0.0, 1.0, 0.0, 1.0, 0.33, 1.0, 0…,
mixed $_coords_min = 0,
mixed $_coords_max = 1,
mixed $_antialias = false
)
Parameters:
$_x(mixed)$_y(mixed)$_w(mixed)$_h(mixed)$_col1(mixed)$_col2(mixed)$_col3(mixed)$_col4(mixed)$_coords(mixed)$_coords_min(mixed)$_coords_max(mixed)$_antialias(mixed)
Source: tcpdf.php:6319
copyPage()
public copyPage(mixed $_page = 0)
Parameters:
$_page(mixed)
Source: tcpdf.php:7923
cropMark()
public cropMark(
mixed $_x,
mixed $_y,
mixed $_w,
mixed $_h,
mixed $_type = 'T,R,B,L',
mixed $_color = [100, 100, 100, 100, 'All']
)
Parameters:
$_x(mixed)$_y(mixed)$_w(mixed)$_h(mixed)$_type(mixed)$_color(mixed)
Source: tcpdf.php:6249
Curve()
public Curve(
mixed $_x0,
mixed $_y0,
mixed $_x1,
mixed $_y1,
mixed $_x2,
mixed $_y2,
mixed $_x3,
mixed $_y3,
mixed $_style = '',
mixed $_line_style = [],
mixed $_fill_color = []
)
Parameters:
$_x0(mixed)$_y0(mixed)$_x1(mixed)$_y1(mixed)$_x2(mixed)$_y2(mixed)$_x3(mixed)$_y3(mixed)$_style(mixed)$_line_style(mixed)$_fill_color(mixed)
Source: tcpdf.php:5182
deletePage()
public deletePage(mixed $_page)
Parameters:
$_page(mixed)
Source: tcpdf.php:7912
Ellipse()
public Ellipse(
mixed $_x0,
mixed $_y0,
mixed $_rx,
mixed $_ry = 0,
mixed $_angle = 0,
mixed $_astart = 0,
mixed $_afinish = 360,
mixed $_style = '',
mixed $_line_style = [],
mixed $_fill_color = [],
mixed $_nc = 2
)
Parameters:
$_x0(mixed)$_y0(mixed)$_rx(mixed)$_ry(mixed)$_angle(mixed)$_astart(mixed)$_afinish(mixed)$_style(mixed)$_line_style(mixed)$_fill_color(mixed)$_nc(mixed)
Source: tcpdf.php:5231
EmbedFile()
public EmbedFile(mixed $_opt)
Parameters:
$_opt(mixed)
Source: tcpdf.php:3414
EmbedFileFromString()
public EmbedFileFromString(mixed $_filename, mixed $_content)
Parameters:
$_filename(mixed)$_content(mixed)
Source: tcpdf.php:3430
endLayer()
public endLayer()
Source: tcpdf.php:6084
endPage()
public endPage(mixed $_tocpage = false)
Parameters:
$_tocpage(mixed)
Source: tcpdf.php:2717
endTemplate()
public endTemplate()
Source: tcpdf.php:8519
endTOCPage()
public endTOCPage()
Source: tcpdf.php:2696
Error()
public Error(mixed $_msg)
Parameters:
$_msg(mixed)
Source: tcpdf.php:2585
fixHTMLCode()
public fixHTMLCode(
mixed $_html,
mixed $_default_css = '',
mixed $_tagvs = null,
mixed $_tidy_options = null
)
Parameters:
$_html(mixed)$_default_css(mixed)$_tagvs(mixed)$_tidy_options(mixed)
Source: tcpdf.php:7252
Footer()
public Footer()
Source: tcpdf.php:2913
getAbsFontMeasure()
public getAbsFontMeasure(mixed $_s)
Parameters:
$_s(mixed)
Source: tcpdf.php:3278
GetAbsX()
public GetAbsX(): float
Returns: float: Absolute X coordinate of the cursor in user units.
Source: tcpdf.php:4562
getAliasNbPages()
public getAliasNbPages(): string
Returns: string: Total number of pages, or the legacy alias placeholder.
Source: tcpdf.php:5979
getAliasNumPage()
public getAliasNumPage(): string
Returns: string: Current page number, or the legacy alias placeholder.
Source: tcpdf.php:5991
getAliasRightShift()
public getAliasRightShift(): string
Returns: string: Right-shift compensation prefix (unused by the facade).
Source: tcpdf.php:5971
getAllSpotColors()
public getAllSpotColors()
Source: tcpdf.php:2948
getAlpha()
public getAlpha()
Source: tcpdf.php:6156
GetArrStringWidth()
Return the width of a character array in user units.
public GetArrStringWidth(
array<int,int|string> $_sa,
string $_fontname = '',
string $_fontstyle = '',
int|float $_fontsize = 0,
bool $_getarray = false
): float|array<int,float>
Parameters:
$_sa(array<int,int|string>): Characters (codepoints or strings).$_fontname(string): Optional family to measure with (default: current font).$_fontstyle(string): Optional font style.$_fontsize(int|float): Optional font size in points.$_getarray(bool): When true return an array of per-character widths.
Returns: float|array<int,float>: Total width, or per-character widths.
Source: tcpdf.php:3120
getAutoPageBreak()
public getAutoPageBreak(): bool
Returns: bool: Automatic page break state.
Source: tcpdf.php:2526
getBarcode()
public getBarcode(): string
Returns: string: Document barcode string.
Source: tcpdf.php:6601
getBreakMargin()
Return the automatic page-break bottom margin.
public getBreakMargin(int|null $_pagenum = null): float
Parameters:
$_pagenum(int|null): Page number (1-based) or null for the current page.
Returns: float: Break margin in user units.
Source: tcpdf.php:2383
getCellHeight()
Return the cell height for the given font size.
public getCellHeight(int|float $_fontsize, bool $_padding = true): float
Parameters:
$_fontsize(int|float): Font size in user units.$_padding(bool): When true include the top and bottom cell padding.
Returns: float: Cell height in user units.
Source: tcpdf.php:2275
getCellHeightRatio()
public getCellHeightRatio(): float
Returns: float: Cell height ratio.
Source: tcpdf.php:6180
getCellMargins()
public getCellMargins(): array{L: float, T: float, R: float, B: float}
Returns: array{L: float, T: float, R: float, B: float}: Cell margins in user units.
Source: tcpdf.php:2509
getCellPaddings()
public getCellPaddings(): array{L: float, T: float, R: float, B: float}
Returns: array{L: float, T: float, R: float, B: float}: Cell padding in user units.
Source: tcpdf.php:2475
getCharBBox()
public getCharBBox(mixed $_char)
Parameters:
$_char(mixed)
Source: tcpdf.php:3283
GetCharWidth()
public GetCharWidth(mixed $_char, mixed $_notlast = true)
Parameters:
$_char(mixed)$_notlast(mixed)
Source: tcpdf.php:3166
getColumn()
public getColumn()
Source: tcpdf.php:8362
getCSSBorderMargin()
public getCSSBorderMargin(mixed $_cssbspace, mixed $_width = 0)
Parameters:
$_cssbspace(mixed)$_width(mixed)
Source: tcpdf.php:7267
getCSSMargin()
public getCSSMargin(mixed $_cssmargin, mixed $_width = 0)
Parameters:
$_cssmargin(mixed)$_width(mixed)
Source: tcpdf.php:7262
getCSSPadding()
public getCSSPadding(mixed $_csspadding, mixed $_width = 0)
Parameters:
$_csspadding(mixed)$_width(mixed)
Source: tcpdf.php:7257
getDestination()
public getDestination()
Source: tcpdf.php:5462
getDocCreationTimestamp()
public getDocCreationTimestamp()
Source: tcpdf.php:4750
getDocModificationTimestamp()
public getDocModificationTimestamp()
Source: tcpdf.php:4755
getFontAscent()
public getFontAscent(mixed $_font, mixed $_style = '', mixed $_size = 0)
Parameters:
$_font(mixed)$_style(mixed)$_size(mixed)
Source: tcpdf.php:3299
getFontBBox()
public getFontBBox()
Source: tcpdf.php:3271
getFontDescent()
public getFontDescent(mixed $_font, mixed $_style = '', mixed $_size = 0)
Parameters:
$_font(mixed)$_style(mixed)$_size(mixed)
Source: tcpdf.php:3290
getFontFamily()
public getFontFamily(): string
Returns: string: Current font family.
Source: tcpdf.php:7235
getFontFamilyName()
public getFontFamilyName(mixed $_fontfamily)
Parameters:
$_fontfamily(mixed)
Source: tcpdf.php:8496
getFontSize()
public getFontSize(): float
Returns: float: Current font size in user units.
Source: tcpdf.php:7219
getFontSizePt()
public getFontSizePt(): float
Returns: float: Current font size in points.
Source: tcpdf.php:7227
getFontSpacing()
public getFontSpacing(): float
Returns: float: Extra font spacing in user units.
Source: tcpdf.php:8581
getFontStretching()
public getFontStretching(): float
Returns: float: Font stretching percentage.
Source: tcpdf.php:8567
getFontStyle()
public getFontStyle(): string
Returns: string: Current font style letters including decorations.
Source: tcpdf.php:7243
getFontSubsetting()
public getFontSubsetting(): bool
Returns: bool: Default font subsetting mode.
Source: tcpdf.php:8471
getFooterFont()
public getFooterFont(): array{0: string, 1: string, 2: float}
Returns: array{0: string, 1: string, 2: float}: Footer font: family, style, size in points.
Source: tcpdf.php:4791
getFooterMargin()
public getFooterMargin(): float
Returns: float: Footer margin in user units.
Source: tcpdf.php:2808
getFormDefaultProp()
public getFormDefaultProp()
Source: tcpdf.php:5534
getGroupPageNo()
public getGroupPageNo(): int
Returns: int: Current page number within its page group.
Source: tcpdf.php:6038
getGroupPageNoFormatted()
public getGroupPageNoFormatted()
Source: tcpdf.php:6064
getHeaderData()
public getHeaderData(): array{logo: string, logo_width: float, title: string, string: string, text_color: array<int,float|int|string>, line_color: array<int,float|int|string>}
Returns: array{logo: string, logo_width: float, title: string, string: string, text_color: array<int,float|int|string>, line_color: array<int,float|int|string>}: Header data.
Source: tcpdf.php:2782
getHeaderFont()
public getHeaderFont(): array{0: string, 1: string, 2: float}
Returns: array{0: string, 1: string, 2: float}: Header font: family, style, size in points.
Source: tcpdf.php:4773
getHeaderMargin()
public getHeaderMargin(): float
Returns: float: Header margin in user units.
Source: tcpdf.php:2795
getHTMLFontUnits()
public getHTMLFontUnits(
mixed $_val,
mixed $_refsize = 12,
mixed $_parent_size = 12,
mixed $_defaultunit = 'pt'
)
Parameters:
$_val(mixed)$_refsize(mixed)$_parent_size(mixed)$_defaultunit(mixed)
Source: tcpdf.php:7297
getHTMLUnitToUnits()
public getHTMLUnitToUnits(
mixed $_htmlval,
mixed $_refsize = 1,
mixed $_defaultunit = 'px',
mixed $_points = false
)
Parameters:
$_htmlval(mixed)$_refsize(mixed)$_defaultunit(mixed)$_points(mixed)
Source: tcpdf.php:7859
getImageRBX()
public getImageRBX(): float
Returns: float: Right-bottom X coordinate of the last inserted image.
Source: tcpdf.php:2832
getImageRBY()
public getImageRBY(): float
Returns: float: Right-bottom Y coordinate of the last inserted image.
Source: tcpdf.php:2840
getImageScale()
public getImageScale(): float
Returns: float: Image scale ratio.
Source: tcpdf.php:2306
getLastH()
public getLastH(): float
Returns: float: Height of the last printed cell in user units.
Source: tcpdf.php:2293
GetLineWidth()
public GetLineWidth(): float
Returns: float: Current line width in user units.
Source: tcpdf.php:5065
getMargins()
public getMargins()
Source: tcpdf.php:7191
getNumberOfColumns()
public getNumberOfColumns()
Source: tcpdf.php:8371
GetNumChars()
public GetNumChars(mixed $_s)
Parameters:
$_s(mixed)
Source: tcpdf.php:3183
getNumLines()
Estimate the number of lines needed to print the given text.
public getNumLines(
mixed $_txt,
mixed $_w = 0,
mixed $_reseth = false,
mixed $_autopadding = true,
mixed $_cellpadding = null,
mixed $_border = 0
): int
Parameters:
$_txt(mixed)$_w(mixed)$_reseth(mixed)$_autopadding(mixed)$_cellpadding(mixed)$_border(mixed)
Returns: int: Estimated number of lines.
Source: tcpdf.php:4001
getNumPages()
public getNumPages(): int
Returns: int: Total number of pages.
Source: tcpdf.php:2682
getOriginalMargins()
public getOriginalMargins()
Source: tcpdf.php:7208
getOverprint()
public getOverprint()
Source: tcpdf.php:6124
getPage()
public getPage(): int
Returns: int: Current page number (1-based, 0 when no page exists).
Source: tcpdf.php:2670
getPageDimensions()
public getPageDimensions(mixed $_pagenum = null)
Parameters:
$_pagenum(mixed)
Source: tcpdf.php:2311
getPageGroupAlias()
public getPageGroupAlias(): string
Returns: string: Total pages in the current group, or the legacy alias placeholder.
Source: tcpdf.php:6003
getPageHeight()
Return the page height in user units.
public getPageHeight(int|null $_pagenum = null): float
Parameters:
$_pagenum(int|null): Page number (1-based) or null for the current page.
Returns: float: Page height in user units.
Source: tcpdf.php:2361
getPageNumGroupAlias()
public getPageNumGroupAlias(): string
Returns: string: Page number in the current group, or the legacy alias placeholder.
Source: tcpdf.php:6026
getPageRegions()
public getPageRegions()
Source: tcpdf.php:8590
getPageWidth()
Return the page width in user units.
public getPageWidth(int|null $_pagenum = null): float
Parameters:
$_pagenum(int|null): Page number (1-based) or null for the current page.
Returns: float: Page width in user units.
Source: tcpdf.php:2339
getPDFData()
public getPDFData()
Source: tcpdf.php:4705
getPDFFilename()
Return the PDF file name in use, as sanitized by the engine.
Not part of the legacy TCPDF API. After Output() with the ‘F’, ‘FI’ or ‘FD’ destination this is the base name of the file that was written, which may differ from the name passed in.
public getPDFFilename(): string
Returns: string
Source: tcpdf.php:4720
getRawCharWidth()
public getRawCharWidth(int|string $_char): float
Parameters:
$_char(int|string): Character codepoint or string.
Returns: float: Character width in user units.
Source: tcpdf.php:3177
getRTL()
public getRTL(): bool
Returns: bool: Current RTL document direction.
Source: tcpdf.php:2237
getScaleFactor()
public getScaleFactor(): float
Returns: float: Document scale factor (number of points in user unit).
Source: tcpdf.php:2397
getStringHeight()
public getStringHeight(
mixed $_w,
mixed $_txt,
mixed $_reseth = false,
mixed $_autopadding = true,
mixed $_cellpadding = null,
mixed $_border = 0
)
Parameters:
$_w(mixed)$_txt(mixed)$_reseth(mixed)$_autopadding(mixed)$_cellpadding(mixed)$_border(mixed)
Source: tcpdf.php:4028
GetStringWidth()
Return the length of a string in user units.
public GetStringWidth(
string $_s,
string $_fontname = '',
string $_fontstyle = '',
int|float $_fontsize = 0,
bool $_getarray = false
): float|array<int,float>
Parameters:
$_s(string): Input string.$_fontname(string): Optional family to measure with (default: current font).$_fontstyle(string): Optional font style.$_fontsize(int|float): Optional font size in points.$_getarray(bool): When true return an array of per-character widths.
Returns: float|array<int,float>: Total width, or per-character widths.
Source: tcpdf.php:3098
getTextShadow()
public getTextShadow(): array{enabled: bool, depth_w: int|float, depth_h: int|float, color: mixed, opacity: int|float, blend_mode: string}
Returns: array{enabled: bool, depth_w: int|float, depth_h: int|float, color: mixed, opacity: int|float, blend_mode: string}: Text shadow parameters.
Source: tcpdf.php:8416
GetX()
public GetX(): float
Returns: float: Relative X coordinate of the cursor in user units.
Source: tcpdf.php:4554
GetY()
public GetY(): float
Returns: float: Y coordinate of the cursor in user units.
Source: tcpdf.php:4570
Gradient()
public Gradient(
mixed $_type,
mixed $_coords,
mixed $_stops,
mixed $_background = [],
mixed $_antialias = false
)
Parameters:
$_type(mixed)$_coords(mixed)$_stops(mixed)$_background(mixed)$_antialias(mixed)
Source: tcpdf.php:6443
Header()
public Header()
Source: tcpdf.php:2855
hyphenateText()
public hyphenateText(
mixed $_text,
mixed $_patterns,
mixed $_dictionary = [],
mixed $_leftmin = 1,
mixed $_rightmin = 2,
mixed $_charmin = 1,
mixed $_charmax = 8
)
Parameters:
$_text(mixed)$_patterns(mixed)$_dictionary(mixed)$_leftmin(mixed)$_rightmin(mixed)$_charmin(mixed)$_charmax(mixed)
Source: tcpdf.php:8421
Image()
public Image(
mixed $_file,
mixed $_x = null,
mixed $_y = null,
mixed $_w = 0,
mixed $_h = 0,
mixed $_type = '',
mixed $_link = '',
mixed $_align = '',
mixed $_resize = false,
mixed $_dpi = 300,
mixed $_palign = '',
mixed $_ismask = false,
mixed $_imgmask = false,
mixed $_border = 0,
mixed $_fitbox = false,
mixed $_hidden = false,
mixed $_fitonpage = false,
mixed $_alt = false,
mixed $_altimgs = []
)
Parameters:
$_file(mixed)$_x(mixed)$_y(mixed)$_w(mixed)$_h(mixed)$_type(mixed)$_link(mixed)$_align(mixed)$_resize(mixed)$_dpi(mixed)$_palign(mixed)$_ismask(mixed)$_imgmask(mixed)$_border(mixed)$_fitbox(mixed)$_hidden(mixed)$_fitonpage(mixed)$_alt(mixed)$_altimgs(mixed)
Source: tcpdf.php:4287
ImageEps()
[BREAKING CHANGE] EPS/AI vector import is not supported.
The modern engine has no PostScript interpreter: convert EPS/AI
artwork to SVG (e.g. inkscape file.eps --export-filename=file.svg
or mutool convert) and use ImageSVG() instead. As a convenience,
SVG files passed to this method are dispatched to ImageSVG() and
raster files to Image(); EPS/AI input is silently skipped.
public ImageEps(
mixed $_file,
mixed $_x = null,
mixed $_y = null,
mixed $_w = 0,
mixed $_h = 0,
mixed $_link = '',
mixed $_useBoundingBox = true,
mixed $_align = '',
mixed $_palign = '',
mixed $_border = 0,
mixed $_fitonpage = false,
mixed $_fixoutvals = false
)
Parameters:
$_file(mixed)$_x(mixed)$_y(mixed)$_w(mixed)$_h(mixed)$_link(mixed)$_useBoundingBox(mixed)$_align(mixed)$_palign(mixed)$_border(mixed)$_fitonpage(mixed)$_fixoutvals(mixed)
Source: tcpdf.php:6546
ImageSVG()
public ImageSVG(
mixed $_file,
mixed $_x = null,
mixed $_y = null,
mixed $_w = 0,
mixed $_h = 0,
mixed $_link = '',
mixed $_align = '',
mixed $_palign = '',
mixed $_border = 0,
mixed $_fitonpage = false
)
Parameters:
$_file(mixed)$_x(mixed)$_y(mixed)$_w(mixed)$_h(mixed)$_link(mixed)$_align(mixed)$_palign(mixed)$_border(mixed)$_fitonpage(mixed)
Source: tcpdf.php:8746
IncludeJS()
public IncludeJS(mixed $_script)
Parameters:
$_script(mixed)
Source: tcpdf.php:5514
isCharDefined()
public isCharDefined(mixed $_char, mixed $_font = '', mixed $_style = '')
Parameters:
$_char(mixed)$_font(mixed)$_style(mixed)
Source: tcpdf.php:3308
isRTLTextDir()
public isRTLTextDir(): bool
Returns: bool: True when the current text direction is right-to-left.
Source: tcpdf.php:2257
isUnicodeFont()
public isUnicodeFont()
Source: tcpdf.php:8491
lastPage()
public lastPage(mixed $_resetmargins = false)
Parameters:
$_resetmargins(mixed)
Source: tcpdf.php:2662
Line()
public Line(mixed $_x1, mixed $_y1, mixed $_x2, mixed $_y2, mixed $_style = [])
Parameters:
$_x1(mixed)$_y1(mixed)$_x2(mixed)$_y2(mixed)$_style(mixed)
Source: tcpdf.php:5091
LinearGradient()
public LinearGradient(
mixed $_x,
mixed $_y,
mixed $_w,
mixed $_h,
mixed $_col1 = [],
mixed $_col2 = [],
mixed $_coords = [0, 0, 1, 0]
)
Parameters:
$_x(mixed)$_y(mixed)$_w(mixed)$_h(mixed)$_col1(mixed)$_col2(mixed)$_coords(mixed)
Source: tcpdf.php:6285
Link()
public Link(mixed $_x, mixed $_y, mixed $_w, mixed $_h, mixed $_link, mixed $_spaces = 0)
Parameters:
$_x(mixed)$_y(mixed)$_w(mixed)$_h(mixed)$_link(mixed)$_spaces(mixed)
Source: tcpdf.php:3381
ListBox()
public ListBox(
mixed $_name,
mixed $_w,
mixed $_h,
mixed $_values,
mixed $_prop = [],
mixed $_opt = [],
mixed $_x = null,
mixed $_y = null,
mixed $_js = false
)
Parameters:
$_name(mixed)$_w(mixed)$_h(mixed)$_values(mixed)$_prop(mixed)$_opt(mixed)$_x(mixed)$_y(mixed)$_js(mixed)
Source: tcpdf.php:5690
Ln()
public Ln(mixed $_h = null, mixed $_cell = false)
Parameters:
$_h(mixed)$_cell(mixed)
Source: tcpdf.php:4541
MirrorH()
public MirrorH(mixed $_x = null)
Parameters:
$_x(mixed)
Source: tcpdf.php:4974
MirrorL()
public MirrorL(mixed $_angle = 0, mixed $_x = null, mixed $_y = null)
Parameters:
$_angle(mixed)$_x(mixed)$_y(mixed)
Source: tcpdf.php:4992
MirrorP()
public MirrorP(mixed $_x = null, mixed $_y = null)
Parameters:
$_x(mixed)$_y(mixed)
Source: tcpdf.php:4984
MirrorV()
public MirrorV(mixed $_y = null)
Parameters:
$_y(mixed)
Source: tcpdf.php:4979
movePage()
public movePage(mixed $_frompage, mixed $_topage)
Parameters:
$_frompage(mixed)$_topage(mixed)
Source: tcpdf.php:7900
MultiCell()
public MultiCell(
mixed $_w,
mixed $_h,
mixed $_txt,
mixed $_border = 0,
mixed $_align = 'J',
mixed $_fill = false,
mixed $_ln = 1,
mixed $_x = null,
mixed $_y = null,
mixed $_reseth = true,
mixed $_stretch = 0,
mixed $_ishtml = false,
mixed $_autopadding = true,
mixed $_maxh = 0,
mixed $_valign = 'T',
mixed $_fitcell = false
)
Parameters:
$_w(mixed)$_h(mixed)$_txt(mixed)$_border(mixed)$_align(mixed)$_fill(mixed)$_ln(mixed)$_x(mixed)$_y(mixed)$_reseth(mixed)$_stretch(mixed)$_ishtml(mixed)$_autopadding(mixed)$_maxh(mixed)$_valign(mixed)$_fitcell(mixed)
Source: tcpdf.php:3683
Open()
public Open()
Source: tcpdf.php:2598
Output()
Send the document to the given destination: string, local file or browser.
For ‘F’, ‘FI’ and ‘FD’ the name is a full or relative file path, unlike \Com\Tecnick\Pdf\Output::savePDF(), which takes a directory. The file name is sanitized by the engine, so the file written may differ from the name given: getPDFFilename() returns the name actually used. The output directory must be inside an allowed path (K_ALLOWED_PATHS).
public Output(mixed $_name = 'doc.pdf', mixed $_dest = 'I'): string
Parameters:
$_name(mixed): File name.$_dest(mixed): Destination: I, D, F, S, FI, FD or E. A boolean is accepted for legacy callers: true is D, false is F.
Returns: string
Source: tcpdf.php:4636
PageNo()
public PageNo(): int
Returns: int: Current page number.
Source: tcpdf.php:2939
PageNoFormatted()
public PageNoFormatted()
Source: tcpdf.php:6069
PieSector()
public PieSector(
mixed $_xc,
mixed $_yc,
mixed $_r,
mixed $_a,
mixed $_b,
mixed $_style = 'FD',
mixed $_cw = true,
mixed $_o = 90
)
Parameters:
$_xc(mixed)$_yc(mixed)$_r(mixed)$_a(mixed)$_b(mixed)$_style(mixed)$_cw(mixed)$_o(mixed)
Source: tcpdf.php:6473
PieSectorXY()
public PieSectorXY(
mixed $_xc,
mixed $_yc,
mixed $_rx,
mixed $_ry,
mixed $_a,
mixed $_b,
mixed $_style = 'FD',
mixed $_cw = false,
mixed $_o = 0,
mixed $_nc = 2
)
Parameters:
$_xc(mixed)$_yc(mixed)$_rx(mixed)$_ry(mixed)$_a(mixed)$_b(mixed)$_style(mixed)$_cw(mixed)$_o(mixed)$_nc(mixed)
Source: tcpdf.php:6497
pixelsToUnits()
public pixelsToUnits(mixed $_px)
Parameters:
$_px(mixed)
Source: tcpdf.php:4856
Polycurve()
public Polycurve(
mixed $_x0,
mixed $_y0,
mixed $_segments,
mixed $_style = '',
mixed $_line_style = [],
mixed $_fill_color = []
)
Parameters:
$_x0(mixed)$_y0(mixed)$_segments(mixed)$_style(mixed)$_line_style(mixed)$_fill_color(mixed)
Source: tcpdf.php:5210
Polygon()
public Polygon(
mixed $_p,
mixed $_style = '',
mixed $_line_style = [],
mixed $_fill_color = [],
mixed $_closed = true
)
Parameters:
$_p(mixed)$_style(mixed)$_line_style(mixed)$_fill_color(mixed)$_closed(mixed)
Source: tcpdf.php:5304
PolyLine()
public PolyLine(
mixed $_p,
mixed $_style = '',
mixed $_line_style = [],
mixed $_fill_color = []
)
Parameters:
$_p(mixed)$_style(mixed)$_line_style(mixed)$_fill_color(mixed)
Source: tcpdf.php:5288
printTemplate()
public printTemplate(
mixed $_id,
mixed $_x = null,
mixed $_y = null,
mixed $_w = 0,
mixed $_h = 0,
mixed $_align = '',
mixed $_palign = '',
mixed $_fitonpage = false
)
Parameters:
$_id(mixed)$_x(mixed)$_y(mixed)$_w(mixed)$_h(mixed)$_align(mixed)$_palign(mixed)$_fitonpage(mixed)
Source: tcpdf.php:8531
RadialGradient()
public RadialGradient(
mixed $_x,
mixed $_y,
mixed $_w,
mixed $_h,
mixed $_col1 = [],
mixed $_col2 = [],
mixed $_coords = [0.5, 0.5, 0.5, 0.5, 1]
)
Parameters:
$_x(mixed)$_y(mixed)$_w(mixed)$_h(mixed)$_col1(mixed)$_col2(mixed)$_coords(mixed)
Source: tcpdf.php:6302
RadioButton()
public RadioButton(
mixed $_name,
mixed $_w,
mixed $_prop = [],
mixed $_opt = [],
mixed $_onvalue = 'On',
mixed $_checked = false,
mixed $_x = null,
mixed $_y = null,
mixed $_js = false
)
Parameters:
$_name(mixed)$_w(mixed)$_prop(mixed)$_opt(mixed)$_onvalue(mixed)$_checked(mixed)$_x(mixed)$_y(mixed)$_js(mixed)
Source: tcpdf.php:5653
Rect()
public Rect(
mixed $_x,
mixed $_y,
mixed $_w,
mixed $_h,
mixed $_style = '',
mixed $_border_style = [],
mixed $_fill_color = []
)
Parameters:
$_x(mixed)$_y(mixed)$_w(mixed)$_h(mixed)$_style(mixed)$_border_style(mixed)$_fill_color(mixed)
Source: tcpdf.php:5110
registrationMark()
public registrationMark(
mixed $_x,
mixed $_y,
mixed $_r,
mixed $_double = false,
mixed $_cola = [100, 100, 100, 100, 'All'],
mixed $_colb = [0, 0, 0, 0, 'None']
)
Parameters:
$_x(mixed)$_y(mixed)$_r(mixed)$_double(mixed)$_cola(mixed)$_colb(mixed)
Source: tcpdf.php:6263
registrationMarkCMYK()
public registrationMarkCMYK(mixed $_x, mixed $_y, mixed $_r)
Parameters:
$_x(mixed)$_y(mixed)$_r(mixed)
Source: tcpdf.php:6280
RegularPolygon()
public RegularPolygon(
mixed $_x0,
mixed $_y0,
mixed $_r,
mixed $_ns,
mixed $_angle = 0,
mixed $_draw_circle = false,
mixed $_style = '',
mixed $_line_style = [],
mixed $_fill_color = [],
mixed $_circle_style = '',
mixed $_circle_outLine_style = [],
mixed $_circle_fill_color = []
)
Parameters:
$_x0(mixed)$_y0(mixed)$_r(mixed)$_ns(mixed)$_angle(mixed)$_draw_circle(mixed)$_style(mixed)$_line_style(mixed)$_fill_color(mixed)$_circle_style(mixed)$_circle_outLine_style(mixed)$_circle_fill_color(mixed)
Source: tcpdf.php:5321
removePageRegion()
public removePageRegion(mixed $_key)
Parameters:
$_key(mixed)
Source: tcpdf.php:8634
replaceMissingChars()
public replaceMissingChars(
mixed $_text,
mixed $_font = '',
mixed $_style = '',
mixed $_subs = []
)
Parameters:
$_text(mixed)$_font(mixed)$_style(mixed)$_subs(mixed)
Source: tcpdf.php:3325
resetColumns()
public resetColumns()
Source: tcpdf.php:8258
resetHeaderTemplate()
public resetHeaderTemplate()
Source: tcpdf.php:2845
resetLastH()
public resetLastH()
Source: tcpdf.php:2285
rollbackTransaction()
public rollbackTransaction(mixed $_self = false)
Parameters:
$_self(mixed)
Source: tcpdf.php:8108
Rotate()
public Rotate(mixed $_angle, mixed $_x = null, mixed $_y = null)
Parameters:
$_angle(mixed)$_x(mixed)$_y(mixed)
Source: tcpdf.php:5016
RoundedRect()
public RoundedRect(
mixed $_x,
mixed $_y,
mixed $_w,
mixed $_h,
mixed $_r,
mixed $_round_corner = '1111',
mixed $_style = '',
mixed $_border_style = [],
mixed $_fill_color = []
)
Parameters:
$_x(mixed)$_y(mixed)$_w(mixed)$_h(mixed)$_r(mixed)$_round_corner(mixed)$_style(mixed)$_border_style(mixed)$_fill_color(mixed)
Source: tcpdf.php:5389
RoundedRectXY()
public RoundedRectXY(
mixed $_x,
mixed $_y,
mixed $_w,
mixed $_h,
mixed $_rx,
mixed $_ry,
mixed $_round_corner = '1111',
mixed $_style = '',
mixed $_border_style = [],
mixed $_fill_color = []
)
Parameters:
$_x(mixed)$_y(mixed)$_w(mixed)$_h(mixed)$_rx(mixed)$_ry(mixed)$_round_corner(mixed)$_style(mixed)$_border_style(mixed)$_fill_color(mixed)
Source: tcpdf.php:5403
Scale()
public Scale(mixed $_s_x, mixed $_s_y, mixed $_x = null, mixed $_y = null)
Parameters:
$_s_x(mixed)$_s_y(mixed)$_x(mixed)$_y(mixed)
Source: tcpdf.php:4957
ScaleX()
public ScaleX(mixed $_s_x, mixed $_x = '', mixed $_y = '')
Parameters:
$_s_x(mixed)$_x(mixed)$_y(mixed)
Source: tcpdf.php:4942
ScaleXY()
public ScaleXY(mixed $_s, mixed $_x = '', mixed $_y = '')
Parameters:
$_s(mixed)$_x(mixed)$_y(mixed)
Source: tcpdf.php:4952
ScaleY()
public ScaleY(mixed $_s_y, mixed $_x = '', mixed $_y = '')
Parameters:
$_s_y(mixed)$_x(mixed)$_y(mixed)
Source: tcpdf.php:4947
selectColumn()
public selectColumn(mixed $_col = null)
Parameters:
$_col(mixed)
Source: tcpdf.php:8328
serializeTCPDFtag()
public serializeTCPDFtag(mixed $_method, mixed $_params = [])
Parameters:
$_method(mixed)$_params(mixed)
Source: tcpdf.php:7320
setAbsX()
public setAbsX(mixed $_x)
Parameters:
$_x(mixed)
Source: tcpdf.php:4601
setAbsXY()
public setAbsXY(mixed $_x, mixed $_y)
Parameters:
$_x(mixed)$_y(mixed)
Source: tcpdf.php:4611
setAbsY()
public setAbsY(mixed $_y)
Parameters:
$_y(mixed)
Source: tcpdf.php:4606
setAllowLocalFiles()
public setAllowLocalFiles(mixed $_allowLocalFiles)
Parameters:
$_allowLocalFiles(mixed)
Source: tcpdf.php:2579
setAlpha()
public setAlpha(
mixed $_stroking = 1,
mixed $_bm = 'Normal',
mixed $_nonstroking = null,
mixed $_ais = false
)
Parameters:
$_stroking(mixed)$_bm(mixed)$_nonstroking(mixed)$_ais(mixed)
Source: tcpdf.php:6129
setAuthor()
public setAuthor(mixed $_author)
Parameters:
$_author(mixed)
Source: tcpdf.php:2564
setAutoPageBreak()
public setAutoPageBreak(mixed $_auto, mixed $_margin = 0)
Parameters:
$_auto(mixed)$_margin(mixed)
Source: tcpdf.php:2514
setBarcode()
public setBarcode(mixed $_bc = '')
Parameters:
$_bc(mixed)
Source: tcpdf.php:6593
setBooklet()
public setBooklet(mixed $_booklet = true, mixed $_inner = -1, mixed $_outer = -1)
Parameters:
$_booklet(mixed)$_inner(mixed)$_outer(mixed)
Source: tcpdf.php:7801
setBookmark()
public setBookmark(
mixed $_txt,
mixed $_level = 0,
mixed $_y = -1,
mixed $_page = '',
mixed $_style = '',
mixed $_color = [0, 0, 0],
mixed $_x = -1,
mixed $_link = ''
)
Parameters:
$_txt(mixed)$_level(mixed)$_y(mixed)$_page(mixed)$_style(mixed)$_color(mixed)$_x(mixed)$_link(mixed)
Source: tcpdf.php:5467
setCellHeightRatio()
public setCellHeightRatio(mixed $_h)
Parameters:
$_h(mixed)
Source: tcpdf.php:6172
setCellMargins()
public setCellMargins(
mixed $_left = null,
mixed $_top = null,
mixed $_right = null,
mixed $_bottom = null
)
Parameters:
$_left(mixed)$_top(mixed)$_right(mixed)$_bottom(mixed)
Source: tcpdf.php:2480
setCellPadding()
public setCellPadding(mixed $_pad)
Parameters:
$_pad(mixed)
Source: tcpdf.php:2441
setCellPaddings()
public setCellPaddings(
mixed $_left = null,
mixed $_top = null,
mixed $_right = null,
mixed $_bottom = null
)
Parameters:
$_left(mixed)$_top(mixed)$_right(mixed)$_bottom(mixed)
Source: tcpdf.php:2446
setColor()
public setColor(
mixed $_type,
mixed $_col1 = 0,
mixed $_col2 = -1,
mixed $_col3 = -1,
mixed $_col4 = -1,
mixed $_ret = false,
mixed $_name = ''
)
Parameters:
$_type(mixed)$_col1(mixed)$_col2(mixed)$_col3(mixed)$_col4(mixed)$_ret(mixed)$_name(mixed)
Source: tcpdf.php:3035
setColorArray()
public setColorArray(mixed $_type, mixed $_color, mixed $_ret = false)
Parameters:
$_type(mixed)$_color(mixed)$_ret(mixed)
Source: tcpdf.php:3005
setColumnsArray()
public setColumnsArray(mixed $_columns)
Parameters:
$_columns(mixed)
Source: tcpdf.php:8280
setCompression()
public setCompression(mixed $_compress = true)
Parameters:
$_compress(mixed)
Source: tcpdf.php:2538
setCreator()
public setCreator(mixed $_creator)
Parameters:
$_creator(mixed)
Source: tcpdf.php:2574
setDefaultMonospacedFont()
public setDefaultMonospacedFont(mixed $_font)
Parameters:
$_font(mixed)
Source: tcpdf.php:3347
setDefaultTableColumns()
public setDefaultTableColumns(mixed $_cols = 4)
Parameters:
$_cols(mixed)
Source: tcpdf.php:6167
setDestination()
public setDestination(mixed $_name, mixed $_y = -1, mixed $_page = '', mixed $_x = -1)
Parameters:
$_name(mixed)$_y(mixed)$_page(mixed)$_x(mixed)
Source: tcpdf.php:5447
setDisplayMode()
public setDisplayMode(
mixed $_zoom,
mixed $_layout = 'SinglePage',
mixed $_mode = 'UseNone'
)
Parameters:
$_zoom(mixed)$_layout(mixed)$_mode(mixed)
Source: tcpdf.php:2531
setDocCreationTimestamp()
public setDocCreationTimestamp(mixed $_time)
Parameters:
$_time(mixed)
Source: tcpdf.php:4740
setDocInfoUnicode()
public setDocInfoUnicode(mixed $_unicode = true)
Parameters:
$_unicode(mixed)
Source: tcpdf.php:2549
setDocModificationTimestamp()
public setDocModificationTimestamp(mixed $_time)
Parameters:
$_time(mixed)
Source: tcpdf.php:4745
setDrawColor()
public setDrawColor(
mixed $_col1 = 0,
mixed $_col2 = -1,
mixed $_col3 = -1,
mixed $_col4 = -1,
mixed $_ret = false,
mixed $_name = ''
)
Parameters:
$_col1(mixed)$_col2(mixed)$_col3(mixed)$_col4(mixed)$_ret(mixed)$_name(mixed)
Source: tcpdf.php:3068
setDrawColorArray()
public setDrawColorArray(mixed $_color, mixed $_ret = false)
Parameters:
$_color(mixed)$_ret(mixed)
Source: tcpdf.php:3020
setDrawSpotColor()
public setDrawSpotColor(mixed $_name, mixed $_tint = 100)
Parameters:
$_name(mixed)$_tint(mixed)
Source: tcpdf.php:2990
setEqualColumns()
public setEqualColumns(mixed $_numcols = 0, mixed $_width = 0, mixed $_y = null)
Parameters:
$_numcols(mixed)$_width(mixed)$_y(mixed)
Source: tcpdf.php:8236
setExtraXMP()
public setExtraXMP(mixed $_xmp)
Parameters:
$_xmp(mixed)
Source: tcpdf.php:4725
setExtraXMPPdfaextension()
public setExtraXMPPdfaextension(mixed $_xmp)
Parameters:
$_xmp(mixed)
Source: tcpdf.php:4735
setExtraXMPRDF()
public setExtraXMPRDF(mixed $_xmp)
Parameters:
$_xmp(mixed)
Source: tcpdf.php:4730
setFillColor()
public setFillColor(
mixed $_col1 = 0,
mixed $_col2 = -1,
mixed $_col3 = -1,
mixed $_col4 = -1,
mixed $_ret = false,
mixed $_name = ''
)
Parameters:
$_col1(mixed)$_col2(mixed)$_col3(mixed)$_col4(mixed)$_ret(mixed)$_name(mixed)
Source: tcpdf.php:3073
setFillColorArray()
public setFillColorArray(mixed $_color, mixed $_ret = false)
Parameters:
$_color(mixed)$_ret(mixed)
Source: tcpdf.php:3025
setFillSpotColor()
public setFillSpotColor(mixed $_name, mixed $_tint = 100)
Parameters:
$_name(mixed)$_tint(mixed)
Source: tcpdf.php:2995
setFont()
public setFont(
mixed $_family,
mixed $_style = '',
mixed $_size = null,
mixed $_fontfile = '',
mixed $_subset = 'default',
mixed $_out = true
)
Parameters:
$_family(mixed)$_style(mixed)$_size(mixed)$_fontfile(mixed)$_subset(mixed)$_out(mixed)
Source: tcpdf.php:3210
setFontSize()
public setFontSize(mixed $_size, mixed $_out = true)
Parameters:
$_size(mixed)$_out(mixed)
Source: tcpdf.php:3266
setFontSpacing()
public setFontSpacing(mixed $_spacing = 0)
Parameters:
$_spacing(mixed)
Source: tcpdf.php:8572
setFontStretching()
public setFontStretching(mixed $_perc = 100)
Parameters:
$_perc(mixed)
Source: tcpdf.php:8558
setFontSubsetting()
public setFontSubsetting(mixed $_enable = true)
Parameters:
$_enable(mixed)
Source: tcpdf.php:8463
setFooterData()
public setFooterData(mixed $_tc = [0, 0, 0], mixed $_lc = [0, 0, 0])
Parameters:
$_tc(mixed)$_lc(mixed)
Source: tcpdf.php:2771
setFooterFont()
public setFooterFont(mixed $_font)
Parameters:
$_font(mixed)
Source: tcpdf.php:4778
setFooterMargin()
public setFooterMargin(mixed $_fm = 10)
Parameters:
$_fm(mixed)
Source: tcpdf.php:2800
setFormDefaultProp()
public setFormDefaultProp(mixed $_prop = [])
Parameters:
$_prop(mixed)
Source: tcpdf.php:5524
setHeaderData()
public setHeaderData(
mixed $_ln = '',
mixed $_lw = 0,
mixed $_ht = '',
mixed $_hs = '',
mixed $_tc = [0, 0, 0],
mixed $_lc = [0, 0, 0]
)
Parameters:
$_ln(mixed)$_lw(mixed)$_ht(mixed)$_hs(mixed)$_tc(mixed)$_lc(mixed)
Source: tcpdf.php:2759
setHeaderFont()
public setHeaderFont(mixed $_font)
Parameters:
$_font(mixed)
Source: tcpdf.php:4760
setHeaderMargin()
public setHeaderMargin(mixed $_hm = 10)
Parameters:
$_hm(mixed)
Source: tcpdf.php:2787
setHeaderTemplateAutoreset()
public setHeaderTemplateAutoreset(mixed $_val = true)
Parameters:
$_val(mixed)
Source: tcpdf.php:2850
setHtmlLinksStyle()
public setHtmlLinksStyle(mixed $_color = [0, 0, 255], mixed $_fontstyle = 'U')
Parameters:
$_color(mixed)$_fontstyle(mixed)
Source: tcpdf.php:7853
setHtmlVSpace()
public setHtmlVSpace(mixed $_tagvs)
Parameters:
$_tagvs(mixed)
Source: tcpdf.php:7813
setImageScale()
public setImageScale(mixed $_scale)
Parameters:
$_scale(mixed)
Source: tcpdf.php:2298
setJPEGQuality()
public setJPEGQuality(mixed $_quality)
Parameters:
$_quality(mixed)
Source: tcpdf.php:6161
setKeywords()
public setKeywords(mixed $_keywords)
Parameters:
$_keywords(mixed)
Source: tcpdf.php:2569
setLanguageArray()
public setLanguageArray(mixed $_language)
Parameters:
$_language(mixed)
Source: tcpdf.php:4796
setLastH()
public setLastH(mixed $_h)
Parameters:
$_h(mixed)
Source: tcpdf.php:2262
setLeftMargin()
public setLeftMargin(mixed $_margin)
Parameters:
$_margin(mixed)
Source: tcpdf.php:2420
setLineStyle()
public setLineStyle(mixed $_style, mixed $_ret = false)
Parameters:
$_style(mixed)$_ret(mixed)
Source: tcpdf.php:5070
setLineWidth()
public setLineWidth(mixed $_width)
Parameters:
$_width(mixed)
Source: tcpdf.php:5056
setLink()
public setLink(mixed $_link, mixed $_y = 0, mixed $_page = -1)
Parameters:
$_link(mixed)$_y(mixed)$_page(mixed)
Source: tcpdf.php:3366
setListIndentWidth()
public setListIndentWidth(mixed $_width)
Parameters:
$_width(mixed)
Source: tcpdf.php:7843
setLIsymbol()
public setLIsymbol(mixed $_symbol = '!')
Parameters:
$_symbol(mixed)
Source: tcpdf.php:7796
setMargins()
public setMargins(
mixed $_left,
mixed $_top,
mixed $_right = null,
mixed $_keepmargins = false
)
Parameters:
$_left(mixed)$_top(mixed)$_right(mixed)$_keepmargins(mixed)
Source: tcpdf.php:2402
setOpenCell()
public setOpenCell(mixed $_isopen)
Parameters:
$_isopen(mixed)
Source: tcpdf.php:7848
setOverprint()
public setOverprint(mixed $_stroking = true, mixed $_nonstroking = null, mixed $_mode = 0)
Parameters:
$_stroking(mixed)$_nonstroking(mixed)$_mode(mixed)
Source: tcpdf.php:6110
setPage()
public setPage(mixed $_pnum, mixed $_resetmargins = false)
Parameters:
$_pnum(mixed)$_resetmargins(mixed)
Source: tcpdf.php:2646
setPageMark()
public setPageMark()
Source: tcpdf.php:2752
setPageOrientation()
public setPageOrientation(
mixed $_orientation,
mixed $_autopagebreak = null,
mixed $_bottommargin = null
)
Parameters:
$_orientation(mixed)$_autopagebreak(mixed)$_bottommargin(mixed)
Source: tcpdf.php:2208
setPageRegions()
public setPageRegions(mixed $_regions = [])
Parameters:
$_regions(mixed)
Source: tcpdf.php:8595
setPageUnit()
public setPageUnit(mixed $_unit)
Parameters:
$_unit(mixed)
Source: tcpdf.php:2194
setPDFVersion()
public setPDFVersion(mixed $_version = '1.7')
Parameters:
$_version(mixed)
Source: tcpdf.php:6185
setPrintFooter()
public setPrintFooter(mixed $_val = true)
Parameters:
$_val(mixed)
Source: tcpdf.php:2818
setPrintHeader()
public setPrintHeader(mixed $_val = true)
Parameters:
$_val(mixed)
Source: tcpdf.php:2813
setProtection()
public setProtection(
mixed $_permissions = ['print', 'modify', 'copy', 'annot-forms', 'fill-forms', 'ex…,
mixed $_user_pass = '',
mixed $_owner_pass = null,
mixed $_mode = 0,
mixed $_pubkeys = null
)
Parameters:
$_permissions(mixed)$_user_pass(mixed)$_owner_pass(mixed)$_mode(mixed)$_pubkeys(mixed)
Source: tcpdf.php:4870
setRasterizeVectorImages()
public setRasterizeVectorImages(mixed $_mode)
Parameters:
$_mode(mixed)
Source: tcpdf.php:8458
setRightMargin()
public setRightMargin(mixed $_margin)
Parameters:
$_margin(mixed)
Source: tcpdf.php:2436
setRTL()
public setRTL(mixed $_enable, mixed $_resetx = true)
Parameters:
$_enable(mixed)$_resetx(mixed)
Source: tcpdf.php:2225
setSignature()
public setSignature(
mixed $_signing_cert = '',
mixed $_private_key = '',
mixed $_private_key_password = '',
mixed $_extracerts = '',
mixed $_cert_type = 2,
mixed $_info = [],
mixed $_approval = ''
)
Parameters:
$_signing_cert(mixed)$_private_key(mixed)$_private_key_password(mixed)$_extracerts(mixed)$_cert_type(mixed)$_info(mixed)$_approval(mixed)
Source: tcpdf.php:5868
setSignatureAppearance()
public setSignatureAppearance(
mixed $_x = 0,
mixed $_y = 0,
mixed $_w = 0,
mixed $_h = 0,
mixed $_page = -1,
mixed $_name = ''
)
Parameters:
$_x(mixed)$_y(mixed)$_w(mixed)$_h(mixed)$_page(mixed)$_name(mixed)
Source: tcpdf.php:5907
setSpacesRE()
public setSpacesRE(mixed $_re = '/[^\S\xa0]/')
Parameters:
$_re(mixed)
Source: tcpdf.php:2220
setSpotColor()
public setSpotColor(mixed $_type, mixed $_name, mixed $_tint = 100)
Parameters:
$_type(mixed)$_name(mixed)$_tint(mixed)
Source: tcpdf.php:2965
setSRGBmode()
public setSRGBmode(mixed $_mode = false)
Parameters:
$_mode(mixed)
Source: tcpdf.php:2544
setStartingPageNumber()
public setStartingPageNumber(mixed $_num = 1)
Parameters:
$_num(mixed)
Source: tcpdf.php:5963
setSubject()
public setSubject(mixed $_subject)
Parameters:
$_subject(mixed)
Source: tcpdf.php:2559
setTempRTL()
public setTempRTL(mixed $_mode)
Parameters:
$_mode(mixed)
Source: tcpdf.php:2242
setTextColor()
public setTextColor(
mixed $_col1 = 0,
mixed $_col2 = -1,
mixed $_col3 = -1,
mixed $_col4 = -1,
mixed $_ret = false,
mixed $_name = ''
)
Parameters:
$_col1(mixed)$_col2(mixed)$_col3(mixed)$_col4(mixed)$_ret(mixed)$_name(mixed)
Source: tcpdf.php:3078
setTextColorArray()
public setTextColorArray(mixed $_color, mixed $_ret = false)
Parameters:
$_color(mixed)$_ret(mixed)
Source: tcpdf.php:3030
setTextRenderingMode()
public setTextRenderingMode(mixed $_stroke = 0, mixed $_fill = true, mixed $_clip = false)
Parameters:
$_stroke(mixed)$_fill(mixed)$_clip(mixed)
Source: tcpdf.php:8384
setTextShadow()
public setTextShadow(
mixed $_params = ['enabled' => false, 'depth_w' => 0, 'depth_h' => 0, 'color'…
)
Parameters:
$_params(mixed)
Source: tcpdf.php:8393
setTextSpotColor()
public setTextSpotColor(mixed $_name, mixed $_tint = 100)
Parameters:
$_name(mixed)$_tint(mixed)
Source: tcpdf.php:3000
setTimeStamp()
public setTimeStamp(
mixed $_tsa_host = '',
mixed $_tsa_username = '',
mixed $_tsa_password = '',
mixed $_tsa_cert = ''
)
Parameters:
$_tsa_host(mixed)$_tsa_username(mixed)$_tsa_password(mixed)$_tsa_cert(mixed)
Source: tcpdf.php:5931
setTitle()
public setTitle(mixed $_title)
Parameters:
$_title(mixed)
Source: tcpdf.php:2554
setTopMargin()
public setTopMargin(mixed $_margin)
Parameters:
$_margin(mixed)
Source: tcpdf.php:2428
setUserRights()
public setUserRights(
mixed $_enable = true,
mixed $_document = '/FullSave',
mixed $_annots = '/Create/Delete/Modify/Copy/Import/Export',
mixed $_form = '/Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemp…,
mixed $_signature = '/Modify',
mixed $_ef = '/Create/Delete/Modify/Import',
mixed $_formex = ''
)
Parameters:
$_enable(mixed)$_document(mixed)$_annots(mixed)$_form(mixed)$_signature(mixed)$_ef(mixed)$_formex(mixed)
Source: tcpdf.php:5848
setViewerPreferences()
public setViewerPreferences(mixed $_preferences)
Parameters:
$_preferences(mixed)
Source: tcpdf.php:6190
setVisibility()
public setVisibility(mixed $_v)
Parameters:
$_v(mixed)
Source: tcpdf.php:6092
setX()
public setX(mixed $_x, mixed $_rtloff = false)
Parameters:
$_x(mixed)$_rtloff(mixed)
Source: tcpdf.php:4575
setXY()
public setXY(mixed $_x, mixed $_y, mixed $_rtloff = false)
Parameters:
$_x(mixed)$_y(mixed)$_rtloff(mixed)
Source: tcpdf.php:4595
setY()
public setY(mixed $_y, mixed $_resetx = true, mixed $_rtloff = false)
Parameters:
$_y(mixed)$_resetx(mixed)$_rtloff(mixed)
Source: tcpdf.php:4586
Skew()
public Skew(mixed $_angle_x, mixed $_angle_y, mixed $_x = null, mixed $_y = null)
Parameters:
$_angle_x(mixed)$_angle_y(mixed)$_x(mixed)$_y(mixed)
Source: tcpdf.php:5035
SkewX()
public SkewX(mixed $_angle_x, mixed $_x = null, mixed $_y = null)
Parameters:
$_angle_x(mixed)$_x(mixed)$_y(mixed)
Source: tcpdf.php:5025
SkewY()
public SkewY(mixed $_angle_y, mixed $_x = null, mixed $_y = null)
Parameters:
$_angle_y(mixed)$_x(mixed)$_y(mixed)
Source: tcpdf.php:5030
StarPolygon()
public StarPolygon(
mixed $_x0,
mixed $_y0,
mixed $_r,
mixed $_nv,
mixed $_ng,
mixed $_angle = 0,
mixed $_draw_circle = false,
mixed $_style = '',
mixed $_line_style = [],
mixed $_fill_color = [],
mixed $_circle_style = '',
mixed $_circle_outLine_style = [],
mixed $_circle_fill_color = []
)
Parameters:
$_x0(mixed)$_y0(mixed)$_r(mixed)$_nv(mixed)$_ng(mixed)$_angle(mixed)$_draw_circle(mixed)$_style(mixed)$_line_style(mixed)$_fill_color(mixed)$_circle_style(mixed)$_circle_outLine_style(mixed)$_circle_fill_color(mixed)
Source: tcpdf.php:5355
startLayer()
public startLayer(
mixed $_name = '',
mixed $_print = true,
mixed $_view = true,
mixed $_lock = true
)
Parameters:
$_name(mixed)$_print(mixed)$_view(mixed)$_lock(mixed)
Source: tcpdf.php:6078
startPage()
public startPage(mixed $_orientation = '', mixed $_format = '', mixed $_tocpage = false)
Parameters:
$_orientation(mixed)$_format(mixed)$_tocpage(mixed)
Source: tcpdf.php:2726
startPageGroup()
public startPageGroup(mixed $_page = null)
Parameters:
$_page(mixed)
Source: tcpdf.php:5956
startTemplate()
public startTemplate(mixed $_w = 0, mixed $_h = 0, mixed $_group = false)
Parameters:
$_w(mixed)$_h(mixed)$_group(mixed)
Source: tcpdf.php:8505
startTransaction()
public startTransaction()
Source: tcpdf.php:8074
StartTransform()
public StartTransform()
Source: tcpdf.php:4932
StopTransform()
public StopTransform()
Source: tcpdf.php:4937
stringLeftTrim()
public stringLeftTrim(mixed $_str, mixed $_replace = '')
Parameters:
$_str(mixed)$_replace(mixed)
Source: tcpdf.php:8476
stringRightTrim()
public stringRightTrim(mixed $_str, mixed $_replace = '')
Parameters:
$_str(mixed)$_replace(mixed)
Source: tcpdf.php:8481
stringTrim()
public stringTrim(mixed $_str, mixed $_replace = '')
Parameters:
$_str(mixed)$_replace(mixed)
Source: tcpdf.php:8486
Text()
public Text(
mixed $_x,
mixed $_y,
mixed $_txt,
mixed $_fstroke = 0,
mixed $_fclip = false,
mixed $_ffill = true,
mixed $_border = 0,
mixed $_ln = 0,
mixed $_align = '',
mixed $_fill = false,
mixed $_link = '',
mixed $_stretch = 0,
mixed $_ignore_min_height = false,
mixed $_calign = 'T',
mixed $_valign = 'M',
mixed $_rtloff = false
)
Parameters:
$_x(mixed)$_y(mixed)$_txt(mixed)$_fstroke(mixed)$_fclip(mixed)$_ffill(mixed)$_border(mixed)$_ln(mixed)$_align(mixed)$_fill(mixed)$_link(mixed)$_stretch(mixed)$_ignore_min_height(mixed)$_calign(mixed)$_valign(mixed)$_rtloff(mixed)
Source: tcpdf.php:3439
TextField()
public TextField(
mixed $_name,
mixed $_w,
mixed $_h,
mixed $_prop = [],
mixed $_opt = [],
mixed $_x = null,
mixed $_y = null,
mixed $_js = false
)
Parameters:
$_name(mixed)$_w(mixed)$_h(mixed)$_prop(mixed)$_opt(mixed)$_x(mixed)$_y(mixed)$_js(mixed)
Source: tcpdf.php:5634
Translate()
public Translate(mixed $_t_x, mixed $_t_y)
Parameters:
$_t_x(mixed)$_t_y(mixed)
Source: tcpdf.php:5011
TranslateX()
public TranslateX(mixed $_t_x)
Parameters:
$_t_x(mixed)
Source: tcpdf.php:5001
TranslateY()
public TranslateY(mixed $_t_y)
Parameters:
$_t_y(mixed)
Source: tcpdf.php:5006
unhtmlentities()
public unhtmlentities(mixed $_text_to_convert)
Parameters:
$_text_to_convert(mixed)
Source: tcpdf.php:4861
Write()
public Write(
mixed $_h,
mixed $_txt,
mixed $_link = '',
mixed $_fill = false,
mixed $_align = '',
mixed $_ln = false,
mixed $_stretch = 0,
mixed $_firstline = false,
mixed $_firstblock = false,
mixed $_maxh = 0,
mixed $_wadj = 0,
mixed $_margin = null
)
Parameters:
$_h(mixed)$_txt(mixed)$_link(mixed)$_fill(mixed)$_align(mixed)$_ln(mixed)$_stretch(mixed)$_firstline(mixed)$_firstblock(mixed)$_maxh(mixed)$_wadj(mixed)$_margin(mixed)
Source: tcpdf.php:4121
write1DBarcode()
public write1DBarcode(
mixed $_code,
mixed $_type,
mixed $_x = null,
mixed $_y = null,
mixed $_w = null,
mixed $_h = null,
mixed $_xres = null,
mixed $_style = [],
mixed $_align = ''
)
Parameters:
$_code(mixed)$_type(mixed)$_x(mixed)$_y(mixed)$_w(mixed)$_h(mixed)$_xres(mixed)$_style(mixed)$_align(mixed)
Source: tcpdf.php:6606
write2DBarcode()
public write2DBarcode(
mixed $_code,
mixed $_type,
mixed $_x = null,
mixed $_y = null,
mixed $_w = null,
mixed $_h = null,
mixed $_style = [],
mixed $_align = '',
mixed $_distort = false
)
Parameters:
$_code(mixed)$_type(mixed)$_x(mixed)$_y(mixed)$_w(mixed)$_h(mixed)$_style(mixed)$_align(mixed)$_distort(mixed)
Source: tcpdf.php:6632
writeHTML()
public writeHTML(
mixed $_html,
mixed $_ln = true,
mixed $_fill = false,
mixed $_reseth = false,
mixed $_cell = false,
mixed $_align = ''
)
Parameters:
$_html(mixed)$_ln(mixed)$_fill(mixed)$_reseth(mixed)$_cell(mixed)$_align(mixed)
Source: tcpdf.php:7784
writeHTMLCell()
public writeHTMLCell(
mixed $_w,
mixed $_h,
mixed $_x,
mixed $_y,
mixed $_html = '',
mixed $_border = 0,
mixed $_ln = 0,
mixed $_fill = false,
mixed $_reseth = true,
mixed $_align = '',
mixed $_autopadding = true
)
Parameters:
$_w(mixed)$_h(mixed)$_x(mixed)$_y(mixed)$_html(mixed)$_border(mixed)$_ln(mixed)$_fill(mixed)$_reseth(mixed)$_align(mixed)$_autopadding(mixed)
Source: tcpdf.php:7327