at.inlay.canvas

inlay.at

Documentation

Canvas - a spatial arrangement of component windows.

main record

Canvas - a spatial arrangement of component windows.

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Optional

An RFC 3339 formatted timestamp.

overrides array of string did Optional

Ordered DID stack for resolution overrides. DIDs listed here are prepended to every component's import stack during rendering.

windows array of ref #window Required

No description available.

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "windows"
    ],
    "properties": {
      "windows": {
        "type": "array",
        "items": {
          "ref": "#window",
          "type": "ref"
        }
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "overrides": {
        "type": "array",
        "items": {
          "type": "string",
          "format": "did"
        },
        "description": "Ordered DID stack for resolution overrides. DIDs listed here are prepended to every component's import stack during rendering."
      }
    }
  },
  "description": "Canvas - a spatial arrangement of component windows."
}

window object

No description available.

Properties

componentUri string at-uri Required

AT URI of the component record to render.

height integer Optional

No description available.

id string Required

No description available.

maxLength: 64 bytes

props unknown Optional

Properties to pass to the component.

width integer Optional

No description available.

x integer Required

No description available.

y integer Required

No description available.

z integer Required

No description available.

View raw schema

{
  "type": "object",
  "required": [
    "id",
    "x",
    "y",
    "z",
    "componentUri"
  ],
  "properties": {
    "x": {
      "type": "integer"
    },
    "y": {
      "type": "integer"
    },
    "z": {
      "type": "integer"
    },
    "id": {
      "type": "string",
      "maxLength": 64
    },
    "props": {
      "type": "unknown",
      "description": "Properties to pass to the component."
    },
    "width": {
      "type": "integer"
    },
    "height": {
      "type": "integer"
    },
    "componentUri": {
      "type": "string",
      "format": "at-uri",
      "description": "AT URI of the component record to render."
    }
  }
}