Edit in GitHubLog an issue

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:

Copied to your clipboard
1const currentPathItem = app.activeDocument.pathItems.getByName("myPath");
2currentPathItem.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.

Added in Photoshop 23.3

Properties#

NameTypeAccessDescription
docIdnumberRead-onlyThe ID of the document of this pathItem.
idnumberRead-onlyFor 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.
kindPathKindRead-writeThe type of this path
namestringRead-writeName of this path
parentDocumentRead-onlyOwner document
subPathItemsSubPathItemsRead-onlyThe contained SubPathItems in this path
typenamestringRead-onlyThe class name of the referenced PathItem object

Methods#

deselect#

Promise<void>

Deselects this pathItem object.


duplicate#

Promise<PathItem>

Duplicates the pathItem object with the new name, returning the duplicate.

Parameters#

NameType
name?string

fillPath#

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#

NameTypeDefault value
fillColor?SolidColor-
mode?ColorBlendMode-
opacitynumber100.0
preserveTransparencybooleanfalse
feathernumber0.0
wholePathbooleantrue
antiAliasbooleantrue

makeClippingPath#

Promise<void>

Makes this the clipping path for this document.

flatness tells the PostScript printer how to approximate curves in the path.

Parameters#

NameType
flatness?number

makeSelection#

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#

NameType
feather?number
antiAlias?boolean
operation?SelectionType

remove#

Promise<void>

Deletes this object


select#

Promise<void>

Makes this the active or selected PathItem object


strokePath#

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#

NameTypeDefault value
toolToolType-
simulatePressurebooleanfalse
sourceOrigin?object-
sourceOrigin.xnumber-
sourceOrigin.ynumber-
sourceLayer?Layer-
  • Privacy
  • Terms of Use
  • Do not sell my personal information
  • AdChoices
Copyright © 2022 Adobe. All rights reserved.