Class PathItems

The collection of PathItem objects in a document.

Access through the Document.pathItems collection property. To create new paths, see PathPointInfo and SubPathInfo classes and pass them to PathItems.add() method.

See

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

Hierarchy

Array<PathItem>
- PathItems

Indexable

[index: number]: PathItem
Used to access the paths in the collection.

Min Version
23.3

Index

Accessors

Methods

add getByName removeAll

Accessors

length

get length(): number
Number of PathItem objects in this collection.

Returns number
Min Version
23.3
Overrides Array.length
- Defined in packages/types-photoshop/src/internal/dom/collections/PathItems.d.ts:39

parent

get parent(): Document
The owner document of this PathItem collection.

Returns Document
Min Version
23.3
- Defined in packages/types-photoshop/src/internal/dom/collections/PathItems.d.ts:44

Methods

add

add(name: string, entirePath: SubPathInfo[]): PathItem
Creates a new path item object and adds it to this collection.

A new SubPathItem object is created for each SubPathInfo object provided in entirePath, and those SubPathItem objects are added to the PathItem.subPathItems collection of the returned PathItem.
Parameters
- name: string
- entirePath: SubPathInfo[]
Returns PathItem
Min Version
23.3
- Defined in packages/types-photoshop/src/internal/dom/collections/PathItems.d.ts:53

getByName

getByName(name: string): PathItem
Retrieve the first PathItem matching the given name.
Parameters
- name: string
  Name to find
Returns PathItem
Min Version
23.3
- Defined in packages/types-photoshop/src/internal/dom/collections/PathItems.d.ts:64

removeAll

removeAll(): void
Removes all paths from this collection.

Returns void
Min Version
23.3
- Defined in packages/types-photoshop/src/internal/dom/collections/PathItems.d.ts:58