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

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

Show a image in the canvas with a push effect. The new image is pushed in from the inside of the canvas and the old image is pushed out to the outside of 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

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?

PushInOutProps = {}

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.