Document apiReferenceTables

tables.getProperties

Retrieve layout, style, and authored row and grid column dimensions of a table.

read-onlyidempotent
doc.tables.getProperties(…)

Expected result

Returns a TablesGetPropertiesOutput with direct table layout and style state and optional indexed rows and columns. Row heightPt and grid widthPt are authored points, not rendered sizes. Unspecified dimensions and unstored heightRule are omitted; explicit zero and auto are retained. Existing style options, borders, default cell margins, and cell spacing are included when explicitly set.

Inputs

targetTableAddressconditionally required
Fields
kind"block"required
nodeType"table"required
nodeIdstringrequired
nodeIdstringconditionally required

Result

Output fields
nodeIdstringrequired
addressTableAddressrequired
Fields
kind"block"required
nodeType"table"required
nodeIdstringrequired
rowsobject[]

Rows in logical table order, with zero-based indices and optional authored dimensions. These are source values, not rendered heights.

columnsobject[]

Authored grid columns in logical order, with zero-based indices. No widths are inferred from cells or layout.

styleIdstring
alignment"left" | "center" | "right"
direction"ltr" | "rtl"
preferredWidthnumber
preferredWidthType"dxa" | "auto" | "pct"
autoFitMode"fixedWidth" | "fitContents" | "fitWindow"
styleOptionsobject
Fields
headerRowboolean
lastRowboolean
firstColumnboolean
lastColumnboolean
bandedRowsboolean
bandedColumnsboolean
bordersobject
Fields
topobject | null
lineStyle
lineStylestringrequired
lineWeightPtnumberrequired
colorstringrequired
Variant 2

No fields.

bottomobject | null
lineStyle
lineStylestringrequired
lineWeightPtnumberrequired
colorstringrequired
Variant 2

No fields.

leftobject | null
lineStyle
lineStylestringrequired
lineWeightPtnumberrequired
colorstringrequired
Variant 2

No fields.

rightobject | null
lineStyle
lineStylestringrequired
lineWeightPtnumberrequired
colorstringrequired
Variant 2

No fields.

insideHobject | null
lineStyle
lineStylestringrequired
lineWeightPtnumberrequired
colorstringrequired
Variant 2

No fields.

insideVobject | null
lineStyle
lineStylestringrequired
lineWeightPtnumberrequired
colorstringrequired
Variant 2

No fields.

defaultCellMarginsobject
Fields
topPtnumber
rightPtnumber
bottomPtnumber
leftPtnumber
cellSpacingPtnumber

Failures

Pre-apply throws

  • TARGET_NOT_FOUND

Raw schemas

Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.

View raw JSON schemas