Class Selection

Represents a selected area or areas in the document. If there is no active selection, the bounds will return null. The selection is pixel-based, though 8-bit transparency is possible.

Pixel selection targets where pixel filters are applied, or from where the histogram measurement is sourced.

See

https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/

Example

const { app, constants } = require("photoshop");
const doc = app.activeDocument;

await doc.selection.selectRectangle(
    {top: 50, left: 50, bottom: 100, right: 100},
    constants.SelectionType.REPLACE
);
doc.selection.bounds; // {{top: 50, left: 50, bottom: 100, right: 100}
doc.selection.solid;  // true

await doc.selection.selectEllipse(
    {top: 50, left: 70, bottom: 140, right: 100},
    constants.SelectionType.EXTEND
);
doc.selection.bounds; // {{top: 50, left: 50, bottom: 140, right: 100}
doc.selection.solid;  // false

Pixel selection while in Quick Mask Mode: When a user switches into Quick Mask Mode, the selection is temporarily shown as a channel instead of the "marching ants" border. While in Quick Mask Mode, new pixel selections can be made via Scripting. However, upon exiting Quick Mask Mode, the Quick Mask Channel will become the active selection.

Min Version

25.0

Accessors

bounds

get bounds(): ImagingBounds | null
The bounding rectangle of the entire selection. It can exceed the bounds of the canvas.

Returns ImagingBounds | null
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#bounds

Min Version
25.0
- Defined in packages/types-photoshop/src/internal/dom/Selection.d.ts:74

docId

get docId(): number
The ID of the document of this Selection.

Returns number
Min Version
25.0
- Defined in packages/types-photoshop/src/internal/dom/Selection.d.ts:61

parent

get parent(): Document
Owner document of this Selection.

Returns Document
Min Version
25.0
- Defined in packages/types-photoshop/src/internal/dom/Selection.d.ts:67

solid

get solid(): boolean
True if the selection itself is a rectangle with all fully selected pixels. Viewed as a channel, for example via Quick Mask Mode, the selection will appear as a completely white rectangle. In that way, it is solid within its bounds.

Returns boolean
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#solid

Min Version
25.0
- Defined in packages/types-photoshop/src/internal/dom/Selection.d.ts:83

typename

get typename(): "Selection"
The class name of the referenced object: "Selection".

Returns "Selection"
Min Version
25.0
- Defined in packages/types-photoshop/src/internal/dom/Selection.d.ts:55

Methods

contract

contract(by: number, applyEffectAtCanvasBounds?: boolean): Promise<void>
Contract (shrink) the selection by the specified amount.

If the contraction amount is greater than the selected area radius, the selected area will disappear entirely. If there are no other active selected areas, then there will be no active selection altogether.

UI Location: Select > Modify > Contract
Parameters
- by: number
  The amount to contract the selection (integer in the range 1..500).
- OptionalapplyEffectAtCanvasBounds: boolean
  By default this is false, meaning that any part of the selection that touches the bounds of the canvas will not be affected by the contraction.
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#contract
Example
```
await doc.selection.contract(8);
```
Async
Min Version
25.0
- Defined in packages/types-photoshop/src/internal/dom/Selection.d.ts:107

deselect

deselect(): Promise<void>
Cancel the current selection. The bounds value will then be null.

UI Location: Select > Deselect

Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#deselect
Example
```
await doc.selection.deselect();
```
Async
Min Version
25.0
- Defined in packages/types-photoshop/src/internal/dom/Selection.d.ts:123

expand

expand(by: number, applyEffectAtCanvasBounds?: boolean): Promise<void>
Expand the selection outward by the specified number of pixels.

UI Location: Select > Modify > Expand
Parameters
- by: number
  The amount to expand the selection (integer in the range 1..500).
- OptionalapplyEffectAtCanvasBounds: boolean
  By default this is false, meaning that any part of the selection that touches the bounds of the canvas will not be affected by the expansion.
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#expand
Example
```
await doc.selection.expand(42);
```
Async
Min Version
25.0
- Defined in packages/types-photoshop/src/internal/dom/Selection.d.ts:143

feather

feather(by: number, applyEffectAtCanvasBounds?: boolean): Promise<void>
Feather the edges of the selection by the specified amount. This softening of the selection strength is best viewed as a channel via Quick Mask Mode. Large values might make the selection disappear entirely (.bounds would return null).

UI Location: Select > Modify > Feather
Parameters
- by: number
  The amount to feather the selection with (decimal in the range 0.1..1000).
