Summary
Set the layout mode of the target table.- Operation ID:
tables.setLayout - API member path:
editor.doc.tables.setLayout(...) - 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 table already uses the requested layout mode.Input fields
Variant 1 (target.nodeType=“table”)
| Field | Type | Required | Description |
|---|---|---|---|
alignment | enum | no | "left", "center", "right" |
autoFitMode | enum | no | "fixedWidth", "fitContents", "fitWindow" |
leftIndentPt | number | no | |
preferredWidth | number | no | |
preferredWidthType | enum | no | "dxa", "auto", "pct" |
tableDirection | enum | no | "ltr", "rtl" |
target | TableAddress | yes | TableAddress |
target.kind | "block" | yes | Constant: "block" |
target.nodeId | string | yes | |
target.nodeType | "table" | yes | Constant: "table" |
Variant 2 (required: nodeId)
| Field | Type | Required | Description |
|---|---|---|---|
alignment | enum | no | "left", "center", "right" |
autoFitMode | enum | no | "fixedWidth", "fitContents", "fitWindow" |
leftIndentPt | number | no | |
nodeId | string | yes | |
preferredWidth | number | no | |
preferredWidthType | enum | no | "dxa", "auto", "pct" |
tableDirection | enum | no | "ltr", "rtl" |
Example request
{
"preferredWidth": 12.5,
"preferredWidthType": "dxa",
"target": {
"kind": "block",
"nodeId": "node-def456",
"nodeType": "table"
}
}
Output fields
Variant 1 (success=true)
| Field | Type | Required | Description |
|---|---|---|---|
success | true | yes | Constant: true |
table | TableAddress | no | TableAddress |
table.kind | "block" | no | Constant: "block" |
table.nodeId | string | no | |
table.nodeType | "table" | no | Constant: "table" |
trackedChangeRefs | EntityAddress[] | no |
Variant 2 (success=false)
| Field | Type | Required | Description |
|---|---|---|---|
failure | object | yes | |
failure.code | enum | yes | "NO_OP", "INVALID_TARGET", "TARGET_NOT_FOUND", "CAPABILITY_UNAVAILABLE" |
failure.details | any | no | |
failure.message | string | yes | |
success | false | yes | Constant: 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_FOUNDINVALID_TARGETCAPABILITY_UNAVAILABLE
Non-applied failure codes
INVALID_TARGETNO_OP
Raw schemas
Raw input schema
Raw input schema
{
"additionalProperties": false,
"oneOf": [
{
"required": [
"target"
]
},
{
"required": [
"nodeId"
]
}
],
"properties": {
"alignment": {
"enum": [
"left",
"center",
"right"
]
},
"autoFitMode": {
"enum": [
"fixedWidth",
"fitContents",
"fitWindow"
]
},
"leftIndentPt": {
"type": "number"
},
"nodeId": {
"type": "string"
},
"preferredWidth": {
"type": "number"
},
"preferredWidthType": {
"enum": [
"dxa",
"auto",
"pct"
]
},
"tableDirection": {
"enum": [
"ltr",
"rtl"
]
},
"target": {
"$ref": "#/$defs/TableAddress"
}
},
"type": "object"
}
Raw output schema
Raw output schema
{
"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"
}
]
}
Raw success schema
Raw success schema
{
"additionalProperties": false,
"properties": {
"success": {
"const": true
},
"table": {
"$ref": "#/$defs/TableAddress"
},
"trackedChangeRefs": {
"items": {
"$ref": "#/$defs/EntityAddress"
},
"type": "array"
}
},
"required": [
"success"
],
"type": "object"
}
Raw failure schema
Raw failure schema
{
"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"
}

