Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.superdoc.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Summary

Replace the text content of a single table cell with plain text (one paragraph). Accepts either a direct cell locator (a tableCell block address with kind, nodeType, nodeId) OR a table target with rowIndex + columnIndex. Cell properties (vertical alignment, shading, borders, colspan/rowspan) are preserved. Use this for filling cells with values, replacing cell text, or populating empty tables. Much simpler than walking paragraphs and runs through superdoc_edit.
  • Operation ID: tables.setCellText
  • API member path: editor.doc.tables.setCellText(...)
  • Mutates document: yes
  • Idempotency: idempotent
  • Supports tracked mode: no
  • Supports dry run: yes
  • Deterministic target resolution: yes

​
Expected result

Returns a TableMutationResult receipt; reports NO_OP if the cell already contains exactly this text.

​
Input fields

​
Variant 1 (target.nodeType=“tableCell”)

FieldTypeRequiredDescription
targetTableCellAddressyesTableCellAddress
target.kind"block"yesConstant: "block"
target.nodeIdstringyes
target.nodeType"tableCell"yesConstant: "tableCell"
textstringyes

​
Variant 2 (required: nodeId, text)

FieldTypeRequiredDescription
nodeIdstringyes
textstringyes

​
Variant 3 (target.nodeType=“table”)

FieldTypeRequiredDescription
columnIndexintegeryes
rowIndexintegeryes
targetTableAddressyesTableAddress
target.kind"block"yesConstant: "block"
target.nodeIdstringyes
target.nodeType"table"yesConstant: "table"
textstringyes

​
Variant 4 (required: nodeId, rowIndex, columnIndex, text)

FieldTypeRequiredDescription
columnIndexintegeryes
nodeIdstringyes
rowIndexintegeryes
textstringyes

​
Example request

{
  "target": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "tableCell"
  },
  "text": "Hello, world."
}

​
Output fields

​
Variant 1 (success=true)

FieldTypeRequiredDescription
successtrueyesConstant: true
tableTableAddressnoTableAddress
table.kind"block"noConstant: "block"
table.nodeIdstringno
table.nodeType"table"noConstant: "table"
trackedChangeRefsEntityAddress[]no

​
Variant 2 (success=false)

FieldTypeRequiredDescription
failureobjectyes
failure.codeenumyes"NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE"
failure.detailsanyno
failure.messagestringyes
successfalseyesConstant: false
When present, result.table is the follow-up address to reuse after this call. For non-destructive table-targeted mutations, pass result.table.nodeId to the next table operation instead of re-running find(). Destructive operations may omit table.

​
Example response

{
  "success": true,
  "table": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "table"
  },
  "trackedChangeRefs": [
    {
      "entityId": "entity-789",
      "entityType": "comment",
      "kind": "entity"
    }
  ]
}

​
Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • CAPABILITY_UNAVAILABLE

​
Non-applied failure codes

  • INVALID_TARGET
  • NO_OP

​
Raw schemas

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "target": {
          "$ref": "#/$defs/TableCellAddress"
        },
        "text": {
          "type": "string"
        }
      },
      "required": [
        "target",
        "text"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "nodeId": {
          "type": "string"
        },
        "text": {
          "type": "string"
        }
      },
      "required": [
        "nodeId",
        "text"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "columnIndex": {
          "minimum": 0,
          "type": "integer"
        },
        "rowIndex": {
          "minimum": 0,
          "type": "integer"
        },
        "target": {
          "$ref": "#/$defs/TableAddress"
        },
        "text": {
          "type": "string"
        }
      },
      "required": [
        "target",
        "rowIndex",
        "columnIndex",
        "text"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "columnIndex": {
          "minimum": 0,
          "type": "integer"
        },
        "nodeId": {
          "type": "string"
        },
        "rowIndex": {
          "minimum": 0,
          "type": "integer"
        },
        "text": {
          "type": "string"
        }
      },
      "required": [
        "nodeId",
        "rowIndex",
        "columnIndex",
        "text"
      ],
      "type": "object"
    }
  ]
}

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "const": true
        },
        "table": {
          "$ref": "#/$defs/TableAddress"
        },
        "trackedChangeRefs": {
          "items": {
            "$ref": "#/$defs/EntityAddress"
          },
          "type": "array"
        }
      },
      "required": [
        "success"
      ],
      "type": "object"
    },
    {
      "additionalProperties": false,
      "properties": {
        "failure": {
          "additionalProperties": false,
          "properties": {
            "code": {
              "enum": [
                "NO_OP",
                "INVALID_TARGET",
                "TARGET_NOT_FOUND",
                "CAPABILITY_UNAVAILABLE"
              ]
            },
            "details": {},
            "message": {
              "type": "string"
            }
          },
          "required": [
            "code",
            "message"
          ],
          "type": "object"
        },
        "success": {
          "const": false
        }
      },
      "required": [
        "success",
        "failure"
      ],
      "type": "object"
    }
  ]
}

{
  "additionalProperties": false,
  "properties": {
    "success": {
      "const": true
    },
    "table": {
      "$ref": "#/$defs/TableAddress"
    },
    "trackedChangeRefs": {
      "items": {
        "$ref": "#/$defs/EntityAddress"
      },
      "type": "array"
    }
  },
  "required": [
    "success"
  ],
  "type": "object"
}

{
  "additionalProperties": false,
  "properties": {
    "failure": {
      "additionalProperties": false,
      "properties": {
        "code": {
          "enum": [
            "NO_OP",
            "INVALID_TARGET",
            "TARGET_NOT_FOUND",
            "CAPABILITY_UNAVAILABLE"
          ]
        },
        "details": {},
        "message": {
          "type": "string"
        }
      },
      "required": [
        "code",
        "message"
      ],
      "type": "object"
    },
    "success": {
      "const": false
    }
  },
  "required": [
    "success",
    "failure"
  ],
  "type": "object"
}