Polotno Docs

GroupElement

Documentation for the GroupElement schema definition in the Polotno Design JSON Schema.

GroupElement

Type Information

Base Type: object

Properties

PropertyTypeDescription
alwaysOnTopbooleanWhether group stays on top of others.
childrenArray<Element>Child elements in this group.
customunknownCustom data attached to the group.
idstringUnique identifier for the group.
namestringDisplay name for the group.
opacitynumberOpacity level (0-1).
removablebooleanWhether group can be removed.
selectablebooleanWhether group can be selected.
showInExportbooleanWhether group appears in exports.
type"group"Element type identifier.
visiblebooleanWhether group is visible.

JSON Schema

{
  "additionalProperties": false,
  "properties": {
    "alwaysOnTop": {
      "description": "Whether group stays on top of others.",
      "type": "boolean"
    },
    "children": {
      "description": "Child elements in this group.",
      "items": {
        "$ref": "#/definitions/Element"
      },
      "type": "array"
    },
    "custom": {
      "description": "Custom data attached to the group."
    },
    "id": {
      "description": "Unique identifier for the group.",
      "type": "string"
    },
    "name": {
      "description": "Display name for the group.",
      "type": "string"
    },
    "opacity": {
      "description": "Opacity level (0-1).",
      "type": "number"
    },
    "removable": {
      "description": "Whether group can be removed.",
      "type": "boolean"
    },
    "selectable": {
      "description": "Whether group can be selected.",
      "type": "boolean"
    },
    "showInExport": {
      "description": "Whether group appears in exports.",
      "type": "boolean"
    },
    "type": {
      "const": "group",
      "description": "Element type identifier.",
      "type": "string"
    },
    "visible": {
      "description": "Whether group is visible.",
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "type",
    "children"
  ],
  "type": "object"
}