Polotno Docs

Page

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

Page

Type Information

Base Type: object

Properties

PropertyTypeDescription
backgroundstringBackground color or image.
bleednumberBleed area in pixels for print.
childrenArray<Element>Elements on this page.
customunknownCustom data attached to the page.
durationnumberPage duration in milliseconds for animations.
heightnumber | "auto"Page height in pixels or 'auto' to inherit from store.
idstringUnique identifier for the page.
widthnumber | "auto"Page width in pixels or 'auto' to inherit from store.

JSON Schema

{
  "additionalProperties": false,
  "properties": {
    "background": {
      "description": "Background color or image.",
      "type": "string"
    },
    "bleed": {
      "description": "Bleed area in pixels for print.",
      "type": "number"
    },
    "children": {
      "description": "Elements on this page.",
      "items": {
        "$ref": "#/definitions/Element"
      },
      "type": "array"
    },
    "custom": {
      "description": "Custom data attached to the page."
    },
    "duration": {
      "description": "Page duration in milliseconds for animations.",
      "type": "number"
    },
    "height": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "const": "auto",
          "type": "string"
        }
      ],
      "description": "Page height in pixels or 'auto' to inherit from store."
    },
    "id": {
      "description": "Unique identifier for the page.",
      "type": "string"
    },
    "width": {
      "anyOf": [
        {
          "type": "number"
        },
        {
          "const": "auto",
          "type": "string"
        }
      ],
      "description": "Page width in pixels or 'auto' to inherit from store."
    }
  },
  "required": [
    "id",
    "width",
    "height",
    "background",
    "bleed",
    "duration",
    "children"
  ],
  "type": "object"
}