Function: pinchIn()

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

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

Show a image in the canvas with a pinch effect: the image emerges from a single point, deforming outward as it settles (or puffs out of it with mode: "bulge"). See PinchInOutProps.

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

PinchInOutProps = {}

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.