new LayerAction( layerSource )

Description

Creates a LayerAction to be used with overlays and underlays

Parameters
Name Type Description
layerSource ImageSource | TextSource | VideoSource

The Source used for the layer, use the builders provided here

Methods


getActionTag() → {string}

Description

Returns the custom name tag that was given to this action

Returns

setActionTag() → {this}

Description

Sets the custom name tag for this action

Returns

addQualifier( qualifier ) → {this}

Description

Adds the parameter to the action.

Parameters
Name Type Description
qualifier SDK.Qualifier
Returns

addFlag( flag ) → {this}

Description

Adds a flag to the current action.

Parameters
Name Type Description
flag Qualifiers.Flag
Returns
Details

setLayerType( type ) → {this}

Description

Sets the layerType to 'u' (underlay) or 'l' (overlay).

Parameters
Name Type Description
type 'u' | 'l'
Returns

timeline( timelinePosition ) → {this}

Description

Sets the timeline position of the video layer

Parameters
Name Type Description
timelinePosition Qualifiers.TimelinePosition
Returns

position( position ) → {this}

Description

Sets the position of the layer

Parameters
Name Type Description
position Qualifiers.Position
Returns

blendMode( blendMode ) → {this}

Description

Specifies how to blend the image overlay with the base overlay

Parameters
Name Type Description
blendMode Qualifiers.BlendMode | BlendModeType
Returns

toString() → {string}

Description

Serializes the Layer to a string

Returns