Skip to content
SurfaceDocs
FRGet started
DocsModel reference

workspaceTableCellFormat

Properties, variants, types and bounds for workspaceTableCellFormat.

This reference describes the full structure of workspaceTableCellFormat. Paths include nested objects, list items and conditional branches. A branch selected by kind, contract or mode only admits its own properties.

Structure and values

Field Options / expected values Description
[kind=text].kind "text" Required. Selects the variant and the properties admitted in this branch.
[kind=number].kind "number" Required. Selects the variant and the properties admitted in this branch.
[kind=number].maximumFractionDigits integer; ≥ 0; ≤ 8 Required. Cardinality or budget bound for the named resource. Exceeding the bound is refused; null denotes no bound only where admitted by the schema.
[kind=boolean].kind "boolean" Required. Selects the variant and the properties admitted in this branch.
[kind=boolean].trueLabel string; min length 1; max length 4000 Required. Defines true Label for this object. Observe the type, variants and bounds in the Options column.
[kind=boolean].falseLabel string; min length 1; max length 4000 Required. Defines false Label for this object. Observe the type, variants and bounds in the Options column.
[variant 4].kind "date" | "datetime" Required. Selects the variant and the properties admitted in this branch.
[kind=badge].kind "badge" Required. Selects the variant and the properties admitted in this branch.

Reading the contract

A path ending in [] describes each list item; {key} describes each dictionary value. The ↻ marker refers to the same recursive expression. Closed objects reject additional properties. Semantic validation denotes an additional check: matching a type does not make a reference, permission or transition valid. References must resolve in the Model and the current user context.

An older variant cannot accept properties belonging to a newer variant. The compiler checks the version and consistency of the complete Model.

Structural example

This fragment passes the schema for this section. Its business references must be defined in the enclosing Model.

{
  "kind": "text"
}

Complete Model index · Build a Model

Applied examples : Collection columns and formats

Declare each column source before its format, order and filters.

Configuration

Contract object workspaceTableCellFormat. Properties and accepted values.

{
  "kind": "text"
}

Variation and connection

Fragment placed in presentation.tableViews[].layout. Properties and accepted values.

{
  "contract": "WorkspaceTableLayout@1",
  "grouping": null,
  "columns": [
    {
      "columnKey": "number",
      "visible": true,
      "width": null,
      "frozen": true,
      "format": {
        "kind": "text"
      },
      "headerFilterParameterKey": null
    },
    {
      "columnKey": "status",
      "visible": true,
      "width": null,
      "frozen": false,
      "format": {
        "kind": "badge"
      },
      "headerFilterParameterKey": null
    },
    {
      "columnKey": "amount",
      "visible": true,
      "width": null,
      "frozen": false,
      "format": {
        "kind": "number",
        "maximumFractionDigits": 2
      },
      "headerFilterParameterKey": null
    }
  ],
  "columnGroups": []
}

UI layout example

The illustrative layout below places this configuration in the Clients/Quotes app. Insert each fragment at the stated location, with Field, Query and Action references matching the Model declarations.

  1. Number
  2. Status
  3. Amount
  4. Last updated
ILLUSTRATIVE LAYOUTClients / Quotes app
SurfaceClients / North StudioExample
workspaceTableCellFormatworkspaceTableCellFormat
Clients
MODEL CONTEXTNorth StudioDeclarative configuration
kind
text

Values above follow the configuration fragment; references resolve in the complete Model.

Search for a concept, field or action.Esc