Class

PathItems

 A collection of path items.

See also PathItem.

QuickLinks

add, ellipse, getByName, polygon, rectangle, removeAll, roundedRectangle, star

Hierarchy

Object

PathItems

Properties

Property	Type	Access	Description
length	int	readonly	Number of elements in the collection.
parent	Object	readonly	The object's container.
typename	string	readonly	The class name of the object.

Methods

Class

PathItem add ()
Create a path.

PathItem ellipse ([top: number=100][, left: number=100][, width: number=50][, height: number=100][, reversed: bool=false][, inscribed: bool=true])
Create an elliptical path item.

Parameter	Type	Description
top	number	The ellipse's bounds. (default: 100) (Optional)
left	number	The ellipse's bounds. (default: 100) (Optional)
width	number	The ellipse's bounds. (default: 50) (Optional)
height	number	The height of the ellipse. (default: 100) (Optional)
reversed	bool	Is the ellipse path reversed? (default: false) (Optional)
inscribed	bool	Is the ellipse path inscribed? (default: true) (Optional)

PathItem polygon ([centerX: number=200][, centerY: number=300][, radius: number=50][, sides: Int32=8][, reversed: bool=false])
Used to create a regular polygon path item. Not for path item access.

Parameter	Type	Description
centerX	number	(default: 200) (Optional)
centerY	number	(default: 300) (Optional)
radius	number	The radius of the polygon points. (default: 50) (Optional)
sides	Int32	The number of sides on the polygon. (default: 8) (Optional)
reversed	bool	Is the polygon path reversed? (default: false) (Optional)

PathItem rectangle (top: number, left: number, width: number, height: number[, reversed: bool=false])
Used to create a rectangular path item. Not for path item access.

Parameter	Type	Description
top	number	The top coordinate of the rectangle's bounds.
left	number	The left coordinate of the rectangle's bounds.
width	number	The width of the rectangle.
height	number	The height of the rectangle.
reversed	bool	Is the rectangle path reversed? (default: false) (Optional)

PathItem roundedRectangle (top: number, left: number, width: number, height: number[, horizontalRadius: number=15][, verticalRadius: number=20][, reversed: bool=false])
Used to create a rounded-corner rectangular path item. Not for path item access.

Parameter	Type	Description
top	number
left	number
width	number
height	number
horizontalRadius	number	Horizontal corner radius. (default: 15) (Optional)
verticalRadius	number	Vertical corner radius. (default: 20) (Optional)
reversed	bool	Is the rectangle path reversed? (default: false) (Optional)

PathItem star ([centerX: number=200][, centerY: number=300][, radius: number=50][, innerRadius: number=20][, points: Int32=5][, reversed: bool=false])
Used to create a star-shaped path item. Not for path item access.

Parameter	Type	Description
centerX	number	(default: 200) (Optional)
centerY	number	(default: 300) (Optional)
radius	number	The outside radius of the star points. (default: 50) (Optional)
innerRadius	number	The inside radius of the star points. (default: 20) (Optional)
points	Int32	The number of points on the star. (default: 5) (Optional)
reversed	bool	Is the star path reversed? (default: false) (Optional)

Instances

PathItem getByName (name: string)
Get the first element in the collection with the provided name.

Parameter	Type	Description
name	string

void removeAll ()
Deletes all elements.

Element of

CompoundPathItem.pathItems

Document.pathItems

GroupItem.pathItems

Layer.pathItems

Jongware, 25-Nov-2012 v3.0.3i

Contents :: Index