Mode

Mode API reference

Namespace: Com\Tecnick\Pdf\Page

abstract class Mode extends Format

Extends: Format

Source: src/Mode.php:32

Methods

getDisplay()

Get the canonical page display mode.

Accepted names and the fallback are defined by PageDisplayMode::fromLoose().

public getDisplay(string|PageDisplayMode $mode = ''): string

Parameters:

  • $mode (string|PageDisplayMode): Display mode name or PageDisplayMode enum case.

Returns: string: Canonical page display mode.

Source: src/Mode.php:55

getLayout()

Get the canonical page layout name.

Accepted names, aliases and the fallback are defined by PageLayout::fromLoose().

public getLayout(string|PageLayout $name = ''): string

Parameters:

  • $name (string|PageLayout): Page layout name or PageLayout enum case.

Returns: string: Canonical page layout name.

Source: src/Mode.php:42

Inherited members

From Format