searches the current version of every section · esc to close

Viewing this section as of v0.1.33 (tagged 2026-04-03). Go to current →

22 Form Type Object

A Form type object represents the layout of the scene.

Form type is defined as

interface Form {
    version: string // REQUIRED
    layout: Embedding[] // REQUIRED
    metadata?: FormMetadata // OPTIONAL
    properties?: FormProperties // OPTIONAL
}

where

  • version is REQUIRED, and its value MUST be of type string equal to one of the standard’s version numbers (see Section 04-Version-Control).
  • layout is REQUIRED, and its value MUST be an array of Embedding, representing placed artifacts in the space. An empty layout MUST have the value [].
  • metadata is OPTIONAL, and its value MUST be of type FormMetadata. It is used to hold any additional descriptive data about the space. If not provided, an empty FormMetadata is used by default.
  • properties is OPTIONAL, and its value MUST be of type FormProperties. It represents additional properties of the scene. If not provided, an empty FormProperties is used by default.