# Function: wipeIn() (/pixi-vn/index/namespaces/transitions/functions/wipeIn)



\> **wipeIn**(`alias`, `component?`, `props?`, `priority?`): `Promise`\<`string`\[] | `undefined`>

Defined in: [src/canvas/functions/canvas-transition.ts:1334](https://github.com/DRincs-Productions/pixi-vn/blob/5bb5bb1f92e38998ea2f477b600168d8da3ece19/src/canvas/functions/canvas-transition.ts#L1334)

Show a image in the canvas with a wipe effect: the image is progressively revealed by a moving
boundary. The direction/angle and inversion are all configurable, so the same primitive can
produce horizontal, vertical, or diagonal reveals - see [WipeInOutProps](/pixi-vn/index/interfaces/WipeInOutProps).

## Parameters [#parameters]

### alias [#alias]

`string`

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

### component? [#component]

`TComponent`

The imageUrl, array of imageUrl or the canvas component. If imageUrl is a video, then the [VideoSprite](/pixi-vn/index/classes/VideoSprite) is added to the canvas.
If imageUrl is an array, then the [ImageContainer](/pixi-vn/index/classes/ImageContainer) is added to the canvas.
If you don't provide the component, then the alias is used as the url.

### props? [#props]

[`WipeInOutProps`](/pixi-vn/index/interfaces/WipeInOutProps) = `{}`

The properties of the effect

### priority? [#priority]

`UPDATE_PRIORITY`

The priority of the effect

## Returns [#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.