tables.getProperties
Retrieve layout, style, and authored row and grid column dimensions of a table.
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 requiredFields
kind"block"requirednodeType"table"requirednodeIdstringrequirednodeIdstringconditionally requiredResult
Output fields
nodeIdstringrequiredaddressTableAddressrequiredFields
kind"block"requirednodeType"table"requirednodeIdstringrequiredrowsobject[]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.
styleIdstringalignment"left" | "center" | "right"direction"ltr" | "rtl"preferredWidthnumberpreferredWidthType"dxa" | "auto" | "pct"autoFitMode"fixedWidth" | "fitContents" | "fitWindow"styleOptionsobjectFields
headerRowbooleanlastRowbooleanfirstColumnbooleanlastColumnbooleanbandedRowsbooleanbandedColumnsbooleanbordersobjectFields
topobject | nulllineStyle
lineStylestringrequiredlineWeightPtnumberrequiredcolorstringrequiredVariant 2
No fields.
bottomobject | nulllineStyle
lineStylestringrequiredlineWeightPtnumberrequiredcolorstringrequiredVariant 2
No fields.
leftobject | nulllineStyle
lineStylestringrequiredlineWeightPtnumberrequiredcolorstringrequiredVariant 2
No fields.
rightobject | nulllineStyle
lineStylestringrequiredlineWeightPtnumberrequiredcolorstringrequiredVariant 2
No fields.
insideHobject | nulllineStyle
lineStylestringrequiredlineWeightPtnumberrequiredcolorstringrequiredVariant 2
No fields.
insideVobject | nulllineStyle
lineStylestringrequiredlineWeightPtnumberrequiredcolorstringrequiredVariant 2
No fields.
defaultCellMarginsobjectFields
topPtnumberrightPtnumberbottomPtnumberleftPtnumbercellSpacingPtnumberFailures
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