tables.getProperties

Retrieve layout and style properties of a table.

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

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 the table layout, style, border, and shading properties.

Input fields

Variant 1

No fields.

Variant 2

No fields.

Example request

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

Output fields

Field	Type	Required	Description
alignment	enum	no	"left", "center", "right"
autoFitMode	enum	no	"fixedWidth", "fitContents", "fitWindow"
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.totalRow	boolean	no

Example response

{
  "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/BlockNodeAddress"
    }
  },
  "type": "object"
}

Raw output schema

{
  "additionalProperties": false,
  "properties": {
    "alignment": {
      "enum": [
        "left",
        "center",
        "right"
      ]
    },
    "autoFitMode": {
      "enum": [
        "fixedWidth",
        "fitContents",
        "fitWindow"
      ]
    },
    "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"
        },
        "totalRow": {
          "type": "boolean"
        }
      },
      "type": "object"
    }
  },
  "required": [
    "nodeId"
  ],
  "type": "object"
}