Polotno
Design Format

GroupElement

Documentation for the GroupElement type in the Polotno design JSON Schema.

Type Information

Base Type: object

Properties

PropertyTypeDescription
idstringNo description provided
type"group"No description provided
namestringNo description provided
customunknownNo description provided
opacitynumberNo description provided
visiblebooleanNo description provided
selectablebooleanNo description provided
removablebooleanNo description provided
alwaysOnTopbooleanNo description provided
showInExportbooleanNo description provided
animationsArray<Animation>No description provided
childrenArray<Element>Child elements in this group.

JSON Schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "type": {
      "type": "string",
      "const": "group"
    },
    "name": {
      "default": "",
      "type": "string"
    },
    "custom": {},
    "opacity": {
      "default": 1,
      "type": "number"
    },
    "visible": {
      "default": true,
      "type": "boolean"
    },
    "selectable": {
      "default": true,
      "type": "boolean"
    },
    "removable": {
      "default": true,
      "type": "boolean"
    },
    "alwaysOnTop": {
      "default": false,
      "type": "boolean"
    },
    "showInExport": {
      "default": true,
      "type": "boolean"
    },
    "animations": {
      "default": [],
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "delay": {
            "default": 0,
            "description": "Delay before the animation starts, in milliseconds.",
            "type": "number"
          },
          "duration": {
            "default": 500,
            "description": "Animation duration in milliseconds.",
            "type": "number"
          },
          "enabled": {
            "default": true,
            "description": "Whether the animation is enabled.",
            "type": "boolean"
          },
          "type": {
            "type": "string",
            "enum": [
              "enter",
              "exit",
              "loop"
            ],
            "description": "Animation phase."
          },
          "name": {
            "default": "none",
            "description": "Animation name identifier.",
            "type": "string"
          },
          "data": {
            "default": {},
            "description": "Animation-specific data."
          }
        },
        "required": [
          "type"
        ]
      }
    },
    "children": {
      "default": [],
      "description": "Child elements in this group.",
      "type": "array",
      "items": {
        "$ref": "#/$defs/__schema0"
      }
    }
  },
  "required": [
    "id",
    "type"
  ]
}

On this page