Interface Dompdf\Canvas


					
	public

__construct(string|float[] $paper = "letter", string $orientation = "portrait", Dompdf|null $dompdf = null)

Parameters

`$paper`	The paper size to use as either a standard paper size (see {@link Dompdf\Adapter\CPDF::$PAPER_SIZES}) or an array of the form `[x1, y1, x2, y2]` (typically `[0, 0, width, height]`).
`$orientation`	The paper orientation, either `portrait` or `landscape`.
`$dompdf`	The Dompdf instance.

#


					
	public

get_dompdf(): Dompdf

#


					
	public

get_page_number(): int

Returns the current page number

#


					
	public

get_page_count(): int

Returns the total number of pages in the document

#


					
	public

set_page_count(int $count)

Sets the total number of pages

#


					
	public

line(float $x1, float $y1, float $x2, float $y2, array $color, float $width, array $style = [], string $cap = "butt")

Draws a line from x1,y1 to x2,y2

See {@link Cpdf::setLineStyle()} for a description of the format of the $style and $cap parameters (aka dash and cap).

Parameters

`$color`	Color array in the format `[r, g, b, "alpha" => alpha]` where r, g, b, and alpha are float values between 0 and 1
`$cap`	`butt`, `round`, or `square`

#


					
	public

arc(
	float $x,
	float $y,
	float $r1,
	float $r2,
	float $astart,
	float $aend,
	array $color,
	float $width,
	array $style = [],
	string $cap = "butt",
)

Draws an arc

See {@link Cpdf::setLineStyle()} for a description of the format of the $style and $cap parameters (aka dash and cap).

Parameters

`$x`	X coordinate of the arc
`$y`	Y coordinate of the arc
`$r1`	Radius 1
`$r2`	Radius 2
`$astart`	Start angle in degrees
`$aend`	End angle in degrees
`$color`	Color array in the format `[r, g, b, "alpha" => alpha]` where r, g, b, and alpha are float values between 0 and 1
`$cap`	`butt`, `round`, or `square`

#


					
	public

rectangle(float $x1, float $y1, float $w, float $h, array $color, float $width, array $style = [], string $cap = "butt")

Draws a rectangle at x1,y1 with width w and height h

See {@link Cpdf::setLineStyle()} for a description of the format of the $style and $cap parameters (aka dash and cap).

Parameters

`$color`	Color array in the format `[r, g, b, "alpha" => alpha]` where r, g, b, and alpha are float values between 0 and 1
`$cap`	`butt`, `round`, or `square`

#


					
	public

filled_rectangle(float $x1, float $y1, float $w, float $h, array $color)

Draws a filled rectangle at x1,y1 with width w and height h

Parameters

$color

Color array in the format [r, g, b, "alpha" => alpha] where r, g, b, and alpha are float values between 0 and 1

#


					
	public

clipping_rectangle(float $x1, float $y1, float $w, float $h)

Starts a clipping rectangle at x1,y1 with width w and height h

#


					
	public

clipping_roundrectangle(float $x1, float $y1, float $w, float $h, float $tl, float $tr, float $br, float $bl)

Starts a rounded clipping rectangle at x1,y1 with width w and height h

#


					
	public

clipping_polygon(float[] $points): void

Starts a clipping polygon

#


					
	public

clipping_end()

Ends the last clipping shape

#


					
	public

page_script(callable $callback): void

Processes a callback on every page.

The callback function receives the four parameters int $pageNumber, int $pageCount, Canvas $canvas, and FontMetrics $fontMetrics, in that order.

This function can be used to add page numbers to all pages after the first one, for example.

Parameters

$callback

The callback function to process on every page

#


					
	public

page_text(
	float $x,
	float $y,
	string $text,
	string $font,
	float $size,
	array $color = [0, 0, 0],
	float $word_space = 0.0,
	float $char_space = 0.0,
	float $angle = 0.0,
)

Writes text at the specified x and y coordinates on every page.

The strings '{PAGE_NUM}' and '{PAGE_COUNT}' are automatically replaced with their current values.

Parameters

`$text`	The text to write
`$font`	The font file to use
`$size`	The font size, in points
`$color`	Color array in the format `[r, g, b, "alpha" => alpha]` where r, g, b, and alpha are float values between 0 and 1
`$word_space`	Word spacing adjustment
`$char_space`	Char spacing adjustment
`$angle`	Angle to write the text at, measured clockwise starting from the x-axis

#


					
	public

page_line(float $x1, float $y1, float $x2, float $y2, array $color, float $width, array $style = [])

Draws a line at the specified coordinates on every page.

Parameters

$color

Color array in the format [r, g, b, "alpha" => alpha] where r, g, b, and alpha are float values between 0 and 1

#


					
	public

save()

Save current state

#


					
	public

restore()

Restore last state

#


					
	public

rotate(float $angle, float $x, float $y)

Rotate

Parameters

`$angle`	angle in degrees for counter-clockwise rotation
`$x`	Origin abscissa
`$y`	Origin ordinate

