Selection

Implements

• Transformable

Properties

bounds

• bounds: Promise‹PsCommon.Bounds›

The selection's rectangular bounds

parent

• parent: Promise‹Document›

The document this selection belongs to

solid

• solid: Promise‹boolean›

Whether the selection is solid

Methods

copy

▸ copy(merge?: boolean): Promise‹void›

Invoke a copy command on the selection

Parameters:

cut

▸ cut(): Promise‹void›

Invoke a cut command on the selection

expand

▸ expand(amount?: number): Promise‹void›

Expands the selection by a pixel amount

Parameters:

feather

▸ feather(amount?: number): Promise‹void›

Feathers the selection by a pixel amount

Parameters:

invert

▸ invert(): Promise‹void›

Invert the selection

nudge

▸ nudge(horizontal: number | PercentValue | PixelValue, vertical: number | PercentValue | PixelValue): Promise‹void›

Implementation of Transformable

Moves the selected pixels.

// nudge the selection to the left by 200px
await selection.nudge(-200, 0)
CopyCopied to your clipboard
1// nudge the selection to the left by 200px
2await selection.nudge(-200, 0)

Parameters:

perspectiveTransform

▸ perspectiveTransform(percentH: number | PercentValue, percentV: number | PercentValue, interpolation?: InterpolationMethod): Promise‹void›

Implementation of Transformable

Applies a distortion (perspective) to the content under the selection.

// 'into the distance' effect
await selection.perspectiveTransform(0, -0.05)
CopyCopied to your clipboard
1// 'into the distance' effect
2await selection.perspectiveTransform(0, -0.05)

Parameters:

rotate

▸ rotate(angle: number | AngleValue, interpolation?: InterpolationMethod): Promise‹void›

Implementation of Transformable

Rotates the content under the selection.

// rotate 90 deg counter clockwise
await selection.rotate(-90)
CopyCopied to your clipboard
1// rotate 90 deg counter clockwise
2await selection.rotate(-90)

Parameters:

scale

▸ scale(width: number | PercentValue, height: number | PercentValue, interpolation?: InterpolationMethod): Promise‹void›

Implementation of Transformable

Scales the content under the selection.

await selection.scale(120, 120)
CopyCopied to your clipboard
await selection.scale(120, 120)

Parameters:

skew

▸ skew(angleH: number | AngleValue, angleV: number | AngleValue, interpolation?: InterpolationMethod): Promise‹void›

Implementation of Transformable

Applies a skew to the content under the selection.

// parellelogram shape
await selection.skew(-15, 0)
CopyCopied to your clipboard
1// parellelogram shape
2await selection.skew(-15, 0)

Parameters:

translate

▸ translate(deltaX: number, deltaY: number): Promise‹void›

Translate the entire selection.

Parameters:

warp

▸ warp(warp: BuiltinWarp | CustomWarp4X4, interpolation?: InterpolationMethod): Promise‹void›

Implementation of Transformable

Applies a warp to the content under the selection.

// perform a fisheye warp
await selection.warp({ style: BuiltinWarpStyle.warpFisheye, value: 70 })

// warp selection content using a user provided 4x4 warp grid of points
var bounds = await selection.bounds
var grid = myWarpEngine.generateUniformXYPoints(bounds, 16)
var warp = myWarpEngine.applyWarp(grid)
await selection.warp({ meshPoints: warp })
CopyCopied to your clipboard
1// perform a fisheye warp
2await selection.warp({ style: BuiltinWarpStyle.warpFisheye, value: 70 })
3
4// warp selection content using a user provided 4x4 warp grid of points
5var bounds = await selection.bounds
6var grid = myWarpEngine.generateUniformXYPoints(bounds, 16)
7var warp = myWarpEngine.applyWarp(grid)
8await selection.warp({ meshPoints: warp })

Parameters:

Last updated 9/29/2021

Was this helpful?

Yes

No