Membros públicos | |
| get_page_number () | |
| get_page_count () | |
| set_page_count ($count) | |
| line ($x1, $y1, $x2, $y2, $color, $width, $style=null) | |
| rectangle ($x1, $y1, $w, $h, $color, $width, $style=null) | |
| filled_rectangle ($x1, $y1, $w, $h, $color) | |
| polygon ($points, $color, $width=null, $style=null, $fill=false) | |
| circle ($x, $y, $r, $color, $width=null, $style=null, $fill=false) | |
| image ($img_url, $img_type, $x, $y, $w, $h) | |
| text ($x, $y, $text, $font, $size, $color=array(0, 0, 0), $adjust=0) | |
| add_named_dest ($anchorname) | |
| add_link ($url, $x, $y, $width, $height) | |
| get_text_width ($text, $font, $size, $spacing=0) | |
| get_font_height ($font, $size) | |
| new_page () | |
| stream ($filename, $options=null) | |
| output ($options=null) | |
Documentação das funções
◆ add_link()
| add_link | ( | $url, | |
| $x, | |||
| $y, | |||
| $width, | |||
| $height ) |
Add a link to the pdf
- Parâmetros
-
string $url The url to link to float $x The x position of the link float $y The y position of the link float $width The width of the link float $height The height of the link
Implementado em CPDF_Adapter, GD_Adapter, PDFLib_Adapter e TCPDF_Adapter.
◆ add_named_dest()
| add_named_dest | ( | $anchorname | ) |
Add a named destination (similar to ... in html)
- Parâmetros
-
string $anchorname The name of the named destination
Implementado em CPDF_Adapter, GD_Adapter, PDFLib_Adapter e TCPDF_Adapter.
◆ circle()
| circle | ( | $x, | |
| $y, | |||
| $r, | |||
| $color, | |||
| $width = null, | |||
| $style = null, | |||
| $fill = false ) |
Draws a circle at $x,$y with radius $r
See Style::munge_colour() for the format of the colour array. See Cpdf::setLineStyle() for a description of the $style parameter (aka dash)
- Parâmetros
-
float $x float $y float $r array $color float $width array $style bool $fill Fills the circle if true
Implementado em GD_Adapter, PDFLib_Adapter, TCPDF_Adapter e Cached_PDF_Decorator.
◆ filled_rectangle()
| filled_rectangle | ( | $x1, | |
| $y1, | |||
| $w, | |||
| $h, | |||
| $color ) |
Draws a filled rectangle at x1,y1 with width w and height h
See Style::munge_colour() for the format of the colour array.
- Parâmetros
-
float $x1 float $y1 float $w float $h array $color
Implementado em Cached_PDF_Decorator, GD_Adapter, PDFLib_Adapter e TCPDF_Adapter.
◆ get_font_height()
| get_font_height | ( | $font, | |
| $size ) |
Calculates font height, in points
- Parâmetros
-
string $font float $size
- Retorna
- float
Implementado em CPDF_Adapter, GD_Adapter, PDFLib_Adapter e TCPDF_Adapter.
◆ get_page_count()
| get_page_count | ( | ) |
Returns the total number of pages
- Retorna
- int
Implementado em Cached_PDF_Decorator, CPDF_Adapter, GD_Adapter, PDFLib_Adapter e TCPDF_Adapter.
◆ get_page_number()
| get_page_number | ( | ) |
Returns the current page number
- Retorna
- int
Implementado em Cached_PDF_Decorator, CPDF_Adapter, GD_Adapter, PDFLib_Adapter e TCPDF_Adapter.
◆ get_text_width()
| get_text_width | ( | $text, | |
| $font, | |||
| $size, | |||
| $spacing = 0 ) |
Calculates text size, in points
- Parâmetros
-
string $text the text to be sized string $font the desired font float $size the desired font size float $spacing word spacing, if any
- Retorna
- float
Implementado em CPDF_Adapter, GD_Adapter, PDFLib_Adapter e TCPDF_Adapter.
◆ image()
| image | ( | $img_url, | |
| $img_type, | |||
| $x, | |||
| $y, | |||
| $w, | |||
| $h ) |
Add an image to the pdf.
The image is placed at the specified x and y coordinates with the given width and height.
- Parâmetros
-
string $img_url the path to the image string $img_type the type (e.g. extension) of the image float $x x position float $y y position int $w width (in pixels) int $h height (in pixels)
Implementado em CPDF_Adapter, GD_Adapter, PDFLib_Adapter e TCPDF_Adapter.
◆ line()
| line | ( | $x1, | |
| $y1, | |||
| $x2, | |||
| $y2, | |||
| $color, | |||
| $width, | |||
| $style = null ) |
Draws a line from x1,y1 to x2,y2
See Style::munge_colour() for the format of the colour array. See Cpdf::setLineStyle() for a description of the format of the $style parameter (aka dash).
- Parâmetros
-
float $x1 float $y1 float $x2 float $y2 array $color float $width array $style
Implementado em Cached_PDF_Decorator, GD_Adapter, PDFLib_Adapter e TCPDF_Adapter.
◆ new_page()
| new_page | ( | ) |
Starts a new page
Subsequent drawing operations will appear on the new page.
Implementado em Cached_PDF_Decorator, CPDF_Adapter, GD_Adapter, PDFLib_Adapter e TCPDF_Adapter.
◆ output()
| output | ( | $options = null | ) |
Returns the PDF as a string
- Parâmetros
-
array $options associative array: 'compress' => 1 or 0
- Retorna
- string
Implementado em CPDF_Adapter, GD_Adapter, PDFLib_Adapter e TCPDF_Adapter.
◆ polygon()
| polygon | ( | $points, | |
| $color, | |||
| $width = null, | |||
| $style = null, | |||
| $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 Style::munge_colour() for the format of the colour array. See Cpdf::setLineStyle() for a description of the $style parameter (aka dash)
- Parâmetros
-
array $points array $color float $width array $style bool $fill Fills the polygon if true
Implementado em Cached_PDF_Decorator, GD_Adapter, PDFLib_Adapter e TCPDF_Adapter.
◆ rectangle()
| rectangle | ( | $x1, | |
| $y1, | |||
| $w, | |||
| $h, | |||
| $color, | |||
| $width, | |||
| $style = null ) |
Draws a rectangle at x1,y1 with width w and height h
See Style::munge_colour() for the format of the colour array. See Cpdf::setLineStyle() for a description of the $style parameter (aka dash)
- Parâmetros
-
float $x1 float $y1 float $w float $h array $color float $width array $style
Implementado em Cached_PDF_Decorator, GD_Adapter, PDFLib_Adapter e TCPDF_Adapter.
◆ set_page_count()
| set_page_count | ( | $count | ) |
Sets the total number of pages
- Parâmetros
-
int $count
Implementado em Cached_PDF_Decorator, CPDF_Adapter, GD_Adapter, PDFLib_Adapter e TCPDF_Adapter.
◆ stream()
| stream | ( | $filename, | |
| $options = null ) |
Streams the PDF directly to the browser
- Parâmetros
-
string $filename the name of the PDF file array $options associative array, 'Attachment' => 0 or 1, 'compress' => 1 or 0
Implementado em CPDF_Adapter, GD_Adapter, PDFLib_Adapter e TCPDF_Adapter.
◆ text()
| text | ( | $x, | |
| $y, | |||
| $text, | |||
| $font, | |||
| $size, | |||
| $color = array(0, 0, 0), | |||
| $adjust = 0 ) |
Writes text at the specified x and y coordinates
See Style::munge_colour() for the format of the colour array.
- Parâmetros
-
float $x float $y string $text the text to write string $font the font file to use float $size the font size, in points array $color float $adjust word spacing adjustment
Implementado em GD_Adapter e TCPDF_Adapter.
A documentação para este interface foi gerada a partir do seguinte ficheiro:
- classes/extensions/dompdf/include/canvas.cls.php
