Function: moveOut()

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

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

Remove a image from the canvas with a move effect. The image is moved from the x and y position of the image to outside the canvas. If there is a/more ticker(s) with the same alias, then the ticker(s) is/are paused.

Parameters

alias

string

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

props?

MoveInOutProps = {}

The properties of the effect

priority?

UPDATE_PRIORITY

The priority of the effect

Returns

string[] | undefined

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