- OptionalapplyEffectAtCanvasBounds: boolean
  By default this is false, meaning that any part of the selection that touches the bounds of the canvas will not be affected by the feathering.
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#feather
Example
```
await doc.selection.feather(16);
```
Async
Min Version
25.0
- Defined in packages/types-photoshop/src/internal/dom/Selection.d.ts:165

grow

grow(tolerance: number, antiAlias?: boolean): Promise<void>
Grow the selection to include all adjacent pixels falling within the specified tolerance range.

Unsupported modes: Bitmap, RGB 32 bits, Grayscale 32 bits

UI Location: Select > Grow
Parameters
- tolerance: number
  The tolerance range (integer in the range 0..255)
- OptionalantiAlias: boolean
  Whether to use anti-aliasing (default: true)
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#grow
Example
```
await doc.selection.grow(32);
```
Async
Min Version
25.0
- Defined in packages/types-photoshop/src/internal/dom/Selection.d.ts:187

inverse

inverse(): Promise<void>
Set the active selection to the inverse of the current selection. The new active selection will be cropped to the canvas bounds. If the canvas area is fully selected, inverse will result in no active selection. Note also that Artboard bounds are not respected.

UI Location: Select > Inverse

Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#inverse
Example
```
await doc.selection.inverse();
```
Async
Min Version
25.0
- Defined in packages/types-photoshop/src/internal/dom/Selection.d.ts:206

load

load(
    from: Channel | Layer,
    mode?: SelectionType,
    invert?: boolean,
): Promise<void>
Load the selection from the specified Channel or Layer. A Layer's pixels' transparency will be used as the selection values. Full opaque pixels yield fully selected pixels.

UI Locations:
- Select > Load Selection...
- control/command + click on layer thumbnail
- control/command + click on channel thumbnail
For selecting a path please use PathItem.makeSelection
Parameters
- from: Channel | Layer
  The Channel or Layer to load the selection from. Can be located in different document.
- Optionalmode: SelectionType
  The selection behavior when a selection already exists. Default: SelectionType.REPLACE
- Optionalinvert: boolean
  True to invert the selection (default: false)
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#load
Example
```
// Load from first alpha channel in RGB document
await doc.selection.load(doc.channels[3]);
```
Async
Min Version
25.0
- Defined in packages/types-photoshop/src/internal/dom/Selection.d.ts:233

makeWorkPath

makeWorkPath(tolerance?: number): Promise<PathItem>
Create a work path from the active selection.

UI Location: Paths panel > Make work path icon
Parameters
- Optionaltolerance: number
  The tolerance (lower values, higher precision), decimal in the range 0.5..10 (default: 2)
Returns Promise<PathItem>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#makeworkpath
Example
```
await doc.selection.makeWorkPath();
```
Async
Min Version
25.0
- Defined in packages/types-photoshop/src/internal/dom/Selection.d.ts:251

resizeBoundary

resizeBoundary(
    horizontal?: number,
    vertical?: number,
    anchor?: AnchorPosition,
    interpolation?: InterpolationMethod,
): Promise<void>
Scale the selection itself in percent. Does not affect the active layer.

UI Location: Select > Transform Selection
Parameters
- Optionalhorizontal: number
  The amount to scale selection horizontally (decimal, default: 100)
- Optionalvertical: number
  The amount to scale selection vertically (decimal, default: 100)
- Optionalanchor: AnchorPosition
  The anchor position to scale around. Default: AnchorPosition.MIDDLECENTER
- Optionalinterpolation: InterpolationMethod
  The resampling algorithm to use. Default: InterpolationMethod.BICUBIC
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#resizeboundary
Example
```
await doc.selection.resizeBoundary(50, 50);
```
Min Version
25.0

Async
- Defined in packages/types-photoshop/src/internal/dom/Selection.d.ts:527

rotateBoundary

rotateBoundary(
    angle: number,
    anchor?: AnchorPosition,
    interpolation?: InterpolationMethod,
): Promise<void>
Rotate the selection itself clockwise around the given anchor position. Does not affect the active layer.

UI Location: Select > Transform Selection
Parameters
- angle: number
  Angle to rotate the selection by in degrees (decimal in the range -180..180)
- Optionalanchor: AnchorPosition
  Anchor position to rotate around. Default: AnchorPosition.MIDDLECENTER
