Function: pinchOut()

> pinchOut(alias, props?, priority?): string[] | undefined

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

Remove a image from the canvas with a pinch effect: the image is sucked into a single point (or puffs out with mode: "bulge") and removed. See pinchIn and PinchInOutProps.

ParametersCopy Anchor Link

aliasCopy Anchor Link

string

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

props?Copy Anchor Link

PinchInOutProps = {}

The properties of the effect

priority?Copy Anchor Link

UPDATE_PRIORITY

The priority of the effect

ReturnsCopy Anchor Link

string[] | undefined

The ids of the tickers that are used in the effect.