trait PredefinedVariableBuilderTrait

Trait PredefinedVariableBuilderTrait

Methods

width()

The asset's current width.

initialWidth()

The asset's initial width.

height()

The asset's current height.

initialHeight()

The asset's initial height.

aspectRatio()

The aspect ratio of the asset. The compared value can be either decimal (e.g., 1.5) or a ratio (e.g., 3:4)

initialAspectRatio()

The initial aspect ratio of the asset.

trimmedAspectRatio()

The aspect ratio of the image IF it was trimmed (using the Effect::trim effect) without actually trimming the image.

pageCount()

The total number of pages in the image/document.

faceCount()

The total number of detected faces in the image.

illustrationScore()

The likelihood that the image is an illustration (as opposed to a photo).

currentPage()

The current page in the image/document.

pageX()

The page X.

pageY()

The page Y.

tags()

The set of tags assigned to the asset.

context()

A context value assigned to an asset.

generic(string $genericPredefinedVariable)

Generic (future) predefined variable name.

Details

Expression width()

The asset's current width.

Return Value

Expression

Expression initialWidth()

The asset's initial width.

Return Value

Expression

Expression height()

The asset's current height.

Return Value

Expression

Expression initialHeight()

The asset's initial height.

Return Value

Expression

Expression aspectRatio()

The aspect ratio of the asset. The compared value can be either decimal (e.g., 1.5) or a ratio (e.g., 3:4)

Return Value

Expression

Expression initialAspectRatio()

The initial aspect ratio of the asset.

Return Value

Expression

Expression trimmedAspectRatio()

The aspect ratio of the image IF it was trimmed (using the Effect::trim effect) without actually trimming the image.

The compared value can be either decimal (e.g., 1.5) or a ratio (e.g., 3:4).

Return Value

Expression

See also

Effect::trim

Expression pageCount()

The total number of pages in the image/document.

Return Value

Expression

Expression faceCount()

The total number of detected faces in the image.

Return Value

Expression

Expression illustrationScore()

The likelihood that the image is an illustration (as opposed to a photo).

Supported values: 0 (photo) to 1 (illustration)

Return Value

Expression

Expression currentPage()

The current page in the image/document.

Return Value

Expression

Expression pageX()

The page X.

Return Value

Expression

Expression pageY()

The page Y.

Return Value

Expression

Expression tags()

The set of tags assigned to the asset.

Used with the Expression::in or Expression::notIn operators.

Note: The syntax for this characteristic is slightly different: if_!!_in_tags, where the : delimiter denotes AND.

Return Value

Expression

See also

Expression::in
Expression::notIn

Expression context()

A context value assigned to an asset.

Return Value

Expression

Expression generic(string $genericPredefinedVariable)

Generic (future) predefined variable name.

Parameters

Name Type Description
$genericPredefinedVariable string The name of the predefined variable

Return Value

Expression