- Optionalinterpolation: InterpolationMethod
  The resampling algorithm to use. Default: InterpolationMethod.BICUBIC
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#rotateboundary
Example
```
await doc.selection.rotateBoundary(90, constants.AnchorPosition.MIDDLECENTER);
```
Min Version
25.0

Async
- Defined in packages/types-photoshop/src/internal/dom/Selection.d.ts:552

save

save(channelName?: string): Promise<void>
Save the selection in a new Alpha Channel.

UI Location: Select > Save Selection...
Parameters
- OptionalchannelName: string
  The name of the new channel to create (Default: "Alpha 1", "Alpha 2", etc.)
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#save
Example
```
await doc.selection.save("My Selection");
```
Async
Min Version
25.0
- Defined in packages/types-photoshop/src/internal/dom/Selection.d.ts:423

saveTo

saveTo(channel: Channel, mode?: SelectionType): Promise<void>
Save the selection in an existing Alpha Channel (Component Channels are not supported targets).
Parameters
- channel: Channel
  The targeted Alpha channel for the save operation.
- Optionalmode: SelectionType
  The selection behavior when a selection already exists. Default: SelectionType.REPLACE
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#saveto
Example
```
// Stores the current selection into an existing alpha channel in RGB document
await doc.selection.saveTo(doc.channels[3]);

// Performing an intersection operation on an alpha channel
await doc.selection.saveTo(doc.channels[3], SelectionType.INTERSECT);
```
Min Version
25.0
- Defined in packages/types-photoshop/src/internal/dom/Selection.d.ts:443

selectAll

selectAll(): Promise<void>
Select the entire canvas.

If the document has artboards, all the pixels of the artboard that contain the active layer will be selected.

If layers across multiple artboards are active, a single rectangular selection will be made, with bounds wrapping them.

If no artboard is active, all artboards will be selected in the same manner. (The resulting selection might be smaller than the canvas bounds.)

UI Location: Select > All

Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#selectall
Example
```
await doc.selection.selectAll();
```
Async
Min Version
25.0
- Defined in packages/types-photoshop/src/internal/dom/Selection.d.ts:276

selectBorder

selectBorder(width: number): Promise<void>
Create a new selection based on the border of the active selection. The new selection will be an area equivalent to a stroke of that border by the given width in pixels. The result is not limited by canvas bounds.

UI Location: Select > Modify > Border...
Parameters
- width: number
  The width of the border selection (integer in the range 1..200)
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#selectborder
Example
```
await doc.selection.selectBorder(10);
```
Min Version
25.0

Async
- Defined in packages/types-photoshop/src/internal/dom/Selection.d.ts:463

selectColumn

selectColumn(x: number, mode?: SelectionType): Promise<void>
Select a single column of pixels.

UI Location: Toolbar > Single Column Marquee Tool
Parameters
- x: number
  The x coordinate in pixels of the column to select (integer). The range should be within the document width.
- Optionalmode: SelectionType
  The selection behavior when a selection already exists. Default: SelectionType.REPLACE
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#selectcolumn
Example
```
await doc.selection.selectColumn(90);
```
Async
Min Version
25.0
- Defined in packages/types-photoshop/src/internal/dom/Selection.d.ts:405

selectEllipse

selectEllipse(
    bounds: Bounds,
    mode?: SelectionType,
    feather?: number,
    antiAlias?: boolean,
): Promise<void>
Make an elliptical selection.

UI Location: Toolbar > Elliptical Marquee Tool
Parameters
- bounds: Bounds
  The bounds of the selection, as an object with {top, left, bottom, right} properties.
- Optionalmode: SelectionType
  The selection behavior when a selection already exists. Default: SelectionType.REPLACE
- Optionalfeather: number
  The amount of feathering in pixels to apply to the selection (decimal in the range 0..1000, default: 0)
- OptionalantiAlias: boolean
  If true, anti-aliasing is applied to the selection (default: true)
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#selectellipse
Example
```
await doc.selection.selectEllipse({top: 0, left: 0, bottom: 100, right: 100});
```
Async
Min Version
25.0
- Defined in packages/types-photoshop/src/internal/dom/Selection.d.ts:327

selectPolygon

selectPolygon(
    points: { x: number; y: number }[],
    mode?: SelectionType,
    feather?: number,
    antiAlias?: boolean,
): Promise<void>
Make a polygonal selection.

UI Location: Toolbar > Polygonal Lasso Tool
Parameters
- points: { x: number; y: number }[]
  The points to select as an array of objects with {x, y} properties.
- Optionalmode: SelectionType
  The selection behavior when a selection already exists. Default: SelectionType.REPLACE
