Function: wipeOut()

> wipeOut(alias, props?, priority?): string[] | undefined

Defined in: src/canvas/functions/canvas-transition.ts:1402

Remove a image from the canvas with a wipe effect: the image is progressively concealed by a moving boundary. See wipeIn and WipeInOutProps.

ParametersCopy Anchor Link

aliasCopy Anchor Link

string

The unique alias of the image. You can use this alias to refer to this image

props?Copy Anchor Link

WipeInOutProps = {}

The properties of the effect

priority?Copy Anchor Link

UPDATE_PRIORITY

The priority of the effect

ReturnsCopy Anchor Link

string[] | undefined

The ids of the tickers that are used in the effect.