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

​
Summary

  • 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

​
Input fields

FieldTypeRequiredDescription
nodeIdstringno
targetBlockNodeAddressnoBlockNodeAddress

​
Example request

{}

​
Output fields

FieldTypeRequiredDescription
alignmentenumno"left", "center", "right"
autoFitModeenumno"fixedWidth", "fitContents", "fitWindow"
directionenumno"ltr", "rtl"
nodeIdstringyes
preferredWidthnumberno
styleIdstringno
styleOptionsobjectno

​
Example response

{
  "alignment": "left",
  "nodeId": "node-def456",
  "styleId": "style-001"
}

​
Pre-apply throws

  • TARGET_NOT_FOUND

​
Non-applied failure codes

  • None

​
Raw schemas

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

{
  "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"
}