PathItem

PathItem from Adobe Illustrator API

Creative CloudDesignIllustratorVector Graphics

Properties

Name	Type	Description
id	string	Unique identifier of the path item.
name	string	Name of the path item.
closed	boolean	Whether the path is closed.
filled	boolean	Whether the path has a fill.
fillColor	object
stroked	boolean	Whether the path has a stroke.
strokeColor	object
strokeWidth	number	Stroke width in points.
strokeCap	string	Stroke cap style.
strokeJoin	string	Stroke join style.
strokeDashes	array	Dash pattern for the stroke.
opacity	number	Opacity as a percentage (0-100).
blendingMode	string	Blending mode.
position	array	Position [x, y] in points.
width	number	Width in points.
height	number	Height in points.
pathPoints	array	Array of path points defining the path shape.
area	number	Area of the path in square points.
length	number	Length of the path in points.
guides	boolean	Whether this path item is a guide.
clipping	boolean	Whether this path item is a clipping path.
layer	string	Name of the containing layer.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/adobe-illustrator/refs/heads/main/json-schema/adobe-illustrator-scripting-path-item-schema.json",
  "title": "PathItem",
  "description": "PathItem from Adobe Illustrator API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier of the path item.",
      "example": "example_value"
    },
    "name": {
      "type": "string",
      "description": "Name of the path item.",
      "example": "Example Artboard"
    },
    "closed": {
      "type": "boolean",
      "description": "Whether the path is closed.",
      "example": true
    },
    "filled": {
      "type": "boolean",
      "description": "Whether the path has a fill.",
      "example": true
    },
    "fillColor": {
      "$ref": "#/components/schemas/Color"
    },
    "stroked": {
      "type": "boolean",
      "description": "Whether the path has a stroke.",
      "example": true
    },
    "strokeColor": {
      "$ref": "#/components/schemas/Color"
    },
    "strokeWidth": {
      "type": "number",
      "description": "Stroke width in points.",
      "example": 72.0
    },
    "strokeCap": {
      "type": "string",
      "description": "Stroke cap style.",
      "enum": [
        "ButtEndCap",
        "RoundEndCap",
        "ProjectingEndCap"
      ],
      "example": "ButtEndCap"
    },
    "strokeJoin": {
      "type": "string",
      "description": "Stroke join style.",
      "enum": [
        "MiterEndJoin",
        "RoundEndJoin",
        "BevelEndJoin"
      ],
      "example": "MiterEndJoin"
    },
    "strokeDashes": {
      "type": "array",
      "description": "Dash pattern for the stroke.",
      "items": {
        "type": "number"
      }
    },
    "opacity": {
      "type": "number",
      "description": "Opacity as a percentage (0-100).",
      "minimum": 0,
      "maximum": 100,
      "example": 72.0
    },
    "blendingMode": {
      "type": "string",
      "description": "Blending mode.",
      "example": "example_value"
    },
    "position": {
      "type": "array",
      "description": "Position [x, y] in points.",
      "items": {
        "type": "number"
      },
      "minItems": 2,
      "maxItems": 2
    },
    "width": {
      "type": "number",
      "description": "Width in points.",
      "example": 72.0
    },
    "height": {
      "type": "number",
      "description": "Height in points.",
      "example": 72.0
    },
    "pathPoints": {
      "type": "array",
      "description": "Array of path points defining the path shape.",
      "items": {
        "$ref": "#/components/schemas/PathPoint"
      }
    },
    "area": {
      "type": "number",
      "description": "Area of the path in square points.",
      "example": 72.0
    },
    "length": {
      "type": "number",
      "description": "Length of the path in points.",
      "example": 72.0
    },
    "guides": {
      "type": "boolean",
      "description": "Whether this path item is a guide.",
      "example": true
    },
    "clipping": {
      "type": "boolean",
      "description": "Whether this path item is a clipping path.",
      "example": true
    },
    "layer": {
      "type": "string",
      "description": "Name of the containing layer.",
      "example": "example_value"
    }
  }
}