#


					
	public

skew(float $angle_x, float $angle_y, float $x, float $y)

Skew

Parameters

`$x`	Origin abscissa
`$y`	Origin ordinate

#


					
	public

scale(float $s_x, float $s_y, float $x, float $y)

Scale

Parameters

`$s_x`	scaling factor for width as percent
`$s_y`	scaling factor for height as percent
`$x`	Origin abscissa
`$y`	Origin ordinate

#


					
	public

translate(float $t_x, float $t_y)

Translate

Parameters

`$t_x`	movement to the right
`$t_y`	movement to the bottom

#


					
	public

transform(float $a, float $b, float $c, float $d, float $e, float $f)

Transform

#


					
	public

polygon(array $points, array $color, float $width = null, array $style = [], bool $fill = false)

Draws a polygon

The polygon is formed by joining all the points stored in the $points array. $points has the following structure:

array(0 => x1,
      1 => y1,
      2 => x2,
      3 => y2,
      ...
      );

See {@link Cpdf::setLineStyle()} for a description of the format of the $style parameter (aka dash).

Parameters

`$color`	Color array in the format `[r, g, b, "alpha" => alpha]` where r, g, b, and alpha are float values between 0 and 1
`$fill`	Fills the polygon if true

#


					
	public

circle(float $x, float $y, float $r, array $color, float $width = null, array $style = [], bool $fill = false)

Draws a circle at $x,$y with radius $r

See {@link Cpdf::setLineStyle()} for a description of the format of the $style parameter (aka dash).

Parameters

`$color`	Color array in the format `[r, g, b, "alpha" => alpha]` where r, g, b, and alpha are float values between 0 and 1
`$fill`	Fills the circle if true

#


					
	public

image(string $img, float $x, float $y, float $w, float $h, string $resolution = "normal")

Add an image to the pdf.

The image is placed at the specified x and y coordinates with the given width and height.

Parameters

`$img`	The path to the image
`$x`	X position
`$y`	Y position
`$w`	Width
`$h`	Height
`$resolution`	The resolution of the image

#


					
	public

text(
	float $x,
	float $y,
	string $text,
	string $font,
	float $size,
	array $color = [0, 0, 0],
	float $word_space = 0.0,
	float $char_space = 0.0,
	float $angle = 0.0,
)

Writes text at the specified x and y coordinates

Parameters

`$text`	The text to write
`$font`	The font file to use
`$size`	The font size, in points
`$color`	Color array in the format `[r, g, b, "alpha" => alpha]` where r, g, b, and alpha are float values between 0 and 1
`$word_space`	Word spacing adjustment
`$char_space`	Char spacing adjustment
`$angle`	Angle to write the text at, measured clockwise starting from the x-axis

#


					
	public

add_named_dest(string $anchorname)

Add a named destination (similar to <a name="foo">...</a> in html)

Add a named destination (similar to ... in html)

Parameters

$anchorname

The name of the named destination

#


					
	public

add_link(string $url, float $x, float $y, float $width, float $height)

Add a link to the pdf

Parameters

`$url`	The url to link to
`$x`	The x position of the link
`$y`	The y position of the link
`$width`	The width of the link
`$height`	The height of the link

#


					
	public

add_info(string $label, string $value): void

Add meta information to the PDF.

Parameters

`$label`	Label of the value (Creator, Producer, etc.)
`$value`	The text to set

#


					
	public

get_text_width(string $text, string $font, float $size, float $word_spacing = 0.0, float $char_spacing = 0.0): float

Calculates text size, in points

Parameters

`$text`	The text to be sized
`$font`	The font file to use
`$size`	The font size, in points
`$word_spacing`	Word spacing, if any
`$char_spacing`	Char spacing, if any

#


					
	public

get_font_height(string $font, float $size): float

Calculates font height, in points

Parameters

`$font`	The font file to use
`$size`	The font size, in points

#


					
	public

get_font_baseline(string $font, float $size): float

Calculates font baseline, in points

Parameters

`$font`	The font file to use
`$size`	The font size, in points

#


					
	public

get_width(): float

Returns the PDF's width in points

#


					
	public

get_height(): float

Returns the PDF's height in points

#


					
	public

set_opacity(float $opacity, string $mode = "Normal"): void

Sets the opacity

#


					
	public

set_default_view(string $view, array $options = [])

Sets the default view

#


					
	public

javascript(string $code)

#


					
	public

new_page()

Starts a new page

Subsequent drawing operations will appear on the new page.

#


					
	public

stream(string $filename, array $options = [])

Streams the PDF to the client.

Parameters

`$filename`	The filename to present to the client.
`$options`	Associative array: 'compress' => 1 or 0 (default 1); 'Attachment' => 1 or 0 (default 1).

#


					
	public

output(array $options = []): string

Returns the PDF as a string.

Parameters

$options

Associative array: 'compress' => 1 or 0 (default 1).

#

Namespaces

Classes

Interfaces

Exceptions

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters