Adobe Illustrator · Schema

PathItemCreate

PathItemCreate from Adobe Illustrator API

Creative CloudDesignIllustratorVector Graphics

Properties

Name Type Description
name string Name of the path item.
pathType string Type of path to create.
pathPoints array Array of path points for freeform paths. Required when pathType is "freeform".
position array Position [x, y] in points.
width number Width in points (for rectangle, ellipse).
height number Height in points (for rectangle, ellipse).
cornerRadius number Corner radius for rounded rectangle.
sides integer Number of sides for polygon.
points integer Number of points for star.
innerRadius number Inner radius for star.
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.
opacity number Opacity as a percentage (0-100).
layer string Target layer name.
View JSON Schema on GitHub

JSON Schema

adobe-illustrator-scripting-path-item-create-schema.json Raw ↑ 
{
  "$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-create-schema.json",
  "title": "PathItemCreate",
  "description": "PathItemCreate from Adobe Illustrator API",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the path item.",
      "example": "Example Artboard"
    },
    "pathType": {
      "type": "string",
      "description": "Type of path to create.",
      "enum": [
        "freeform",
        "rectangle",
        "roundedRectangle",
        "ellipse",
        "polygon",
        "star",
        "line"
      ],
      "default": "freeform",
      "example": "freeform"
    },
    "pathPoints": {
      "type": "array",
      "description": "Array of path points for freeform paths. Required when pathType is \"freeform\".",
      "items": {
        "$ref": "#/components/schemas/PathPoint"
      }
    },
    "position": {
      "type": "array",
      "description": "Position [x, y] in points.",
      "items": {
        "type": "number"
      },
      "minItems": 2,
      "maxItems": 2
    },
    "width": {
      "type": "number",
      "description": "Width in points (for rectangle, ellipse).",
      "example": 72.0
    },
    "height": {
      "type": "number",
      "description": "Height in points (for rectangle, ellipse).",
      "example": 72.0
    },
    "cornerRadius": {
      "type": "number",
      "description": "Corner radius for rounded rectangle.",
      "example": 72.0
    },
    "sides": {
      "type": "integer",
      "description": "Number of sides for polygon.",
      "minimum": 3,
      "example": 1024
    },
    "points": {
      "type": "integer",
      "description": "Number of points for star.",
      "minimum": 3,
      "example": 1024
    },
    "innerRadius": {
      "type": "number",
      "description": "Inner radius for star.",
      "example": 72.0
    },
    "filled": {
      "type": "boolean",
      "description": "Whether the path has a fill.",
      "default": true,
      "example": true
    },
    "fillColor": {
      "$ref": "#/components/schemas/Color"
    },
    "stroked": {
      "type": "boolean",
      "description": "Whether the path has a stroke.",
      "default": true,
      "example": true
    },
    "strokeColor": {
      "$ref": "#/components/schemas/Color"
    },
    "strokeWidth": {
      "type": "number",
      "description": "Stroke width in points.",
      "default": 1,
      "example": 72.0
    },
    "opacity": {
      "type": "number",
      "description": "Opacity as a percentage (0-100).",
      "minimum": 0,
      "maximum": 100,
      "default": 100,
      "example": 72.0
    },
    "layer": {
      "type": "string",
      "description": "Target layer name.",
      "example": "example_value"
    }
  }
}