- Optionalfeather: number
  The amount of feathering in pixels to apply to the selection (decimal in the range 0..1000, default: 0)
- OptionalantiAlias: boolean
  If true, anti-aliasing is applied to the selection (default: true)
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#selectpolygon
Example
```
await doc.selection.selectPolygon([
    {x: 50, y: 10},
    {x: 100, y: 90},
    {x: 10, y: 40}
]);
```
Async
Min Version
25.0
- Defined in packages/types-photoshop/src/internal/dom/Selection.d.ts:357

selectRectangle

selectRectangle(
    bounds: Bounds,
    mode?: SelectionType,
    feather?: number,
    antiAlias?: boolean,
): Promise<void>
Make a rectangular selection.

UI Location: Toolbar > Rectangular Marquee Tool
Parameters
- bounds: Bounds
  The bounds of the selection, as an object with {top, left, bottom, right} properties.
- Optionalmode: SelectionType
  The selection behavior when a selection already exists. Default: SelectionType.REPLACE
- Optionalfeather: number
  The amount of feathering in pixels to apply to the selection (decimal in the range 0..1000, default: 0)
- OptionalantiAlias: boolean
  If true, anti-aliasing is applied to the selection (default: true)
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#selectrectangle
Example
```
await doc.selection.selectRectangle(
    {top: 0, left: 0, bottom: 100, right: 100},
    Constants.SelectionType.REPLACE,
    10
);
```
Async
Min Version
25.0
- Defined in packages/types-photoshop/src/internal/dom/Selection.d.ts:301

selectRow

selectRow(y: number, mode?: SelectionType): Promise<void>
Select a single row of pixels.

UI Location: Toolbar > Single Row Marquee Tool
Parameters
- y: number
  The y coordinate in pixels of the row to select (integer). The range should be within the document height.
- Optionalmode: SelectionType
  The selection behavior when a selection already exists. Default: SelectionType.REPLACE
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#selectrow
Example
```
await doc.selection.selectRow(10);
```
Async
Min Version
25.0
- Defined in packages/types-photoshop/src/internal/dom/Selection.d.ts:385

smooth

smooth(radius: number, applyEffectAtCanvasBounds?: boolean): Promise<void>
Reduce patchiness and smooth sharp corners and jagged lines in the selection. Smooth will also remove isolated groups of pixels that are smaller than the given radius. This effect is useful for cleaning up stray pixels from color-based selections.

Large values might make the selection disappear entirely (.bounds would return null).

UI Location: Select > Modify > Smooth...
Parameters
- radius: number
  The sample radius in pixels (integer in the range 1..500)
- OptionalapplyEffectAtCanvasBounds: boolean
  By default this is false, meaning that any part of the selection that touches the bounds of the canvas will not be affected by the smoothing.
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#smooth
Example
```
await doc.selection.smooth(32);
```
Min Version
25.0

Async
- Defined in packages/types-photoshop/src/internal/dom/Selection.d.ts:487

translateBoundary

translateBoundary(deltaX: number, deltaY: number): Promise<void>
Move the selection itself relative to its current position. Does not affect the active layer.

UI Location: Select > Transform Selection
Parameters
- deltaX: number
  The amount to move the selection horizontally (decimal).
- deltaY: number
  The amount to move the selection vertically (decimal).
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/selection/#translateboundary
Example
```
await doc.selection.translateBoundary(100, 600);
```
Min Version
25.0

Async
- Defined in packages/types-photoshop/src/internal/dom/Selection.d.ts:506

Class Selection

See

Example

Min Version

Index

Accessors

Methods

Accessors

bounds

Returns ImagingBounds | null

See

Min Version

docId

Returns number

Min Version

parent

Returns Document

Min Version

solid

Returns boolean

See

Min Version

typename

Returns "Selection"

Min Version

Methods

contract

Parameters

Returns Promise<void>

See

Example

Async

Min Version

deselect

Returns Promise<void>

See

Example

Async

Min Version

expand

Parameters

Returns Promise<void>

See

Example

Async

Min Version

feather

Parameters

Returns Promise<void>

See

Example

Async

Min Version

grow

Parameters

Returns Promise<void>

See

Example

Async

Min Version

inverse

Returns Promise<void>

See

Example

Async

Min Version

load

Parameters

Returns Promise<void>

See

Example

Async

Min Version

makeWorkPath

Parameters

Returns Promise<PathItem>

See

Example

Async

Min Version