---
title: "table.views.patchField: Show, hide, resize or move a field in a view — Table kit command — Kition"
description: "Shows, hides, resizes, moves or freezes one field in one view."
canonical: "https://developer.kition.ai/docs/kits/table/commands/table.views.patchField"
---

> Canonical HTML: [https://developer.kition.ai/docs/kits/table/commands/table.views.patchField](https://developer.kition.ai/docs/kits/table/commands/table.views.patchField)

# table.views.patchField

**Show, hide, resize or move a field in a view.** Shows, hides, resizes, moves or freezes one field in one view.

- Kit: Table 0.4.0 (.ktable); reference: [Table kit commands](https://developer.kition.ai/docs/kits/table.md)
- Changes the document: yes
- Acts on: `fieldId` (one id), which a run step’s `on` fills

## Parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `asOrigin` | `string` | no | system:<name> writes as a host feature, outside the undo history. Agents leave it out. |
| `fieldId` | `integer \| string` | yes | The field's id. |
| `frozen` | `boolean` | no |  |
| `position` | `integer` | no |  |
| `tableId` | `integer \| string` | yes | The table's id. |
| `viewId` | `integer \| string` | yes | The view's id. |
| `visible` | `boolean` | no |  |
| `width` | `integer` | no |  |

## Call through table_run

```text
table_run {
  "path": "<file>.ktable",
  "steps": [{ "command": "table.views.patchField", "params": { "tableId": <integer | string>, "viewId": <integer | string>, "fieldId": <integer | string> } }]
}
```

The required parameters, with placeholders for their types: not a tested example. Optional: `asOrigin`, `frozen`, `position`, `visible`, `width`. table_run answers the step’s result in `completed[i].result`.

## Result

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `change` | `object \| null` | no | What the call changed, or null. |
| `error` | `object` | no | Why the call failed (A18); the file is as it was. |
| `result` | `object` | no | One field's settings in one view. |

```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": "One field's settings in one view.",
      "properties": {
        "field_id": {
          "description": "The field's id.",
          "type": "integer"
        },
        "frozen": {
          "description": "Kept in view while scrolling sideways.",
          "type": "boolean"
        },
        "position": {
          "description": "Its position in the view.",
          "type": "integer"
        },
        "view_id": {
          "description": "The view's id.",
          "type": "integer"
        },
        "visible": {
          "description": "Shown in the view.",
          "type": "boolean"
        },
        "width": {
          "description": "Its column width in pixels, 40 to 1200.",
          "type": "integer"
        }
      },
      "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"
    },
    "fieldId": {
      "description": "The field's id.",
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "type": "string"
        }
      ],
      "x-khp-index-numbers": true,
      "x-khp-types": [
        "Field"
      ]
    },
    "frozen": {
      "type": "boolean"
    },
    "position": {
      "type": "integer"
    },
    "tableId": {
      "description": "The table's id.",
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "type": "string"
        }
      ],
      "x-khp-types": [
        "Table"
      ]
    },
    "viewId": {
      "description": "The view's id.",
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "type": "string"
        }
      ],
      "x-khp-types": [
        "View"
      ]
    },
    "visible": {
      "type": "boolean"
    },
    "width": {
      "type": "integer"
    }
  },
  "required": [
    "tableId",
    "viewId",
    "fieldId"
  ],
  "type": "object"
}
```

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