Function: irisIn()

> irisIn(alias, component?, props?, priority?): Promise<string[] | undefined>

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

Show a image in the canvas with an iris effect: the image is progressively revealed by an expanding radial mask. Moving IrisInOutProps.origin off-center makes the same primitive useful as a focus/reveal effect (e.g. centered on a character).

ParametersCopy Anchor Link

aliasCopy Anchor Link

string

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

component?Copy Anchor Link

TComponent

The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the VideoSprite is added to the canvas. If imageUrl is an array, then the ImageContainer is added to the canvas. If you don't provide the component, then the alias is used as the url.

props?Copy Anchor Link

IrisInOutProps = {}

The properties of the effect

priority?Copy Anchor Link

UPDATE_PRIORITY

The priority of the effect

ReturnsCopy Anchor Link

Promise<string[] | undefined>

A promise that contains the ids of the tickers that are used in the effect. The promise is resolved when the image is loaded.