Table of contents
class TCPDF
Source: tcpdf.php:42
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:360
__destruct()
public __destruct()
Source: tcpdf.php:406
__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:415
__isset()
public __isset(mixed $name)
Parameters:
$name(mixed)
See: __get()
Source: tcpdf.php:448
AcceptPageBreak()
public AcceptPageBreak(): bool
Returns: bool: True when an automatic page break is allowed.
Source: tcpdf.php:3549
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:6011
AddFont()
public AddFont(
mixed $_family,
mixed $_style = '',
mixed $_fontfile = '',
mixed $_subset = 'default'
)
Parameters:
$_family(mixed)$_style(mixed)$_fontfile(mixed)$_subset(mixed)
Source: tcpdf.php:3260
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:4912
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:8299
addJavascriptObject()
public addJavascriptObject(mixed $_script, mixed $_onload = false)
Parameters:
$_script(mixed)$_onload(mixed)
Source: tcpdf.php:5611
AddLink()
public AddLink()
Source: tcpdf.php:3428
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:2773
addPageRegion()
public addPageRegion(mixed $_region)
Parameters:
$_region(mixed)
Source: tcpdf.php:8844
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:3025
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:8185
addTOCPage()
public addTOCPage(
mixed $_orientation = '',
mixed $_format = '',
mixed $_keepmargins = false
)
Parameters:
$_orientation(mixed)$_format(mixed)$_keepmargins(mixed)
Source: tcpdf.php:2763
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:3458
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:5521
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:5572
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:5877
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:3554
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:5840
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:5356
Close()
public Close()
Source: tcpdf.php:2675
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:6293
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:5811
commitTransaction()
public commitTransaction()
Source: tcpdf.php:8339
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:6411
copyPage()
public copyPage(mixed $_page = 0)
Parameters:
$_page(mixed)
Source: tcpdf.php:8161
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:6341
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:5274
deletePage()
public deletePage(mixed $_page)
Parameters:
$_page(mixed)
Source: tcpdf.php:8150
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:5323
EmbedFile()
public EmbedFile(mixed $_opt)
Parameters:
$_opt(mixed)
Source: tcpdf.php:3486
EmbedFileFromString()
public EmbedFileFromString(mixed $_filename, mixed $_content)
Parameters:
$_filename(mixed)$_content(mixed)
Source: tcpdf.php:3502
endLayer()
public endLayer()
Source: tcpdf.php:6176
endPage()
public endPage(mixed $_tocpage = false)
Parameters:
$_tocpage(mixed)
Source: tcpdf.php:2789
endTemplate()
public endTemplate()
Source: tcpdf.php:8757
endTOCPage()
public endTOCPage()
Source: tcpdf.php:2768
Error()
public Error(mixed $_msg)
Parameters:
$_msg(mixed)
Source: tcpdf.php:2657
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:7358
Footer()
public Footer()
Source: tcpdf.php:2985
getAbsFontMeasure()
public getAbsFontMeasure(mixed $_s)
Parameters:
$_s(mixed)
Source: tcpdf.php:3350
GetAbsX()
public GetAbsX(): float
Returns: float: Absolute X coordinate of the cursor in user units.
Source: tcpdf.php:4654
getAliasNbPages()
public getAliasNbPages(): string
Returns: string: Total number of pages, or the legacy alias placeholder.
Source: tcpdf.php:6071
getAliasNumPage()
public getAliasNumPage(): string
Returns: string: Current page number, or the legacy alias placeholder.
Source: tcpdf.php:6083
getAliasRightShift()
public getAliasRightShift(): string
Returns: string: Right-shift compensation prefix (unused by the facade).
Source: tcpdf.php:6063
getAllSpotColors()
public getAllSpotColors()
Source: tcpdf.php:3020
getAlpha()
public getAlpha()
Source: tcpdf.php:6248
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:3192
getAutoPageBreak()
public getAutoPageBreak(): bool
Returns: bool: Automatic page break state.
Source: tcpdf.php:2598
getBarcode()
public getBarcode(): string
Returns: string: Document barcode string.
Source: tcpdf.php:6693
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:2455
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:2347
getCellHeightRatio()
public getCellHeightRatio(): float
Returns: float: Cell height ratio.
Source: tcpdf.php:6272
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:2581
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:2547
getCharBBox()
public getCharBBox(mixed $_char)
Parameters:
$_char(mixed)
Source: tcpdf.php:3355
GetCharWidth()
public GetCharWidth(mixed $_char, mixed $_notlast = true)
Parameters:
$_char(mixed)$_notlast(mixed)
Source: tcpdf.php:3238
getColumn()
public getColumn()
Source: tcpdf.php:8598
getCSSBorderMargin()
public getCSSBorderMargin(mixed $_cssbspace, mixed $_width = 0)
Parameters:
$_cssbspace(mixed)$_width(mixed)
Source: tcpdf.php:7373
getCSSMargin()
public getCSSMargin(mixed $_cssmargin, mixed $_width = 0)
Parameters:
$_cssmargin(mixed)$_width(mixed)
Source: tcpdf.php:7368
getCSSPadding()
public getCSSPadding(mixed $_csspadding, mixed $_width = 0)
Parameters:
$_csspadding(mixed)$_width(mixed)
Source: tcpdf.php:7363
getDestination()
public getDestination()
Source: tcpdf.php:5554
getDocCreationTimestamp()
public getDocCreationTimestamp()
Source: tcpdf.php:4842
getDocModificationTimestamp()
public getDocModificationTimestamp()
Source: tcpdf.php:4847
getFontAscent()
public getFontAscent(mixed $_font, mixed $_style = '', mixed $_size = 0)
Parameters:
$_font(mixed)$_style(mixed)$_size(mixed)
Source: tcpdf.php:3371
getFontBBox()
public getFontBBox()
Source: tcpdf.php:3343
getFontDescent()
public getFontDescent(mixed $_font, mixed $_style = '', mixed $_size = 0)
Parameters:
$_font(mixed)$_style(mixed)$_size(mixed)
Source: tcpdf.php:3362
getFontFamily()
public getFontFamily(): string
Returns: string: Current font family.
Source: tcpdf.php:7341
getFontFamilyName()
public getFontFamilyName(mixed $_fontfamily)
Parameters:
$_fontfamily(mixed)
Source: tcpdf.php:8734
getFontSize()
public getFontSize(): float
Returns: float: Current font size in user units.
Source: tcpdf.php:7325
getFontSizePt()
public getFontSizePt(): float
Returns: float: Current font size in points.
Source: tcpdf.php:7333
getFontSpacing()
public getFontSpacing(): float
Returns: float: Extra font spacing in user units.
Source: tcpdf.php:8819
getFontStretching()
public getFontStretching(): float
Returns: float: Font stretching percentage.
Source: tcpdf.php:8805
getFontStyle()
public getFontStyle(): string
Returns: string: Current font style letters including decorations.
Source: tcpdf.php:7349
getFontSubsetting()
public getFontSubsetting(): bool
Returns: bool: Default font subsetting mode.
Source: tcpdf.php:8709
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:4883
getFooterMargin()
public getFooterMargin(): float
Returns: float: Footer margin in user units.
Source: tcpdf.php:2880
getFormDefaultProp()
public getFormDefaultProp()
Source: tcpdf.php:5626
getGroupPageNo()
public getGroupPageNo(): int
Returns: int: Current page number within its page group.
Source: tcpdf.php:6130
getGroupPageNoFormatted()
public getGroupPageNoFormatted()
Source: tcpdf.php:6156
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:2854
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:4865
getHeaderMargin()
public getHeaderMargin(): float
Returns: float: Header margin in user units.
Source: tcpdf.php:2867
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:7403
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:8097
getImageRBX()
public getImageRBX(): float
Returns: float: Right-bottom X coordinate of the last inserted image.
Source: tcpdf.php:2904
getImageRBY()
public getImageRBY(): float
Returns: float: Right-bottom Y coordinate of the last inserted image.
Source: tcpdf.php:2912
getImageScale()
public getImageScale(): float
Returns: float: Image scale ratio.
Source: tcpdf.php:2378
getLastH()
public getLastH(): float
Returns: float: Height of the last printed cell in user units.
Source: tcpdf.php:2365
GetLineWidth()
public GetLineWidth(): float
Returns: float: Current line width in user units.
Source: tcpdf.php:5157
getMargins()
public getMargins()
Source: tcpdf.php:7297
getNumberOfColumns()
public getNumberOfColumns()
Source: tcpdf.php:8607
GetNumChars()
public GetNumChars(mixed $_s)
Parameters:
$_s(mixed)
Source: tcpdf.php:3255
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:4077
getNumPages()
public getNumPages(): int
Returns: int: Total number of pages.
Source: tcpdf.php:2754
getOriginalMargins()
public getOriginalMargins()
Source: tcpdf.php:7314
getOverprint()
public getOverprint()
Source: tcpdf.php:6216
getPage()
public getPage(): int
Returns: int: Current page number (1-based, 0 when no page exists).
Source: tcpdf.php:2742
getPageDimensions()
public getPageDimensions(mixed $_pagenum = null)
Parameters:
$_pagenum(mixed)
Source: tcpdf.php:2383
getPageGroupAlias()
public getPageGroupAlias(): string
Returns: string: Total pages in the current group, or the legacy alias placeholder.
Source: tcpdf.php:6095
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:2433
getPageNumGroupAlias()
public getPageNumGroupAlias(): string
Returns: string: Page number in the current group, or the legacy alias placeholder.
Source: tcpdf.php:6118
getPageRegions()
public getPageRegions()
Source: tcpdf.php:8828
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:2411
getPDFData()
public getPDFData()
Source: tcpdf.php:4797
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:4812
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:3249
getRTL()
public getRTL(): bool
Returns: bool: Current RTL document direction.
Source: tcpdf.php:2309
getScaleFactor()
public getScaleFactor(): float
Returns: float: Document scale factor (number of points in user unit).
Source: tcpdf.php:2469
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:4104
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:3170
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:8652
GetX()
public GetX(): float
Returns: float: Relative X coordinate of the cursor in user units.
Source: tcpdf.php:4646
GetY()
public GetY(): float
Returns: float: Y coordinate of the cursor in user units.
Source: tcpdf.php:4662
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:6535
Header()
public Header()
Source: tcpdf.php:2927
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:8657
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:4375
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:6638
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:8984
IncludeJS()
public IncludeJS(mixed $_script)
Parameters:
$_script(mixed)
Source: tcpdf.php:5606
isCharDefined()
public isCharDefined(mixed $_char, mixed $_font = '', mixed $_style = '')
Parameters:
$_char(mixed)$_font(mixed)$_style(mixed)
Source: tcpdf.php:3380
isRTLTextDir()
public isRTLTextDir(): bool
Returns: bool: True when the current text direction is right-to-left.
Source: tcpdf.php:2329
isUnicodeFont()
public isUnicodeFont()
Source: tcpdf.php:8729
lastPage()
public lastPage(mixed $_resetmargins = false)
Parameters:
$_resetmargins(mixed)
Source: tcpdf.php:2734
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:5183
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:6377
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:3453
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:5782
Ln()
public Ln(mixed $_h = null, mixed $_cell = false)
Parameters:
$_h(mixed)$_cell(mixed)
Source: tcpdf.php:4633
MirrorH()
public MirrorH(mixed $_x = null)
Parameters:
$_x(mixed)
Source: tcpdf.php:5066
MirrorL()
public MirrorL(mixed $_angle = 0, mixed $_x = null, mixed $_y = null)
Parameters:
$_angle(mixed)$_x(mixed)$_y(mixed)
Source: tcpdf.php:5084
MirrorP()
public MirrorP(mixed $_x = null, mixed $_y = null)
Parameters:
$_x(mixed)$_y(mixed)
Source: tcpdf.php:5076
MirrorV()
public MirrorV(mixed $_y = null)
Parameters:
$_y(mixed)
Source: tcpdf.php:5071
movePage()
public movePage(mixed $_frompage, mixed $_topage)
Parameters:
$_frompage(mixed)$_topage(mixed)
Source: tcpdf.php:8138
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:3755
Open()
public Open()
Source: tcpdf.php:2670
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:4728
PageNo()
public PageNo(): int
Returns: int: Current page number.
Source: tcpdf.php:3011
PageNoFormatted()
public PageNoFormatted()
Source: tcpdf.php:6161
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:6565
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:6589
pixelsToUnits()
public pixelsToUnits(mixed $_px)
Parameters:
$_px(mixed)
Source: tcpdf.php:4948
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:5302
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:5396
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:5380
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:8769
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:6394
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:5745
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:5202
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:6355
registrationMarkCMYK()
public registrationMarkCMYK(mixed $_x, mixed $_y, mixed $_r)
Parameters:
$_x(mixed)$_y(mixed)$_r(mixed)
Source: tcpdf.php:6372
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:5413
removePageRegion()
public removePageRegion(mixed $_key)
Parameters:
$_key(mixed)
Source: tcpdf.php:8872
replaceMissingChars()
public replaceMissingChars(
mixed $_text,
mixed $_font = '',
mixed $_style = '',
mixed $_subs = []
)
Parameters:
$_text(mixed)$_font(mixed)$_style(mixed)$_subs(mixed)
Source: tcpdf.php:3397
resetColumns()
public resetColumns()
Source: tcpdf.php:8494
resetHeaderTemplate()
public resetHeaderTemplate()
Source: tcpdf.php:2917
resetLastH()
public resetLastH()
Source: tcpdf.php:2357
rollbackTransaction()
public rollbackTransaction(mixed $_self = false)
Parameters:
$_self(mixed)
Source: tcpdf.php:8344
Rotate()
public Rotate(mixed $_angle, mixed $_x = null, mixed $_y = null)
Parameters:
$_angle(mixed)$_x(mixed)$_y(mixed)
Source: tcpdf.php:5108
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:5481
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:5495
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:5049
ScaleX()
public ScaleX(mixed $_s_x, mixed $_x = '', mixed $_y = '')
Parameters:
$_s_x(mixed)$_x(mixed)$_y(mixed)
Source: tcpdf.php:5034
ScaleXY()
public ScaleXY(mixed $_s, mixed $_x = '', mixed $_y = '')
Parameters:
$_s(mixed)$_x(mixed)$_y(mixed)
Source: tcpdf.php:5044
ScaleY()
public ScaleY(mixed $_s_y, mixed $_x = '', mixed $_y = '')
Parameters:
$_s_y(mixed)$_x(mixed)$_y(mixed)
Source: tcpdf.php:5039
selectColumn()
public selectColumn(mixed $_col = null)
Parameters:
$_col(mixed)
Source: tcpdf.php:8564
serializeTCPDFtag()
public serializeTCPDFtag(mixed $_method, mixed $_params = []): string
Parameters:
$_method(mixed)$_params(mixed)
Returns: string: Data attribute of a <tcpdf> tag, valid for this document only.
Source: tcpdf.php:7429
setAbsX()
public setAbsX(mixed $_x)
Parameters:
$_x(mixed)
Source: tcpdf.php:4693
setAbsXY()
public setAbsXY(mixed $_x, mixed $_y)
Parameters:
$_x(mixed)$_y(mixed)
Source: tcpdf.php:4703
setAbsY()
public setAbsY(mixed $_y)
Parameters:
$_y(mixed)
Source: tcpdf.php:4698
setAllowLocalFiles()
public setAllowLocalFiles(mixed $_allowLocalFiles)
Parameters:
$_allowLocalFiles(mixed)
Source: tcpdf.php:2651
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:6221
setAuthor()
public setAuthor(mixed $_author)
Parameters:
$_author(mixed)
Source: tcpdf.php:2636
setAutoPageBreak()
public setAutoPageBreak(mixed $_auto, mixed $_margin = 0)
Parameters:
$_auto(mixed)$_margin(mixed)
Source: tcpdf.php:2586
setBarcode()
public setBarcode(mixed $_bc = '')
Parameters:
$_bc(mixed)
Source: tcpdf.php:6685
setBooklet()
public setBooklet(mixed $_booklet = true, mixed $_inner = -1, mixed $_outer = -1)
Parameters:
$_booklet(mixed)$_inner(mixed)$_outer(mixed)
Source: tcpdf.php:8039
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:5559
setCellHeightRatio()
public setCellHeightRatio(mixed $_h)
Parameters:
$_h(mixed)
Source: tcpdf.php:6264
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:2552
setCellPadding()
public setCellPadding(mixed $_pad)
Parameters:
$_pad(mixed)
Source: tcpdf.php:2513
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:2518
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:3107
setColorArray()
public setColorArray(mixed $_type, mixed $_color, mixed $_ret = false)
Parameters:
$_type(mixed)$_color(mixed)$_ret(mixed)
Source: tcpdf.php:3077
setColumnsArray()
public setColumnsArray(mixed $_columns)
Parameters:
$_columns(mixed)
Source: tcpdf.php:8516
setCompression()
public setCompression(mixed $_compress = true)
Parameters:
$_compress(mixed)
Source: tcpdf.php:2610
setCreator()
public setCreator(mixed $_creator)
Parameters:
$_creator(mixed)
Source: tcpdf.php:2646
setDefaultMonospacedFont()
public setDefaultMonospacedFont(mixed $_font)
Parameters:
$_font(mixed)
Source: tcpdf.php:3419
setDefaultTableColumns()
public setDefaultTableColumns(mixed $_cols = 4)
Parameters:
$_cols(mixed)
Source: tcpdf.php:6259
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:5539
setDisplayMode()
public setDisplayMode(
mixed $_zoom,
mixed $_layout = 'SinglePage',
mixed $_mode = 'UseNone'
)
Parameters:
$_zoom(mixed)$_layout(mixed)$_mode(mixed)
Source: tcpdf.php:2603
setDocCreationTimestamp()
public setDocCreationTimestamp(mixed $_time)
Parameters:
$_time(mixed)
Source: tcpdf.php:4832
setDocInfoUnicode()
public setDocInfoUnicode(mixed $_unicode = true)
Parameters:
$_unicode(mixed)
Source: tcpdf.php:2621
setDocModificationTimestamp()
public setDocModificationTimestamp(mixed $_time)
Parameters:
$_time(mixed)
Source: tcpdf.php:4837
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:3140
setDrawColorArray()
public setDrawColorArray(mixed $_color, mixed $_ret = false)
Parameters:
$_color(mixed)$_ret(mixed)
Source: tcpdf.php:3092
setDrawSpotColor()
public setDrawSpotColor(mixed $_name, mixed $_tint = 100)
Parameters:
$_name(mixed)$_tint(mixed)
Source: tcpdf.php:3062
setEqualColumns()
public setEqualColumns(mixed $_numcols = 0, mixed $_width = 0, mixed $_y = null)
Parameters:
$_numcols(mixed)$_width(mixed)$_y(mixed)
Source: tcpdf.php:8472
setExtraXMP()
public setExtraXMP(mixed $_xmp)
Parameters:
$_xmp(mixed)
Source: tcpdf.php:4817
setExtraXMPPdfaextension()
public setExtraXMPPdfaextension(mixed $_xmp)
Parameters:
$_xmp(mixed)
Source: tcpdf.php:4827
setExtraXMPRDF()
public setExtraXMPRDF(mixed $_xmp)
Parameters:
$_xmp(mixed)
Source: tcpdf.php:4822
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:3145
setFillColorArray()
public setFillColorArray(mixed $_color, mixed $_ret = false)
Parameters:
$_color(mixed)$_ret(mixed)
Source: tcpdf.php:3097
setFillSpotColor()
public setFillSpotColor(mixed $_name, mixed $_tint = 100)
Parameters:
$_name(mixed)$_tint(mixed)
Source: tcpdf.php:3067
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:3282
setFontSize()
public setFontSize(mixed $_size, mixed $_out = true)
Parameters:
$_size(mixed)$_out(mixed)
Source: tcpdf.php:3338
setFontSpacing()
public setFontSpacing(mixed $_spacing = 0)
Parameters:
$_spacing(mixed)
Source: tcpdf.php:8810
setFontStretching()
public setFontStretching(mixed $_perc = 100)
Parameters:
$_perc(mixed)
Source: tcpdf.php:8796
setFontSubsetting()
public setFontSubsetting(mixed $_enable = true)
Parameters:
$_enable(mixed)
Source: tcpdf.php:8699
setFooterData()
public setFooterData(mixed $_tc = [0, 0, 0], mixed $_lc = [0, 0, 0])
Parameters:
$_tc(mixed)$_lc(mixed)
Source: tcpdf.php:2843
setFooterFont()
public setFooterFont(mixed $_font)
Parameters:
$_font(mixed)
Source: tcpdf.php:4870
setFooterMargin()
public setFooterMargin(mixed $_fm = 10)
Parameters:
$_fm(mixed)
Source: tcpdf.php:2872
setFormDefaultProp()
public setFormDefaultProp(mixed $_prop = [])
Parameters:
$_prop(mixed)
Source: tcpdf.php:5616
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:2831
setHeaderFont()
public setHeaderFont(mixed $_font)
Parameters:
$_font(mixed)
Source: tcpdf.php:4852
setHeaderMargin()
public setHeaderMargin(mixed $_hm = 10)
Parameters:
$_hm(mixed)
Source: tcpdf.php:2859
setHeaderTemplateAutoreset()
public setHeaderTemplateAutoreset(mixed $_val = true)
Parameters:
$_val(mixed)
Source: tcpdf.php:2922
setHtmlLinksStyle()
public setHtmlLinksStyle(mixed $_color = [0, 0, 255], mixed $_fontstyle = 'U')
Parameters:
$_color(mixed)$_fontstyle(mixed)
Source: tcpdf.php:8091
setHtmlVSpace()
public setHtmlVSpace(mixed $_tagvs)
Parameters:
$_tagvs(mixed)
Source: tcpdf.php:8051
setImageScale()
public setImageScale(mixed $_scale)
Parameters:
$_scale(mixed)
Source: tcpdf.php:2370
setJPEGQuality()
public setJPEGQuality(mixed $_quality)
Parameters:
$_quality(mixed)
Source: tcpdf.php:6253
setKeywords()
public setKeywords(mixed $_keywords)
Parameters:
$_keywords(mixed)
Source: tcpdf.php:2641
setLanguageArray()
public setLanguageArray(mixed $_language)
Parameters:
$_language(mixed)
Source: tcpdf.php:4888
setLastH()
public setLastH(mixed $_h)
Parameters:
$_h(mixed)
Source: tcpdf.php:2334
setLeftMargin()
public setLeftMargin(mixed $_margin)
Parameters:
$_margin(mixed)
Source: tcpdf.php:2492
setLineStyle()
public setLineStyle(mixed $_style, mixed $_ret = false)
Parameters:
$_style(mixed)$_ret(mixed)
Source: tcpdf.php:5162
setLineWidth()
public setLineWidth(mixed $_width)
Parameters:
$_width(mixed)
Source: tcpdf.php:5148
setLink()
public setLink(mixed $_link, mixed $_y = 0, mixed $_page = -1)
Parameters:
$_link(mixed)$_y(mixed)$_page(mixed)
Source: tcpdf.php:3438
setListIndentWidth()
public setListIndentWidth(mixed $_width)
Parameters:
$_width(mixed)
Source: tcpdf.php:8081
setLIsymbol()
public setLIsymbol(mixed $_symbol = '!')
Parameters:
$_symbol(mixed)
Source: tcpdf.php:8034
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:2474
setOpenCell()
public setOpenCell(mixed $_isopen)
Parameters:
$_isopen(mixed)
Source: tcpdf.php:8086
setOverprint()
public setOverprint(mixed $_stroking = true, mixed $_nonstroking = null, mixed $_mode = 0)
Parameters:
$_stroking(mixed)$_nonstroking(mixed)$_mode(mixed)
Source: tcpdf.php:6202
setPage()
public setPage(mixed $_pnum, mixed $_resetmargins = false)
Parameters:
$_pnum(mixed)$_resetmargins(mixed)
Source: tcpdf.php:2718
setPageMark()
public setPageMark()
Source: tcpdf.php:2824
setPageOrientation()
public setPageOrientation(
mixed $_orientation,
mixed $_autopagebreak = null,
mixed $_bottommargin = null
)
Parameters:
$_orientation(mixed)$_autopagebreak(mixed)$_bottommargin(mixed)
Source: tcpdf.php:2280
setPageRegions()
public setPageRegions(mixed $_regions = [])
Parameters:
$_regions(mixed)
Source: tcpdf.php:8833
setPageUnit()
public setPageUnit(mixed $_unit)
Parameters:
$_unit(mixed)
Source: tcpdf.php:2266
setPDFVersion()
public setPDFVersion(mixed $_version = '1.7')
Parameters:
$_version(mixed)
Source: tcpdf.php:6277
setPrintFooter()
public setPrintFooter(mixed $_val = true)
Parameters:
$_val(mixed)
Source: tcpdf.php:2890
setPrintHeader()
public setPrintHeader(mixed $_val = true)
Parameters:
$_val(mixed)
Source: tcpdf.php:2885
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:4962
setRasterizeVectorImages()
public setRasterizeVectorImages(mixed $_mode)
Parameters:
$_mode(mixed)
Source: tcpdf.php:8694
setRightMargin()
public setRightMargin(mixed $_margin)
Parameters:
$_margin(mixed)
Source: tcpdf.php:2508
setRTL()
public setRTL(mixed $_enable, mixed $_resetx = true)
Parameters:
$_enable(mixed)$_resetx(mixed)
Source: tcpdf.php:2297
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:5960
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:5999
setSpacesRE()
public setSpacesRE(mixed $_re = '/[^\S\xa0]/')
Parameters:
$_re(mixed)
Source: tcpdf.php:2292
setSpotColor()
public setSpotColor(mixed $_type, mixed $_name, mixed $_tint = 100)
Parameters:
$_type(mixed)$_name(mixed)$_tint(mixed)
Source: tcpdf.php:3037
setSRGBmode()
public setSRGBmode(mixed $_mode = false)
Parameters:
$_mode(mixed)
Source: tcpdf.php:2616
setStartingPageNumber()
public setStartingPageNumber(mixed $_num = 1)
Parameters:
$_num(mixed)
Source: tcpdf.php:6055
setSubject()
public setSubject(mixed $_subject)
Parameters:
$_subject(mixed)
Source: tcpdf.php:2631
setTempRTL()
public setTempRTL(mixed $_mode)
Parameters:
$_mode(mixed)
Source: tcpdf.php:2314
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:3150
setTextColorArray()
public setTextColorArray(mixed $_color, mixed $_ret = false)
Parameters:
$_color(mixed)$_ret(mixed)
Source: tcpdf.php:3102
setTextRenderingMode()
public setTextRenderingMode(mixed $_stroke = 0, mixed $_fill = true, mixed $_clip = false)
Parameters:
$_stroke(mixed)$_fill(mixed)$_clip(mixed)
Source: tcpdf.php:8620
setTextShadow()
public setTextShadow(
mixed $_params = ['enabled' => false, 'depth_w' => 0, 'depth_h' => 0, 'color'…
)
Parameters:
$_params(mixed)
Source: tcpdf.php:8629
setTextSpotColor()
public setTextSpotColor(mixed $_name, mixed $_tint = 100)
Parameters:
$_name(mixed)$_tint(mixed)
Source: tcpdf.php:3072
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:6023
setTitle()
public setTitle(mixed $_title)
Parameters:
$_title(mixed)
Source: tcpdf.php:2626
setTopMargin()
public setTopMargin(mixed $_margin)
Parameters:
$_margin(mixed)
Source: tcpdf.php:2500
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:5940
setViewerPreferences()
public setViewerPreferences(mixed $_preferences)
Parameters:
$_preferences(mixed)
Source: tcpdf.php:6282
setVisibility()
public setVisibility(mixed $_v)
Parameters:
$_v(mixed)
Source: tcpdf.php:6184
setX()
public setX(mixed $_x, mixed $_rtloff = false)
Parameters:
$_x(mixed)$_rtloff(mixed)
Source: tcpdf.php:4667
setXY()
public setXY(mixed $_x, mixed $_y, mixed $_rtloff = false)
Parameters:
$_x(mixed)$_y(mixed)$_rtloff(mixed)
Source: tcpdf.php:4687
setY()
public setY(mixed $_y, mixed $_resetx = true, mixed $_rtloff = false)
Parameters:
$_y(mixed)$_resetx(mixed)$_rtloff(mixed)
Source: tcpdf.php:4678
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:5127
SkewX()
public SkewX(mixed $_angle_x, mixed $_x = null, mixed $_y = null)
Parameters:
$_angle_x(mixed)$_x(mixed)$_y(mixed)
Source: tcpdf.php:5117
SkewY()
public SkewY(mixed $_angle_y, mixed $_x = null, mixed $_y = null)
Parameters:
$_angle_y(mixed)$_x(mixed)$_y(mixed)
Source: tcpdf.php:5122
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:5447
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:6170
startPage()
public startPage(mixed $_orientation = '', mixed $_format = '', mixed $_tocpage = false)
Parameters:
$_orientation(mixed)$_format(mixed)$_tocpage(mixed)
Source: tcpdf.php:2798
startPageGroup()
public startPageGroup(mixed $_page = null)
Parameters:
$_page(mixed)
Source: tcpdf.php:6048
startTemplate()
public startTemplate(mixed $_w = 0, mixed $_h = 0, mixed $_group = false)
Parameters:
$_w(mixed)$_h(mixed)$_group(mixed)
Source: tcpdf.php:8743
startTransaction()
public startTransaction()
Source: tcpdf.php:8312
StartTransform()
public StartTransform()
Source: tcpdf.php:5024
StopTransform()
public StopTransform()
Source: tcpdf.php:5029
stringLeftTrim()
public stringLeftTrim(mixed $_str, mixed $_replace = '')
Parameters:
$_str(mixed)$_replace(mixed)
Source: tcpdf.php:8714
stringRightTrim()
public stringRightTrim(mixed $_str, mixed $_replace = '')
Parameters:
$_str(mixed)$_replace(mixed)
Source: tcpdf.php:8719
stringTrim()
public stringTrim(mixed $_str, mixed $_replace = '')
Parameters:
$_str(mixed)$_replace(mixed)
Source: tcpdf.php:8724
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:3511
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:5726
Translate()
public Translate(mixed $_t_x, mixed $_t_y)
Parameters:
$_t_x(mixed)$_t_y(mixed)
Source: tcpdf.php:5103
TranslateX()
public TranslateX(mixed $_t_x)
Parameters:
$_t_x(mixed)
Source: tcpdf.php:5093
TranslateY()
public TranslateY(mixed $_t_y)
Parameters:
$_t_y(mixed)
Source: tcpdf.php:5098
unhtmlentities()
public unhtmlentities(mixed $_text_to_convert)
Parameters:
$_text_to_convert(mixed)
Source: tcpdf.php:4953
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:4197
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:6698
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:6724
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:8022
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:7434