Function: rippleIn()

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

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

Show a image in the canvas with a ripple effect: the image fades in through a ring of water-like distortion spreading outward from an origin point - for dreams, magic or memories. See RippleInOutProps.

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 you don't provide the component, then the alias is used as the url.

props?Copy Anchor Link

RippleInOutProps = {}

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.