phpdftk API Documentation

Destination
in package
implements Serializable

Explicit destination array (ISO 32000-2 Table 148).

Represents a destination within a PDF document, specifying a page and the desired view when navigating to that page.

Table of Contents

Interfaces

Serializable
Contract for anything that can emit raw PDF syntax via `toPdf()`.

Methods

fit()  : self
/Fit — fit entire page in window.
fitB()  : self
/FitB — fit bounding box in window.
fitBH()  : self
/FitBH top — fit bounding box width, position at top.
fitBV()  : self
/FitBV left — fit bounding box height, position at left.
fitH()  : self
/FitH top — fit page width, position at top coordinate.
fitR()  : self
/FitR left bottom right top — fit rectangle in window.
fitV()  : self
/FitV left — fit page height, position at left coordinate.
toPdf()  : string
xyz()  : self
/XYZ left top zoom — display page at given position and zoom.

Methods

fitBH()

/FitBH top — fit bounding box width, position at top.

public static fitBH(PdfReference $page[, float|null $top = null ]) : self
Parameters
$page : PdfReference
$top : float|null = null
Return values
self

fitBV()

/FitBV left — fit bounding box height, position at left.

public static fitBV(PdfReference $page[, float|null $left = null ]) : self
Parameters
$page : PdfReference
$left : float|null = null
Return values
self

fitH()

/FitH top — fit page width, position at top coordinate.

public static fitH(PdfReference $page[, float|null $top = null ]) : self
Parameters
$page : PdfReference
$top : float|null = null
Return values
self

fitR()

/FitR left bottom right top — fit rectangle in window.

public static fitR(PdfReference $page, float $left, float $bottom, float $right, float $top) : self
Parameters
$page : PdfReference
$left : float
$bottom : float
$right : float
$top : float
Return values
self

fitV()

/FitV left — fit page height, position at left coordinate.

public static fitV(PdfReference $page[, float|null $left = null ]) : self
Parameters
$page : PdfReference
$left : float|null = null
Return values
self

toPdf()

public toPdf() : string
Return values
string

xyz()

/XYZ left top zoom — display page at given position and zoom.

public static xyz(PdfReference $page[, float|null $left = null ][, float|null $top = null ][, float|null $zoom = null ]) : self

Null parameters indicate "unchanged".

Parameters
$page : PdfReference
$left : float|null = null
$top : float|null = null
$zoom : float|null = null
Return values
self 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results