Function: flashOut()

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

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

Remove a image from the canvas with a flash effect: a configurable solid-color overlay fades up to color and back down to normal, and the image is removed the instant that finishes - the removal itself is a hard cut, never an additional fade/dissolve. See flashIn and FlashInOutProps.

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

FlashInOutProps = {}

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.