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

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

Show a image in the canvas with a fade effect. Fade effect is a effect that the image is shown with a fade in. If exist a image with the same alias, the existing image is removed with a fade transition, and after the effect is done, the new image is shown with a fade transition.

Parameters

alias

string

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

component?

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?

ShowWithFadeTransitionProps = {}

The properties of the effect

priority?

UPDATE_PRIORITY

The priority of the effect

Returns

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.