Table kit command

table.dashboards.upsert

Create or replace a dashboard

Creates or replaces a dashboard by its id: its title, source table, layout and widgets (charts, numbers, lists over tables).

Kit
Table 0.4.0 (.ktable)
Changes the document
yes

Parameters

Parameters of table.dashboards.upsert
NameTypeRequiredDescription
asOriginstringnosystem:<name> writes as a host feature, outside the undo history. Agents leave it out.
dashboardIdinteger | stringyesThe dashboard's id.
layoutany[]noThe widgets' positions.
ordernumberno
source_table_idinteger | stringno
titlestringno
widgetsobject[]noThe widgets, each an object with its own `id`.

Call through table_run

text
table_run {
  "path": "<file>.ktable",
  "steps": [{ "command": "table.dashboards.upsert", "params": { "dashboardId": <integer | string> } }]
}

The required parameters, with placeholders for their types: not a tested example. Optional: asOrigin, layout, order, source_table_id, title, widgets. table_run answers the step’s result in completed[i].result.

Result

Result of table.dashboards.upsert
NameTypeRequiredDescription
changeobject | nullnoWhat the call changed, or null.
errorobjectnoWhy the call failed (A18); the file is as it was.
resultobjectnoA dashboard.
Result JSON Schema
json
{
  "additionalProperties": false,
  "description": "The request's own answer is in `result`, beside `change`: what the call changed in the document (null when nothing changed). A failed call answers `error` instead (A18).",
  "properties": {
    "change": {
      "description": "What the call changed, or null.",
      "oneOf": [
        {
          "additionalProperties": false,
          "description": "What one projection changed in the relational tables, by integer id. Every list is sorted and\nholds no repeats.",
          "properties": {
            "dashboards": {
              "description": "A dashboard, or the base's list of them, changed.",
              "type": "boolean"
            },
            "documentId": {
              "type": "string"
            },
            "origin": {
              "description": "Who wrote it: kind:principal, or a system origin's label.",
              "type": "string"
            },
            "recordsDeleted": {
              "description": "[tableId, rowKey] pairs.",
              "items": {
                "items": {},
                "type": "array"
              },
              "type": "array"
            },
            "recordsReordered": {
              "description": "Tables whose records' positions changed.",
              "items": {
                "type": "integer"
              },
              "type": "array"
            },
            "recordsUpserted": {
              "description": "[tableId, rowKey] pairs.",
              "items": {
                "items": {},
                "type": "array"
              },
              "type": "array"
            },
            "schema": {
              "description": "Tables whose fields were added, removed, updated, or reordered.",
              "items": {
                "type": "integer"
              },
              "type": "array"
            },
            "tables": {
              "description": "Tables whose own row changed: created, deleted, renamed, moved, or given a new primary\nfield.",
              "items": {
                "type": "integer"
              },
              "type": "array"
            },
            "views": {
              "description": "Views created, deleted, updated, or reordered, or whose column widths or visibility\nchanged.",
              "items": {
                "type": "integer"
              },
              "type": "array"
            }
          },
          "required": [
            "tables",
            "schema",
            "views",
            "recordsReordered",
            "dashboards"
          ],
          "type": "object"
        },
        {
          "type": "null"
        }
      ]
    },
    "error": {
      "additionalProperties": false,
      "description": "Why the call failed (A18); the file is as it was.",
      "properties": {
        "code": {
          "enum": [
            "invalid-params",
            "invalid-op",
            "invalid-value",
            "not-found",
            "read-only",
            "unknown-command",
            "command-failed",
            "not-open",
            "draft-required",
            "not-allowed",
            "unsupported",
            "unavailable",
            "failed"
          ],
          "type": "string"
        },
        "index": {
          "description": "The failing step or operation.",
          "type": "integer"
        },
        "message": {
          "type": "string"
        },
        "retryable": {
          "type": "boolean"
        }
      },
      "required": [
        "code",
        "message"
      ],
      "type": "object"
    },
    "result": {
      "additionalProperties": true,
      "description": "A dashboard.",
      "properties": {
        "id": {
          "description": "The dashboard's id.",
          "type": "string"
        },
        "layout": {
          "items": {
            "description": "A widget's position."
          },
          "type": "array"
        },
        "order": {
          "description": "Its position among the dashboards.",
          "type": "number"
        },
        "source_table_id": {
          "description": "The table its widgets read by default, or null."
        },
        "title": {
          "description": "The dashboard's title.",
          "type": "string"
        },
        "widgets": {
          "items": {
            "additionalProperties": true,
            "description": "A widget (chart, number, list), with its own id.",
            "type": "object"
          },
          "type": "array"
        }
      },
      "type": "object"
    }
  },
  "type": "object"
}

Parameter schema

json
{
  "additionalProperties": false,
  "properties": {
    "asOrigin": {
      "description": "system:<name> writes as a host feature, outside the undo history. Agents leave it out.",
      "type": "string"
    },
    "dashboardId": {
      "description": "The dashboard's id.",
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "type": "string"
        }
      ],
      "x-khp-types": [
        "Dashboard"
      ]
    },
    "layout": {
      "description": "The widgets' positions.",
      "items": {},
      "type": "array"
    },
    "order": {
      "type": "number"
    },
    "source_table_id": {
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "type": "string"
        }
      ],
      "x-khp-types": [
        "Table"
      ]
    },
    "title": {
      "type": "string"
    },
    "widgets": {
      "description": "The widgets, each an object with its own `id`.",
      "items": {
        "additionalProperties": true,
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "dashboardId"
  ],
  "type": "object"
}

Generated from kition-sdk packages/script/kits/table.ts and the kit itself (kition-table@ee73209). As data: commands.jsonl.