Class PathItem

A path or drawing object, such as the outline of a shape or a straight or curved line, which contains sub paths defining its geometry.

Access through the collection in the Document.pathItems property. For example, this selects a named path item:

See

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

Example

const currentPathItem = app.activeDocument.pathItems.getByName("myPath");
currentPathItem.select()

Create these objects by passing a set of SubPathInfo objects to the PathItems.add() method. This method creates a SubPathItem object for each SubPathInfo object, and creates and returns a new PathItem object for the path represented by all of the subpaths.

Min Version

23.3

Index

Accessors

docId id kind name parent subPathItems typename

Methods

deselect duplicate fillPath makeClippingPath makeSelection remove select strokePath

Accessors

docId

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

Returns number
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathitem/#docid

Min Version
23.3
- Defined in packages/types-photoshop/src/internal/dom/PathItem.d.ts:52

id

get id(): number
For use with batchPlay operations. This pathItem ID, along with its document ID can be used to represent this pathItem for the lifetime of this document.

Returns number
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathitem/#id

Min Version
23.3
- Defined in packages/types-photoshop/src/internal/dom/PathItem.d.ts:45

Methods

deselect

deselect(): Promise<void>
Deselects this pathItem object.

Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathitem/#deselect
Example
```
const path = app.activeDocument.pathItems[0];
await path.deselect();
```
Min Version
23.3
- Defined in packages/types-photoshop/src/internal/dom/PathItem.d.ts:96

duplicate

duplicate(name?: string): Promise<PathItem>
Duplicates the pathItem object with the new name, returning the duplicate.
Parameters
- Optionalname: string
Returns Promise<PathItem>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathitem/#duplicate
Example
```
const originalPath = app.activeDocument.pathItems[0];
const duplicatePath = await originalPath.duplicate("Copy of " + originalPath.name);
```
Min Version
23.3
- Defined in packages/types-photoshop/src/internal/dom/PathItem.d.ts:110

fillPath

fillPath(
    fillColor?: SolidColor,
    mode?: ColorBlendMode,
    opacity?: number,
    preserveTransparency?: boolean,
    feather?: number,
    wholePath?: boolean,
    antiAlias?: boolean,
): Promise<void>
Fills the area enclosed by this path.

opacity is a percentage, in the [0.0 ... 100.0] range.

feather is in pixels, in the [0.0 ... 250.0] range.

If wholePath is true, all subpaths are used when doing the fill.
Parameters
- OptionalfillColor: SolidColor
- Optionalmode: ColorBlendMode
- Optionalopacity: number
- OptionalpreserveTransparency: boolean
- Optionalfeather: number
- OptionalwholePath: boolean
- OptionalantiAlias: boolean
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathitem/#fillpath
Example
```
const path = app.activeDocument.pathItems[0];
const fillColor = new SolidColor();
fillColor.rgb.red = 255;
fillColor.rgb.green = 0;
fillColor.rgb.blue = 0;
await path.fillPath(fillColor, constants.ColorBlendMode.NORMAL, 100, false, 0, true, true);
```
Min Version
23.3
- Defined in packages/types-photoshop/src/internal/dom/PathItem.d.ts:134

makeClippingPath

makeClippingPath(flatness?: number): Promise<void>
Makes this the clipping path for this document.

flatness tells the PostScript printer how to approximate curves in the path.
Parameters
- Optionalflatness: number
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathitem/#makeclippingpath
Example
```
const path = app.activeDocument.pathItems.getByName("ClipPath");
await path.makeClippingPath(2);
```
Min Version
23.3
- Defined in packages/types-photoshop/src/internal/dom/PathItem.d.ts:158

makeSelection

makeSelection(
    feather?: number,
    antiAlias?: boolean,
    operation?: SelectionType,
): Promise<void>
Makes a selection object whose border is this path.

feather is in pixels, in the range [0.0...250.0]

operation, by default, is SelectionType.REPLACE
Parameters
- Optionalfeather: number
- OptionalantiAlias: boolean
- Optionaloperation: SelectionType
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathitem/#makeselection
Example
```
const path = app.activeDocument.pathItems[0];
await path.makeSelection(5, true, constants.SelectionType.REPLACE);
```
Min Version
23.3
- Defined in packages/types-photoshop/src/internal/dom/PathItem.d.ts:176

remove

remove(): Promise<void>
Deletes this object.

Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathitem/#remove
Example
```
const path = app.activeDocument.pathItems[0];
await path.remove();
```
Min Version
23.3
- Defined in packages/types-photoshop/src/internal/dom/PathItem.d.ts:190

select

select(): Promise<void>
Makes this the active or selected PathItem object.

Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathitem/#select
Example
```
const path = app.activeDocument.pathItems.getByName("myPath");
await path.select();
```
Min Version
23.3
- Defined in packages/types-photoshop/src/internal/dom/PathItem.d.ts:204

strokePath

strokePath(
    tool?: ToolType,
    simulatePressure?: boolean,
    sourceOrigin?: { x: number; y: number },
    sourceLayer?: Layer,
): Promise<void>
Strokes the path with the specified tool

tool is optional, and by default will use ToolType.PENCIL

simulatePressure is false by default.

If the tool is ToolType.CLONESTAMP or ToolType.HEALINGBRUSH, sourceOrigin must be provided as a an object with x and y properties (in pixels) to indicate the location of the stroke source. sourceLayer is optional, and by default will use the active layer in the document.
Parameters
- Optionaltool: ToolType
- OptionalsimulatePressure: boolean
- OptionalsourceOrigin: { x: number; y: number }
- OptionalsourceLayer: Layer
Returns Promise<void>
See
https://developer.adobe.com/photoshop/uxp/2022/ps_reference/classes/pathitem/#strokepath
Example
```
// Stroke a path with the brush tool
const path = app.activeDocument.pathItems[0];
await path.strokePath(constants.ToolType.BRUSH, false);
```
Example
```
// Stroke with clone stamp tool
const path = app.activeDocument.pathItems[0];
await path.strokePath(
  constants.ToolType.CLONESTAMP,
  false,
  {x: 100, y: 100},
  app.activeDocument.layers[0]
);
```
Min Version
23.3
- Defined in packages/types-photoshop/src/internal/dom/PathItem.d.ts:239

Class PathItem

See

Example

Min Version

Index

Accessors

Methods

Accessors

docId

Returns number

See

Min Version

id

Returns number

See

Min Version

kind

Returns PathKind

See

Min Version

Parameters

Returns void

name

Returns string

See

Min Version

Parameters

Returns void

parent

Returns Document

See

Min Version

subPathItems

Returns SubPathItems

See

Min Version

typename

Returns "PathItem"

See

Min Version

Methods

deselect

Returns Promise<void>

See

Example

Min Version

duplicate

Parameters

Returns Promise<PathItem>

See

Example

Min Version

fillPath

Parameters

Returns Promise<void>

See

Example

Min Version

makeClippingPath

Parameters

Returns Promise<void>

See

Example

Min Version

makeSelection

Parameters

Returns Promise<void>

See

Example

Min Version

remove

Returns Promise<void>

See

Example

Min Version

select

Returns Promise<void>

See

Example

Min Version