Appearance

Fluent sub-facade for the signature widget appearance, reached through Tcpdf::signature()->appearance(). It forwards to the existing appearance methods on Tcpdf while returning $this for chaining.

Table of contents

Namespace: Com\Tecnick\Pdf\Signature

Final: Yes

File: Appearance.php line 38

Fluent sub-facade for the signature widget appearance, reached through Tcpdf::signature()->appearance(). It forwards to the existing appearance methods on Tcpdf while returning $this for chaining.

Tags

Methods

__construct()

File: Appearance.php line 40

public __construct(Tcpdf $pdf) : mixed

Parameters

description()

File: Appearance.php line 74

public description(string $description) : self

Parameters

  • $description : string: Human readable description of the signature field.

Return values

self

place()

File: Appearance.php line 56

public place([float $posx = 0 ][, float $posy = 0 ][, float $width = 0 ][, float $height = 0 ][, int $page = -1 ][, string $name = '' ]) : self

Parameters

  • $posx : float = 0: Abscissa of the upper-left corner.
  • $posy : float = 0: Ordinate of the upper-left corner.
  • $width : float = 0: Width of the signature area.
  • $height : float = 0: Height of the signature area.
  • $page : int = -1: Page number (if < 0 the current page is used).
  • $name : string = ‘’: Name of the signature field.

Tags

  • throws: Exception

Return values

self

stream()

File: Appearance.php line 89

public stream(string $stream[, string|SignatureAppearanceMode $mode = 'N' ][, string $state = '' ]) : self

Parameters

  • $stream : string: Appearance stream content.
  • $mode : string|SignatureAppearanceMode = ‘N’: Appearance mode: N (normal), R (rollover), D (down), or enum case.
  • $state : string = ‘’: Optional appearance state name.

Tags

Return values

self

xobject()

File: Appearance.php line 102

public xobject(string $xobjid) : self

Parameters

  • $xobjid : string: XObject resource name (for example “IMP1”).

Tags

Return values

self