tables.getProperties

Retrieve layout and style properties of a table.

Summary

Retrieve layout and style properties of a table.

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

Expected result

Returns a TablesGetPropertiesOutput with direct table layout and style state, including style options, borders, default cell margins, and cell spacing when explicitly set.

Input fields

Variant 1 (target.nodeType=“table”)

Field	Type	Required	Description
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
nodeId	string	yes

Example request

{
  "target": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "table"
  }
}

Output fields

Field	Type	Required	Description
address	TableAddress	yes	TableAddress
address.kind	"block"	yes	Constant: "block"
address.nodeId	string	yes
address.nodeType	"table"	yes	Constant: "table"
alignment	enum	no	"left", "center", "right"
autoFitMode	enum	no	"fixedWidth", "fitContents", "fitWindow"
borders	object	no
borders.bottom	object | null	no	One of: object, null
borders.insideH	object | null	no	One of: object, null
borders.insideV	object | null	no	One of: object, null
borders.left	object | null	no	One of: object, null
borders.right	object | null	no	One of: object, null
borders.top	object | null	no	One of: object, null
cellSpacingPt	number	no
defaultCellMargins	object	no
defaultCellMargins.bottomPt	number	no
defaultCellMargins.leftPt	number	no
defaultCellMargins.rightPt	number	no
defaultCellMargins.topPt	number	no
direction	enum	no	"ltr", "rtl"
nodeId	string	yes
preferredWidth	number	no
styleId	string	no
styleOptions	object	no
styleOptions.bandedColumns	boolean	no
styleOptions.bandedRows	boolean	no
styleOptions.firstColumn	boolean	no
styleOptions.headerRow	boolean	no
styleOptions.lastColumn	boolean	no
styleOptions.lastRow	boolean	no

Example response

{
  "address": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "table"
  },
  "alignment": "left",
  "nodeId": "node-def456",
  "styleId": "style-001"
}

Pre-apply throws

• TARGET_NOT_FOUND

Non-applied failure codes

• None

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "oneOf": [
    {
      "required": [
        "target"
      ]
    },
    {
      "required": [
        "nodeId"
      ]
    }
  ],
  "properties": {
    "nodeId": {
      "type": "string"
    },
    "target": {
      "$ref": "#/$defs/TableAddress"
    }
  },
  "type": "object"
}

Raw output schema

{
  "additionalProperties": false,
  "properties": {
    "address": {
      "$ref": "#/$defs/TableAddress"
    },
    "alignment": {
      "enum": [
        "left",
        "center",
        "right"
      ]
    },
    "autoFitMode": {
      "enum": [
        "fixedWidth",
        "fitContents",
        "fitWindow"
      ]
    },
    "borders": {
      "additionalProperties": false,
      "properties": {
        "bottom": {
          "oneOf": [
            {
              "additionalProperties": false,
              "properties": {
                "color": {
                  "pattern": "^(#?([0-9A-Fa-f]{6}|[0-9A-Fa-f]{3})|auto)$",
                  "type": "string"
                },
                "lineStyle": {
                  "type": "string"
                },
                "lineWeightPt": {
                  "exclusiveMinimum": 0,
                  "type": "number"
                }
              },
              "required": [
                "lineStyle",
                "lineWeightPt",
                "color"
              ],
              "type": "object"
            },
            {
              "type": "null"
            }
          ]
        },
        "insideH": {
          "oneOf": [
            {
              "additionalProperties": false,
              "properties": {
                "color": {
                  "pattern": "^(#?([0-9A-Fa-f]{6}|[0-9A-Fa-f]{3})|auto)$",
                  "type": "string"
                },
                "lineStyle": {
                  "type": "string"
                },
                "lineWeightPt": {
                  "exclusiveMinimum": 0,
                  "type": "number"
                }
              },
              "required": [
                "lineStyle",
                "lineWeightPt",
                "color"
              ],
              "type": "object"
            },
            {
              "type": "null"
            }
          ]
        },
        "insideV": {
          "oneOf": [
            {
              "additionalProperties": false,
              "properties": {
                "color": {
                  "pattern": "^(#?([0-9A-Fa-f]{6}|[0-9A-Fa-f]{3})|auto)$",
                  "type": "string"
                },
                "lineStyle": {
                  "type": "string"
                },
                "lineWeightPt": {
                  "exclusiveMinimum": 0,
                  "type": "number"
                }
              },
              "required": [
                "lineStyle",
                "lineWeightPt",
                "color"
              ],
              "type": "object"
            },
            {
              "type": "null"
            }
          ]
        },
        "left": {
          "oneOf": [
            {
              "additionalProperties": false,
              "properties": {
                "color": {
                  "pattern": "^(#?([0-9A-Fa-f]{6}|[0-9A-Fa-f]{3})|auto)$",
                  "type": "string"
                },
                "lineStyle": {
                  "type": "string"
                },
                "lineWeightPt": {
                  "exclusiveMinimum": 0,
                  "type": "number"
                }
              },
              "required": [
                "lineStyle",
                "lineWeightPt",
                "color"
              ],
              "type": "object"
            },
            {
              "type": "null"
            }
          ]
        },
        "right": {
          "oneOf": [
            {
              "additionalProperties": false,
              "properties": {
                "color": {
                  "pattern": "^(#?([0-9A-Fa-f]{6}|[0-9A-Fa-f]{3})|auto)$",
                  "type": "string"
                },
                "lineStyle": {
                  "type": "string"
                },
                "lineWeightPt": {
                  "exclusiveMinimum": 0,
                  "type": "number"
                }
              },
              "required": [
                "lineStyle",
                "lineWeightPt",
                "color"
              ],
              "type": "object"
            },
            {
              "type": "null"
            }
          ]
        },
        "top": {
          "oneOf": [
            {
              "additionalProperties": false,
              "properties": {
                "color": {
                  "pattern": "^(#?([0-9A-Fa-f]{6}|[0-9A-Fa-f]{3})|auto)$",
                  "type": "string"
                },
                "lineStyle": {
                  "type": "string"
                },
                "lineWeightPt": {
                  "exclusiveMinimum": 0,
                  "type": "number"
                }
              },
              "required": [
                "lineStyle",
                "lineWeightPt",
                "color"
              ],
              "type": "object"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "type": "object"
    },
    "cellSpacingPt": {
      "type": "number"
    },
    "defaultCellMargins": {
      "additionalProperties": false,
      "properties": {
        "bottomPt": {
          "type": "number"
        },
        "leftPt": {
          "type": "number"
        },
        "rightPt": {
          "type": "number"
        },
        "topPt": {
          "type": "number"
        }
      },
      "type": "object"
    },
    "direction": {
      "enum": [
        "ltr",
        "rtl"
      ]
    },
    "nodeId": {
      "type": "string"
    },
    "preferredWidth": {
      "type": "number"
    },
    "styleId": {
      "type": "string"
    },
    "styleOptions": {
      "additionalProperties": false,
      "properties": {
        "bandedColumns": {
          "type": "boolean"
        },
        "bandedRows": {
          "type": "boolean"
        },
        "firstColumn": {
          "type": "boolean"
        },
        "headerRow": {
          "type": "boolean"
        },
        "lastColumn": {
          "type": "boolean"
        },
        "lastRow": {
          "type": "boolean"
        }
      },
      "type": "object"
    }
  },
  "required": [
    "nodeId",
    "address"
  ],
  "type": "object"
}