Summary
Set border properties on a table or cell range.- Operation ID:
tables.setBorder - API member path:
editor.doc.tables.setBorder(...) - 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 border properties already match.Input fields
Variant 1 (target.kind=“block”)
| Field | Type | Required | Description |
|---|---|---|---|
color | string | yes | |
edge | enum | yes | "top", "bottom", "left", "right", "insideH", "insideV", "diagonalDown", "diagonalUp" |
lineStyle | string | yes | |
lineWeightPt | number | yes | |
target | TableOrCellAddress | yes | TableOrCellAddress |
target.kind | "block" | yes | Constant: "block" |
target.nodeId | string | yes | |
target.nodeType | enum | yes | "table", "tableCell" |
Variant 2 (required: nodeId)
| Field | Type | Required | Description |
|---|---|---|---|
color | string | yes | |
edge | enum | yes | "top", "bottom", "left", "right", "insideH", "insideV", "diagonalDown", "diagonalUp" |
lineStyle | string | yes | |
lineWeightPt | number | yes | |
nodeId | string | yes |
Example request
{
"color": "example",
"edge": "top",
"lineStyle": "example",
"lineWeightPt": 12.5,
"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": {
"color": {
"pattern": "^(#?([0-9A-Fa-f]{6}|[0-9A-Fa-f]{3})|auto)$",
"type": "string"
},
"edge": {
"enum": [
"top",
"bottom",
"left",
"right",
"insideH",
"insideV",
"diagonalDown",
"diagonalUp"
]
},
"lineStyle": {
"type": "string"
},
"lineWeightPt": {
"exclusiveMinimum": 0,
"type": "number"
},
"nodeId": {
"type": "string"
},
"target": {
"$ref": "#/$defs/TableOrCellAddress"
}
},
"required": [
"edge",
"lineStyle",
"lineWeightPt",
"color"
],
"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"
}

