Document apiReferenceTables

tables.mergeCells

Merge a range of table cells into one.

mutates documentdry runconditional
doc.tables.mergeCells(…)

Expected result

Returns a TableMutationResult receipt; reports NO_OP if the cells are already merged.

Inputs

targetTableAddressconditionally required
Fields
kind"block"required
nodeType"table"required
nodeIdstringrequired
nodeIdstringconditionally required
startobjectrequired
Fields
rowIndexintegerrequired
columnIndexintegerrequired
endobjectrequired
Fields
rowIndexintegerrequired
columnIndexintegerrequired

Result

Output fields
true
successtruerequired
tableTableAddress
Fields
kind"block"required
nodeType"table"required
nodeIdstringrequired
trackedChangeRefsEntityAddress[]
false
successfalserequired
failureobjectrequired
Fields
code"NO_OP" | "INVALID_TARGET" | "TARGET_NOT_FOUND" | "CAPABILITY_UNAVAILABLE"required
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • CAPABILITY_UNAVAILABLE
1 more codes
  • INVALID_CONTEXT

Non-applied receipt codes

  • INVALID_TARGET
  • NO_OP
  • INVALID_CONTEXT

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