new EffectOutline()

Description

Adds an outline to a transparent image. For examples, see the Image Transformations guide.

Details

Visit Effect for an example

Methods


mode( mode ) → {this}

Description

How to apply the outline effect which can be one of the following values: inner, inner_fill, outer, fill.

Parameters
Name Type Description
mode OutlineModeType | string

The type of outline effect. Use the constants defined in Outline.

Returns

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

toString() → {string}

Description

Calls toString() on all child qualifiers (implicitly by using .join()).

Returns
Details

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

width( width ) → {this}

Description

The thickness of the outline in pixels. (Range: 1 to 100, Server default: 5)

Parameters
Name Type Description
width number
Returns

blurLevel( lvl ) → {this}

Description

The level of blur of the outline. Range: 0 to 2000, Server default: 0

Parameters
Name Type Description
lvl number | string
Returns

color( color ) → {this}

Parameters
Name Type Description
color string | Qualifiers.Color

One of the SDK Color values, string, or rgba: '#fff'

Returns