TableSchema

interface TableSchema : Schema

Schema describing a table structure and its nested relationships.

Inheritors

Properties

Link copied to clipboard

Whether cells of this table may be edited directly in the table view. See TableSchema.editability.

Link copied to clipboard

Whether rows of this table may be edited through the row form. See TableSchema.editability.

Link copied to clipboard
abstract val children: MutableList<String>

Identifiers of child tables allowed within this table.

Link copied to clipboard
abstract val columns: MutableList<Column>

Column definitions that compose this table.

Link copied to clipboard
abstract var decorate: Boolean?
Link copied to clipboard
abstract val editability: List<String>

Editing surfaces allowed for rows of this table. Legal values are "inline" (cells editable directly in the table view) and "form" (rows editable through the row form). Values are case-sensitive; anything else is ignored. An empty list defaults to both surfaces being allowed.

Link copied to clipboard
abstract var hidden: Boolean

Whether the element is hidden by default.

Link copied to clipboard
abstract var id: String

Stable identifier of this schema node.

Link copied to clipboard
abstract var required: Boolean

Whether a value is mandatory for this schema.

Link copied to clipboard
abstract val root: Boolean

Whether this table is the root of its collection.

Link copied to clipboard

Optional list of decorators for each row (e.g. actions); used when present in schema.

Link copied to clipboard
abstract val tableLogic: TableLogic?

Optional logic rules applied at the table level.

Link copied to clipboard
abstract var title: String

Human-readable label used in editors or viewers.

Link copied to clipboard
abstract var type: Type

Discriminant describing the concrete schema/component kind.

Functions

Link copied to clipboard
abstract fun toJsonObject(): JsonObject

Serializes this instance to a structured JsonObject.

Link copied to clipboard
abstract fun toJsonString(): String

Serializes this instance to a compact JSON string.

Link copied to clipboard
abstract fun toMap(): MutableMap<String, Any?>

Converts this instance into a mutable key-value map suitable for mutation and re-serialization.