1. Home
  2. .Source~ImageSource

new ImageSource()

Description

Defines how to manipulate an image layer

Notice
This class is used as a Qualifier for the asset.overlay() and asset.underlay() methods.
You can find regular images and videos transformations below:
Details

Qualifiers.Source.BaseSource

qualifiers/source/sourceTypes/ImageSource.ts, line 20

Methods

<protected> encodeAssetPublicID()

Description

Utility function to encode an asset publicID in an overlay

Examples

			encodeAssetPublicID('foo/bar'); // -> foo:bar
Details

Qualifiers.Source.BaseSource#encodeAssetPublicID

Qualifiers.Source.BaseSource#encodeAssetPublicID

qualifiers/source/BaseSource.ts, line 15

transformation( t ) → {this}

Description

Apply a transformation on the image source of the layer

Parameters
Name Type Description
t SDK.ImageTransformation

An image transformation to apply to the layer
Returns
Details

Qualifiers.Source.BaseSource#transformation

Qualifiers.Source.BaseSource#transformation

qualifiers/source/BaseSource.ts, line 24

getOpenSourceString() → {string}

Description

Returns the opening string of the layer, This method is used internally within LayerAction

Returns
Details

qualifiers/source/sourceTypes/ImageSource.ts, line 34

format( format ) → {this}

Description

Apply a format for the image source of the layer

Parameters
Name Type Description
format FormatQualifier

A to apply to the layered image, see more here
Returns
Details

qualifiers/source/sourceTypes/ImageSource.ts, line 49

getTransformation() → {SDK.Transformation}

Description

Returns the Transformation of the source

Returns
Details

Qualifiers.Source.BaseSource#getTransformation

Qualifiers.Source.BaseSource#getTransformation

qualifiers/source/BaseSource.ts, line 33