Skip to main content
Alpha: Document API is currently alpha and subject to breaking changes.

​
Summary

  • Operation ID: tables.setRowOptions
  • API member path: editor.doc.tables.setRowOptions(...)
  • Mutates document: yes
  • Idempotency: idempotent
  • Supports tracked mode: no
  • Supports dry run: yes
  • Deterministic target resolution: yes

​
Input fields

FieldTypeRequiredDescription
allowBreakAcrossPagesbooleanno
nodeIdstringno
repeatHeaderbooleanno
rowIndexintegerno
tableNodeIdstringno
tableTargetBlockNodeAddressnoBlockNodeAddress
targetBlockNodeAddressnoBlockNodeAddress

​
Example request

{}

​
Output fields

No fields.

​
Example response

{
  "success": true,
  "table": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "paragraph"
  },
  "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

{
  "additionalProperties": false,
  "oneOf": [
    {
      "required": [
        "target"
      ]
    },
    {
      "required": [
        "nodeId"
      ]
    },
    {
      "required": [
        "tableTarget",
        "rowIndex"
      ]
    },
    {
      "required": [
        "tableNodeId",
        "rowIndex"
      ]
    }
  ],
  "properties": {
    "allowBreakAcrossPages": {
      "type": "boolean"
    },
    "nodeId": {
      "type": "string"
    },
    "repeatHeader": {
      "type": "boolean"
    },
    "rowIndex": {
      "minimum": 0,
      "type": "integer"
    },
    "tableNodeId": {
      "type": "string"
    },
    "tableTarget": {
      "$ref": "#/$defs/BlockNodeAddress"
    },
    "target": {
      "$ref": "#/$defs/BlockNodeAddress"
    }
  },
  "type": "object"
}

{
  "oneOf": [
    {
      "additionalProperties": false,
      "properties": {
        "success": {
          "const": true
        },
        "table": {
          "$ref": "#/$defs/BlockNodeAddress"
        },
        "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/BlockNodeAddress"
    },
    "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"
}