Documentation

Link extends AbstractAnnotation
in package

Pdf page link annotation class

Tags
category

Pop

author

Nick Sagona, III nick@popphp.org

copyright

Copyright (c) 2009-2026 Nick Sagona, III

license

https://www.popphp.org/license New BSD License

version
6.0.0

Table of Contents

Properties

$borderWidth  : int|float
Border width $var int|float
$dashGap  : int|float
Border dash gap $var int|float
$dashLength  : int|float
Border dash length $var int|float
$height  : int|float
Annotation height $var int|float
$hRadius  : int|float
Horizontal border radius $var int|float
$pageTarget  : int|float|null
Internal page object index target to link to
$vRadius  : int|float
Vertical border radius $var int|float
$width  : int|float
Annotation width $var int|float
$xTarget  : int|float
Internal x-position target to link to on internal page
$yTarget  : int|float
Internal y-position target to link to on internal page
$zTarget  : int|float
Internal z-position target (zoom) to link to on internal page

Methods

__construct()  : mixed
Constructor
getBorderWidth()  : int|float
Get the border width
getDashGap()  : int|float
Get the border dash gap
getDashLength()  : int|float
Get the border dash length
getHeight()  : int|float
Get the height
getHRadius()  : int|float
Get the horizontal border radius
getPageTarget()  : int|float|null
Get the page target
getStream()  : string
Get the annotation stream
getVRadius()  : int|float
Get the vertical border radius
getWidth()  : int|float
Get the width
getXTarget()  : int|float
Get the X target
getYTarget()  : int|float
Get the Y target
getZTarget()  : int|float
Get the Z (zoom) target
setBorderWidth()  : AbstractAnnotation
Set the border width
setDashGap()  : AbstractAnnotation
Set the border dash gap
setDashLength()  : AbstractAnnotation
Set the border dash length
setHeight()  : AbstractAnnotation
Set the height
setHRadius()  : AbstractAnnotation
Set the horizontal border radius
setPageTarget()  : Link
Set the page target
setVRadius()  : AbstractAnnotation
Set the vertical border radius
setWidth()  : AbstractAnnotation
Set the width
setXTarget()  : Link
Set the X target
setYTarget()  : Link
Set the Y target
setZTarget()  : Link
Set the Z (zoom) target

Properties

$dashLength

Border dash length $var int|float

protected int|float $dashLength = 0

$hRadius

Horizontal border radius $var int|float

protected int|float $hRadius = 0

$pageTarget

Internal page object index target to link to

protected int|float|null $pageTarget = null

$xTarget

Internal x-position target to link to on internal page

protected int|float $xTarget = 0

$yTarget

Internal y-position target to link to on internal page

protected int|float $yTarget = 0

$zTarget

Internal z-position target (zoom) to link to on internal page

protected int|float $zTarget = 0

Methods

__construct()

Constructor

public __construct(int|float $width, int|float $height, int|float $xTarget, int|float $yTarget) : mixed

Instantiate a PDF link annotation object.

Parameters
$width : int|float
$height : int|float
$xTarget : int|float
$yTarget : int|float

getBorderWidth()

Get the border width

public getBorderWidth() : int|float
Return values
int|float

getDashGap()

Get the border dash gap

public getDashGap() : int|float
Return values
int|float

getDashLength()

Get the border dash length

public getDashLength() : int|float
Return values
int|float

getHeight()

Get the height

public getHeight() : int|float
Return values
int|float

getHRadius()

Get the horizontal border radius

public getHRadius() : int|float
Return values
int|float

getPageTarget()

Get the page target

public getPageTarget() : int|float|null
Return values
int|float|null

getStream()

Get the annotation stream

public getStream(int $i, int|float $x, int|float $y, int $pageIndex, array<string|int, mixed> $kids) : string
Parameters
$i : int
$x : int|float
$y : int|float
$pageIndex : int
$kids : array<string|int, mixed>
Return values
string

getVRadius()

Get the vertical border radius

public getVRadius() : int|float
Return values
int|float

getXTarget()

Get the X target

public getXTarget() : int|float
Return values
int|float

getYTarget()

Get the Y target

public getYTarget() : int|float
Return values
int|float

getZTarget()

Get the Z (zoom) target

public getZTarget() : int|float
Return values
int|float

setPageTarget()

Set the page target

public setPageTarget(int|float $pageTarget) : Link
Parameters
$pageTarget : int|float
Return values
Link

setXTarget()

Set the X target

public setXTarget(int|float $xTarget) : Link
Parameters
$xTarget : int|float
Return values
Link

setYTarget()

Set the Y target

public setYTarget(int|float $yTarget) : Link
Parameters
$yTarget : int|float
Return values
Link

setZTarget()

Set the Z (zoom) target

public setZTarget(int|float $zTarget) : Link
Parameters
$zTarget : int|float
Return values
Link 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results