TextPath
TextPath
Section titled “TextPath”textPath
Description
Section titled “Description”A path or list of paths for area or path text. A path consists of path points that define its geometry.
Properties
Section titled “Properties”TextPath.area
Section titled “TextPath.area”textPath.area
Description
Section titled “Description”The area of this path in square points. If the area is negative, the path is wound counterclockwise.
Self-intersecting paths can contain sub-areas that cancel each other out, which makes this value zero even though the path has apparent area.
Number (double); read-only.
TextPath.blendingMode
Section titled “TextPath.blendingMode”textPath.blendingMode
Description
Section titled “Description”The blend mode used when compositing an object.
TextPath.clipping
Section titled “TextPath.clipping”textPath.clipping
Description
Section titled “Description”If true, this path should be used as a clipping path.
Boolean
TextPath.closed
Section titled “TextPath.closed”textPath.closed
Description
Section titled “Description”If true, this path is closed.
Boolean
TextPath.editable
Section titled “TextPath.editable”textPath.editable
Description
Section titled “Description”Read-only. If true, this item is editable.
Boolean
TextPath.evenodd
Section titled “TextPath.evenodd”textPath.evenodd
Description
Section titled “Description”If true, the even-odd rule should be used to determine insideness.
Boolean
TextPath.fillColor
Section titled “TextPath.fillColor”textPath.fillColor
Description
Section titled “Description”The fill color of the path.
TextPath.filled
Section titled “TextPath.filled”textPath.filled
Description
Section titled “Description”If true, the path be filled.
Boolean
TextPath.fillOverprint
Section titled “TextPath.fillOverprint”textPath.fillOverprint
Description
Section titled “Description”If true, the art beneath a filled object should be overprinted.
Boolean
TextPath.guides
Section titled “TextPath.guides”textPath.guides
Description
Section titled “Description”If true, this path is a guide object.
Boolean
TextPath.height
Section titled “TextPath.height”textPath.height
Description
Section titled “Description”The height of the group item.
Number (double)
TextPath.left
Section titled “TextPath.left”textPath.left
Description
Section titled “Description”The position of the left side of the item (in points, measured from the left side of the page).
Number (double)
TextPath.note
Section titled “TextPath.note”textPath.note
Description
Section titled “Description”The note text assigned to the path.
String
TextPath.opacity
Section titled “TextPath.opacity”textPath.opacity
Description
Section titled “Description”The opacity of the object.
Range: 0.0 to 100.0
Number (double)
TextPath.parent
Section titled “TextPath.parent”textPath.parent
Description
Section titled “Description”Read-only. The parent of this object.
TextPath.pathPoints
Section titled “TextPath.pathPoints”textPath.pathPoints
Description
Section titled “Description”Read-only. The path points contained in this path item.
TextPath.polarity
Section titled “TextPath.polarity”textPath.polarity
Description
Section titled “Description”The polarity of the path.
TextPath.position
Section titled “TextPath.position”textPath.position
Description
Section titled “Description”The position (in points) of the top left corner of the textPathItem object in the format [x, y]. Does not include stroke weight.
Array of 2 numbers
TextPath.resolution
Section titled “TextPath.resolution”textPath.resolution
Description
Section titled “Description”The resolution of the path in dots per inch (dpi).
Number (double)
TextPath.selectedPathPoints
Section titled “TextPath.selectedPathPoints”textPath.selectedPathPoints
Description
Section titled “Description”Read-only. All of the selected path points in the path.
TextPath.strokeCap
Section titled “TextPath.strokeCap”textPath.strokeCap
Description
Section titled “Description”The type of line capping.
TextPath.strokeColor
Section titled “TextPath.strokeColor”textPath.strokeColor
Description
Section titled “Description”The stroke color for the path.
TextPath.stroked
Section titled “TextPath.stroked”textPath.stroked
Description
Section titled “Description”If true, the path should be stroked.
Boolean
TextPath.strokeDashes
Section titled “TextPath.strokeDashes”textPath.strokeDashes
Description
Section titled “Description”Dash lengths. Set to an empty object, {}, for a solid line.
Object
TextPath.strokeDashOffset
Section titled “TextPath.strokeDashOffset”textPath.strokeDashOffset
Description
Section titled “Description”The default distance into the dash pattern at which the pattern should be started.
Number (double)
TextPath.strokeJoin
Section titled “TextPath.strokeJoin”textPath.strokeJoin
Description
Section titled “Description”Type of joints for the path.
TextPath.strokeMiterLimit
Section titled “TextPath.strokeMiterLimit”textPath.strokeMiterLimit
Description
Section titled “Description”When a default stroke join is set to mitered, this property specifies when the join will be converted to beveled (squared-off) by default. The default miter limit of 4 means that when the length of the point reaches four times the stroke weight, the join switches from a miter join to a bevel join. A value of 1 specifies a bevel join.
Range: 1 to 500.
Default: 4
Number (double)
TextPath.strokeOverprint
Section titled “TextPath.strokeOverprint”textPath.strokeOverprint
Description
Section titled “Description”If true, the art beneath a stroked object should be overprinted.
Boolean
TextPath.strokeWidth
Section titled “TextPath.strokeWidth”textPath.strokeWidth
Description
Section titled “Description”Width of the stroke.
Number (double)
TextPath.top
Section titled “TextPath.top”textPath.top
Description
Section titled “Description”The position of the top of the item (in points, measured from the bottom of the page).
Number (double)
TextPath.typename
Section titled “TextPath.typename”textPath.typename
Description
Section titled “Description”Read-only. The class name of the referenced object.
String
TextPath.width
Section titled “TextPath.width”textPath.width
Description
Section titled “Description”The width of the item.
Number (double)
Methods
Section titled “Methods”TextPath.setEntirePath()
Section titled “TextPath.setEntirePath()”textPath.setEntirePath(pathPoints)
Description
Section titled “Description”Sets the path using the array of points specified as [x, y] coordinate pairs.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
pathPoints | Array of [x, y] coordinate pairs | Path points to set path as |
Returns
Section titled “Returns”Nothing.