TextFrame

TextFrame from Adobe Illustrator API

Creative CloudDesignIllustratorVector Graphics

Properties

Name	Type	Description
id	string	Unique identifier of the text frame.
name	string	Name of the text frame.
kind	string	Type of text frame.
contents	string	The text content of the frame.
position	array	Position [x, y] in points.
width	number	Width of the text frame in points.
height	number	Height of the text frame in points.
orientation	string	Text orientation.
characterAttributes	object
paragraphAttributes	object
opacity	number	Opacity as a percentage (0-100).
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-text-frame-schema.json",
  "title": "TextFrame",
  "description": "TextFrame from Adobe Illustrator API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier of the text frame.",
      "example": "example_value"
    },
    "name": {
      "type": "string",
      "description": "Name of the text frame.",
      "example": "Example Artboard"
    },
    "kind": {
      "type": "string",
      "description": "Type of text frame.",
      "enum": [
        "PointText",
        "AreaText",
        "PathText"
      ],
      "example": "PointText"
    },
    "contents": {
      "type": "string",
      "description": "The text content of the frame.",
      "example": "example_value"
    },
    "position": {
      "type": "array",
      "description": "Position [x, y] in points.",
      "items": {
        "type": "number"
      },
      "minItems": 2,
      "maxItems": 2
    },
    "width": {
      "type": "number",
      "description": "Width of the text frame in points.",
      "example": 72.0
    },
    "height": {
      "type": "number",
      "description": "Height of the text frame in points.",
      "example": 72.0
    },
    "orientation": {
      "type": "string",
      "description": "Text orientation.",
      "enum": [
        "Horizontal",
        "Vertical"
      ],
      "example": "Horizontal"
    },
    "characterAttributes": {
      "$ref": "#/components/schemas/CharacterAttributes"
    },
    "paragraphAttributes": {
      "$ref": "#/components/schemas/ParagraphAttributes"
    },
    "opacity": {
      "type": "number",
      "description": "Opacity as a percentage (0-100).",
      "minimum": 0,
      "maximum": 100,
      "example": 72.0
    },
    "layer": {
      "type": "string",
      "description": "Name of the containing layer.",
      "example": "example_value"
    }
  }
}