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.

Indexable

▪ [index: number]: PathItem

Used to access the paths in the collection.

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

Properties

Name
Type
Access
Min Version
Description
length
number
R
23.3
Number of PathItem objects in this collection.
parent
Document
R
23.3
The owner document of this PathItem collection.

Methods

add

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.3</span>

<br/> 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
Type
name
string
entirePath
SubPathInfo[]

getByName

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.3</span>

<br/> PathItem

Retrieve the first PathItem matching the given name.

Parameters

Name
Type
Description
name
string
Name to find

removeAll

<span class="minversion" style="display: block; margin-bottom: -1em; margin-left: 36em; float:left; opacity:0.5;">23.3</span>

<br/> void

Removes all paths from this collection.