Operations tree

Browse all Document API operations in a collapsible tree with input fields

Click a category to expand it, then click an operation to see its input fields.

Anchored Metadata (6)

metadata.attach

editor.doc.metadata.attach(...)

Field	Type	Req	Description
id	string
namespace	string	✓
payload	any	✓
target	SelectionTarget	✓	SelectionTarget
target.end	SelectionPoint	✓	SelectionPoint
target.kind	"selection"	✓	Constant: "selection"
target.start	SelectionPoint	✓	SelectionPoint

Full reference →

metadata.list

editor.doc.metadata.list(...)

Field	Type	Req	Description
limit	integer
namespace	string
offset	integer
within	SelectionTarget		SelectionTarget
within.end	SelectionPoint		SelectionPoint
within.kind	"selection"		Constant: "selection"
within.start	SelectionPoint		SelectionPoint

Full reference →

metadata.get

editor.doc.metadata.get(...)

Field	Type	Req	Description
id	string	✓

Full reference →

metadata.update

editor.doc.metadata.update(...)

Field	Type	Req	Description
id	string	✓
payload	any	✓

Full reference →

metadata.remove

editor.doc.metadata.remove(...)

Field	Type	Req	Description
id	string	✓

Full reference →

metadata.resolve

editor.doc.metadata.resolve(...)

Field	Type	Req	Description
id	string	✓

Full reference →

Blocks (3)

blocks.list

editor.doc.blocks.list(...)

Field	Type	Req	Description
includeText	boolean
limit	number
nodeTypes	”paragraph” | “heading” | “listItem” | …[]
offset	number

Full reference →

blocks.delete

editor.doc.blocks.delete(...)

Field	Type	Req	Description
target	DeletableBlockNodeAddress	✓	DeletableBlockNodeAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	”paragraph” | “heading” | “listItem” | …	✓	"paragraph", "heading", "listItem", "table", "sdt"

Full reference →

blocks.deleteRange

editor.doc.blocks.deleteRange(...)

Field	Type	Req	Description
end	BlockNodeAddress	✓	BlockNodeAddress
end.kind	"block"	✓	Constant: "block"
end.nodeId	string	✓
end.nodeType	”paragraph” | “heading” | “listItem” | …	✓	"paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt"
start	BlockNodeAddress	✓	BlockNodeAddress
start.kind	"block"	✓	Constant: "block"
start.nodeId	string	✓
start.nodeType	”paragraph” | “heading” | “listItem” | …	✓	"paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt"

Full reference →

Bookmarks (5)

bookmarks.list

editor.doc.bookmarks.list(...)

Field	Type	Req	Description
in	StoryLocator		StoryLocator
limit	integer
offset	integer

Full reference →

bookmarks.get

editor.doc.bookmarks.get(...)

Field	Type	Req	Description
target	{ kind: "entity", entityType: "bookmark" }	✓
target.entityType	"bookmark"	✓	Constant: "bookmark"
target.kind	"entity"	✓	Constant: "entity"
target.name	string	✓
target.story	StoryLocator		StoryLocator

Full reference →

bookmarks.insert

editor.doc.bookmarks.insert(...)

Field	Type	Req	Description
at	TextTarget	✓	TextTarget
at.kind	"text"	✓	Constant: "text"
at.segments	TextSegment[]	✓
at.story	StoryLocator		StoryLocator
name	string	✓
tableColumn	object
tableColumn.colFirst	integer
tableColumn.colLast	integer

Full reference →

bookmarks.rename

editor.doc.bookmarks.rename(...)

Field	Type	Req	Description
newName	string	✓
target	{ kind: "entity", entityType: "bookmark" }	✓
target.entityType	"bookmark"	✓	Constant: "bookmark"
target.kind	"entity"	✓	Constant: "entity"
target.name	string	✓
target.story	StoryLocator		StoryLocator

Full reference →

bookmarks.remove

editor.doc.bookmarks.remove(...)

Field	Type	Req	Description
target	{ kind: "entity", entityType: "bookmark" }	✓
target.entityType	"bookmark"	✓	Constant: "bookmark"
target.kind	"entity"	✓	Constant: "entity"
target.name	string	✓
target.story	StoryLocator		StoryLocator

Full reference →

Capabilities (1)

capabilities.get

editor.doc.capabilities(...)

No input fields.

Full reference →

Captions (6)

captions.list

editor.doc.captions.list(...)

Field	Type	Req	Description
label	string
limit	integer
offset	integer

Full reference →

captions.get

editor.doc.captions.get(...)

Field	Type	Req	Description
target	{ kind: "block", nodeType: "paragraph" }	✓
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"paragraph"	✓	Constant: "paragraph"

Full reference →

captions.insert

editor.doc.captions.insert(...)

Field	Type	Req	Description
adjacentTo	BlockNodeAddress	✓	BlockNodeAddress
adjacentTo.kind	"block"	✓	Constant: "block"
adjacentTo.nodeId	string	✓
adjacentTo.nodeType	”paragraph” | “heading” | “listItem” | …	✓	"paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt"
label	string	✓
position	”above” | “below”	✓	"above", "below"
text	string

Full reference →

captions.update

editor.doc.captions.update(...)

Field	Type	Req	Description
patch	object	✓
patch.text	string
target	{ kind: "block", nodeType: "paragraph" }	✓
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"paragraph"	✓	Constant: "paragraph"

Full reference →

captions.remove

editor.doc.captions.remove(...)

Field	Type	Req	Description
target	{ kind: "block", nodeType: "paragraph" }	✓
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"paragraph"	✓	Constant: "paragraph"

Full reference →

captions.configure

editor.doc.captions.configure(...)

Field	Type	Req	Description
chapterStyle	string
format	”decimal” | “lowerRoman” | “upperRoman” | …		"decimal", "lowerRoman", "upperRoman", "lowerLetter", "upperLetter"
includeChapter	boolean
label	string	✓

Full reference →

Citations (15)

citations.list

editor.doc.citations.list(...)

Field	Type	Req	Description
limit	integer
offset	integer

Full reference →

citations.get

editor.doc.citations.get(...)

Field	Type	Req	Description
target	{ kind: "inline", nodeType: "citation" }	✓
target.anchor	InlineAnchor	✓	InlineAnchor
target.anchor.end	Position	✓	Position
target.anchor.end.blockId	string	✓
target.anchor.end.offset	integer	✓
target.anchor.start	Position	✓	Position
target.anchor.start.blockId	string	✓
target.anchor.start.offset	integer	✓
target.kind	"inline"	✓	Constant: "inline"
target.nodeType	"citation"	✓	Constant: "citation"

Full reference →

citations.insert

editor.doc.citations.insert(...)

Field	Type	Req	Description
at	TextTarget	✓	TextTarget
at.kind	"text"	✓	Constant: "text"
at.segments	TextSegment[]	✓
at.story	StoryLocator		StoryLocator
sourceIds	string[]	✓

Full reference →

citations.update

editor.doc.citations.update(...)

Field	Type	Req	Description
patch	object	✓
patch.sourceIds	string[]
target	{ kind: "inline", nodeType: "citation" }	✓
target.anchor	InlineAnchor	✓	InlineAnchor
target.anchor.end	Position	✓	Position
target.anchor.end.blockId	string	✓
target.anchor.end.offset	integer	✓
target.anchor.start	Position	✓	Position
target.anchor.start.blockId	string	✓
target.anchor.start.offset	integer	✓
target.kind	"inline"	✓	Constant: "inline"
target.nodeType	"citation"	✓	Constant: "citation"

Full reference →

citations.remove

editor.doc.citations.remove(...)

Field	Type	Req	Description
target	{ kind: "inline", nodeType: "citation" }	✓
target.anchor	InlineAnchor	✓	InlineAnchor
target.anchor.end	Position	✓	Position
target.anchor.end.blockId	string	✓
target.anchor.end.offset	integer	✓
target.anchor.start	Position	✓	Position
target.anchor.start.blockId	string	✓
target.anchor.start.offset	integer	✓
target.kind	"inline"	✓	Constant: "inline"
target.nodeType	"citation"	✓	Constant: "citation"

Full reference →

citations.sources.list

editor.doc.citations.sources.list(...)

Field	Type	Req	Description
limit	integer
offset	integer
type	string

Full reference →

citations.sources.get

editor.doc.citations.sources.get(...)

Field	Type	Req	Description
target	{ kind: "entity", entityType: "citationSource" }	✓
target.entityType	"citationSource"	✓	Constant: "citationSource"
target.kind	"entity"	✓	Constant: "entity"
target.sourceId	string	✓

Full reference →

citations.sources.insert

editor.doc.citations.sources.insert(...)

Field	Type	Req	Description
fields	object	✓
fields.authors	object[]
fields.city	string
fields.doi	string
fields.edition	string
fields.editor	object[]
fields.issue	string
fields.journalName	string
fields.medium	string
fields.pages	string
fields.publisher	string
fields.shortTitle	string
fields.standardNumber	string
fields.title	string
fields.translator	object[]
fields.url	string
fields.volume	string
fields.year	string
type	”book” | “journalArticle” | “conferenceProceedings” | …	✓	"book", "journalArticle", "conferenceProceedings", "report", "website", "patent", "case", "statute", "thesis", "film", "interview", "misc"

Full reference →

citations.sources.update

editor.doc.citations.sources.update(...)

Field	Type	Req	Description
patch	object	✓
patch.authors	object[]
patch.city	string
patch.doi	string
patch.edition	string
patch.editor	object[]
patch.issue	string
patch.journalName	string
patch.medium	string
patch.pages	string
patch.publisher	string
patch.shortTitle	string
patch.standardNumber	string
patch.title	string
patch.translator	object[]
patch.url	string
patch.volume	string
patch.year	string
target	{ kind: "entity", entityType: "citationSource" }	✓
target.entityType	"citationSource"	✓	Constant: "citationSource"
target.kind	"entity"	✓	Constant: "entity"
target.sourceId	string	✓

Full reference →

citations.sources.remove

editor.doc.citations.sources.remove(...)

Field	Type	Req	Description
target	{ kind: "entity", entityType: "citationSource" }	✓
target.entityType	"citationSource"	✓	Constant: "citationSource"
target.kind	"entity"	✓	Constant: "entity"
target.sourceId	string	✓

Full reference →

citations.bibliography.get

editor.doc.citations.bibliography.get(...)

Field	Type	Req	Description
target	{ kind: "block", nodeType: "bibliography" }	✓
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"bibliography"	✓	Constant: "bibliography"

Full reference →

citations.bibliography.insert

editor.doc.citations.bibliography.insert(...)

Field	Type	Req	Description
at	{ kind: "documentStart" } | { kind: "documentEnd" } | { kind: "before" } | { kind: "after" }	✓	One of: object(kind=“documentStart”), object(kind=“documentEnd”), object(kind=“before”), object(kind=“after”)
style	string

Full reference →

citations.bibliography.rebuild

editor.doc.citations.bibliography.rebuild(...)

Field	Type	Req	Description
target	{ kind: "block", nodeType: "bibliography" }	✓
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"bibliography"	✓	Constant: "bibliography"

Full reference →

citations.bibliography.configure

editor.doc.citations.bibliography.configure(...)

Field	Type	Req	Description
style	string	✓
target	{ kind: "block", nodeType: "bibliography" }	✓
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"bibliography"	✓	Constant: "bibliography"

Full reference →

citations.bibliography.remove

editor.doc.citations.bibliography.remove(...)

Field	Type	Req	Description
target	{ kind: "block", nodeType: "bibliography" }	✓
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"bibliography"	✓	Constant: "bibliography"

Full reference →

Comments (5)

comments.create

editor.doc.comments.create(...)

Field	Type	Req	Description
parentCommentId	string
target	{ kind: "text" } | { kind: "selection" } | { kind: "trackedChange" }		One of: TextAddress, TextTarget, SelectionTarget, CommentTrackedChangeTarget
text	string	✓

Full reference →

comments.patch

editor.doc.comments.patch(...)

Field	Type	Req	Description
commentId	string	✓
isInternal	boolean
status	”resolved” | “active”		"resolved", "active"
target	{ kind: "text" } | { kind: "selection" } | { kind: "trackedChange" }		One of: TextAddress, TextTarget, SelectionTarget, CommentTrackedChangeTarget
text	string

Full reference →

comments.delete

editor.doc.comments.delete(...)

Field	Type	Req	Description
commentId	string	✓

Full reference →

comments.get

editor.doc.comments.get(...)

Field	Type	Req	Description
commentId	string	✓

Full reference →

comments.list

editor.doc.comments.list(...)

Field	Type	Req	Description
includeResolved	boolean
limit	integer
offset	integer

Full reference →

Content Controls (55)

create.contentControl

editor.doc.create.contentControl(...)

Field	Type	Req	Description
alias	string
at	SelectionTarget		SelectionTarget
at.end	SelectionPoint		SelectionPoint
at.kind	"selection"		Constant: "selection"
at.start	SelectionPoint		SelectionPoint
content	string
controlType	string
kind	”block” | “inline”	✓	"block", "inline"
lockMode	”unlocked” | “sdtLocked” | “contentLocked” | …		"unlocked", "sdtLocked", "contentLocked", "sdtContentLocked"
tag	string
target	{ nodeType: "sdt" }
target.kind	”block” | “inline”		"block", "inline"
target.nodeId	string
target.nodeType	"sdt"		Constant: "sdt"

Full reference →

contentControls.list

editor.doc.contentControls.list(...)

Field	Type	Req	Description
controlType	string
limit	integer
offset	integer
tag	string

Full reference →

contentControls.get

editor.doc.contentControls.get(...)

Field	Type	Req	Description
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.listInRange

editor.doc.contentControls.listInRange(...)

Field	Type	Req	Description
endBlockId	string	✓
limit	integer
offset	integer
startBlockId	string	✓

Full reference →

contentControls.selectByTag

editor.doc.contentControls.selectByTag(...)

Field	Type	Req	Description
limit	integer
offset	integer
tag	string	✓

Full reference →

contentControls.selectByTitle

editor.doc.contentControls.selectByTitle(...)

Field	Type	Req	Description
limit	integer
offset	integer
title	string	✓

Full reference →

contentControls.listChildren

editor.doc.contentControls.listChildren(...)

Field	Type	Req	Description
limit	integer
offset	integer
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.getParent

editor.doc.contentControls.getParent(...)

Field	Type	Req	Description
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.wrap

editor.doc.contentControls.wrap(...)

Field	Type	Req	Description
alias	string
kind	”block” | “inline”	✓	"block", "inline"
lockMode	”unlocked” | “sdtLocked” | “contentLocked” | …		"unlocked", "sdtLocked", "contentLocked", "sdtContentLocked"
tag	string
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.unwrap

editor.doc.contentControls.unwrap(...)

Field	Type	Req	Description
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.delete

editor.doc.contentControls.delete(...)

Field	Type	Req	Description
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.copy

editor.doc.contentControls.copy(...)

Field	Type	Req	Description
destination	{ nodeType: "sdt" }	✓
destination.kind	”block” | “inline”	✓	"block", "inline"
destination.nodeId	string	✓
destination.nodeType	"sdt"	✓	Constant: "sdt"
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.move

editor.doc.contentControls.move(...)

Field	Type	Req	Description
destination	{ nodeType: "sdt" }	✓
destination.kind	”block” | “inline”	✓	"block", "inline"
destination.nodeId	string	✓
destination.nodeType	"sdt"	✓	Constant: "sdt"
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.patch

editor.doc.contentControls.patch(...)

Field	Type	Req	Description
alias	any
appearance	”boundingBox” | “tags” | “hidden”		"boundingBox", "tags", "hidden"
color	string
placeholder	string
showingPlaceholder	boolean
tabIndex	integer
tag	any
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"
temporary	boolean

Full reference →

contentControls.setLockMode

editor.doc.contentControls.setLockMode(...)

Field	Type	Req	Description
lockMode	”unlocked” | “sdtLocked” | “contentLocked” | …	✓	"unlocked", "sdtLocked", "contentLocked", "sdtContentLocked"
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.setType

editor.doc.contentControls.setType(...)

Field	Type	Req	Description
controlType	string	✓
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.getContent

editor.doc.contentControls.getContent(...)

Field	Type	Req	Description
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.replaceContent

editor.doc.contentControls.replaceContent(...)

Field	Type	Req	Description
content	string	✓
format	”text” | “html”		"text", "html"
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.clearContent

editor.doc.contentControls.clearContent(...)

Field	Type	Req	Description
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.appendContent

editor.doc.contentControls.appendContent(...)

Field	Type	Req	Description
content	string	✓
format	”text” | “html”		"text", "html"
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.prependContent

editor.doc.contentControls.prependContent(...)

Field	Type	Req	Description
content	string	✓
format	”text” | “html”		"text", "html"
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.insertBefore

editor.doc.contentControls.insertBefore(...)

Field	Type	Req	Description
content	string	✓
format	”text” | “html”		"text", "html"
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.insertAfter

editor.doc.contentControls.insertAfter(...)

Field	Type	Req	Description
content	string	✓
format	”text” | “html”		"text", "html"
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.getBinding

editor.doc.contentControls.getBinding(...)

Field	Type	Req	Description
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.setBinding

editor.doc.contentControls.setBinding(...)

Field	Type	Req	Description
prefixMappings	string
storeItemId	string	✓
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"
xpath	string	✓

Full reference →

contentControls.clearBinding

editor.doc.contentControls.clearBinding(...)

Field	Type	Req	Description
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.getRawProperties

editor.doc.contentControls.getRawProperties(...)

Field	Type	Req	Description
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.patchRawProperties

editor.doc.contentControls.patchRawProperties(...)

Field	Type	Req	Description
patches	object[]	✓
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.validateWordCompatibility

editor.doc.contentControls.validateWordCompatibility(...)

Field	Type	Req	Description
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.normalizeWordCompatibility

editor.doc.contentControls.normalizeWordCompatibility(...)

Field	Type	Req	Description
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.normalizeTagPayload

editor.doc.contentControls.normalizeTagPayload(...)

Field	Type	Req	Description
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.text.setMultiline

editor.doc.contentControls.text.setMultiline(...)

Field	Type	Req	Description
multiline	boolean	✓
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.text.setValue

editor.doc.contentControls.text.setValue(...)

Field	Type	Req	Description
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"
value	string	✓

Full reference →

contentControls.text.clearValue

editor.doc.contentControls.text.clearValue(...)

Field	Type	Req	Description
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.date.setValue

editor.doc.contentControls.date.setValue(...)

Field	Type	Req	Description
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"
value	string	✓

Full reference →

contentControls.date.clearValue

editor.doc.contentControls.date.clearValue(...)

Field	Type	Req	Description
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.date.setDisplayFormat

editor.doc.contentControls.date.setDisplayFormat(...)

Field	Type	Req	Description
format	string	✓
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.date.setDisplayLocale

editor.doc.contentControls.date.setDisplayLocale(...)

Field	Type	Req	Description
locale	string	✓
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.date.setStorageFormat

editor.doc.contentControls.date.setStorageFormat(...)

Field	Type	Req	Description
format	string	✓
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.date.setCalendar

editor.doc.contentControls.date.setCalendar(...)

Field	Type	Req	Description
calendar	string	✓
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.checkbox.getState

editor.doc.contentControls.checkbox.getState(...)

Field	Type	Req	Description
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.checkbox.setState

editor.doc.contentControls.checkbox.setState(...)

Field	Type	Req	Description
checked	boolean	✓
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.checkbox.toggle

editor.doc.contentControls.checkbox.toggle(...)

Field	Type	Req	Description
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.checkbox.setSymbolPair

editor.doc.contentControls.checkbox.setSymbolPair(...)

Field	Type	Req	Description
checkedSymbol	object	✓
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"
uncheckedSymbol	object	✓

Full reference →

contentControls.choiceList.getItems

editor.doc.contentControls.choiceList.getItems(...)

Field	Type	Req	Description
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.choiceList.setItems

editor.doc.contentControls.choiceList.setItems(...)

Field	Type	Req	Description
items	object[]	✓
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.choiceList.setSelected

editor.doc.contentControls.choiceList.setSelected(...)

Field	Type	Req	Description
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"
value	string	✓

Full reference →

contentControls.repeatingSection.listItems

editor.doc.contentControls.repeatingSection.listItems(...)

Field	Type	Req	Description
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.repeatingSection.insertItemBefore

editor.doc.contentControls.repeatingSection.insertItemBefore(...)

Field	Type	Req	Description
index	integer	✓
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.repeatingSection.insertItemAfter

editor.doc.contentControls.repeatingSection.insertItemAfter(...)

Field	Type	Req	Description
index	integer	✓
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.repeatingSection.cloneItem

editor.doc.contentControls.repeatingSection.cloneItem(...)

Field	Type	Req	Description
index	integer	✓
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.repeatingSection.deleteItem

editor.doc.contentControls.repeatingSection.deleteItem(...)

Field	Type	Req	Description
index	integer	✓
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.repeatingSection.setAllowInsertDelete

editor.doc.contentControls.repeatingSection.setAllowInsertDelete(...)

Field	Type	Req	Description
allow	boolean	✓
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.group.wrap

editor.doc.contentControls.group.wrap(...)

Field	Type	Req	Description
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

contentControls.group.ungroup

editor.doc.contentControls.group.ungroup(...)

Field	Type	Req	Description
target	{ nodeType: "sdt" }	✓
target.kind	”block” | “inline”	✓	"block", "inline"
target.nodeId	string	✓
target.nodeType	"sdt"	✓	Constant: "sdt"

Full reference →

Core (14)

get

editor.doc.get(...)

Field	Type	Req	Description
options	object
options.includeContext	boolean
options.includeProvenance	boolean
options.includeResolved	boolean

Full reference →

find

editor.doc.find(...)

Field	Type	Req	Description
in	StoryLocator		StoryLocator
limit	integer
offset	integer
options	object
options.includeContext	boolean
options.includeProvenance	boolean
options.includeResolved	boolean
select	{ type: "text" } | { type: "node" }	✓	One of: object(type=“text”), object(type=“node”)
within	BlockNodeAddress		BlockNodeAddress
within.kind	"block"		Constant: "block"
within.nodeId	string
within.nodeType	”paragraph” | “heading” | “listItem” | …		"paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt"

Full reference →

getNode

editor.doc.getNode(...)

No input fields.

Full reference →

getNodeById

editor.doc.getNodeById(...)

Field	Type	Req	Description
nodeId	string	✓
nodeType	”paragraph” | “heading” | “listItem” | …		"paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt"

Full reference →

getText

editor.doc.getText(...)

Field	Type	Req	Description
in	StoryLocator		StoryLocator

Full reference →

getMarkdown

editor.doc.getMarkdown(...)

Field	Type	Req	Description
in	StoryLocator		StoryLocator

Full reference →

getHtml

editor.doc.getHtml(...)

Field	Type	Req	Description
in	StoryLocator		StoryLocator
unflattenLists	boolean

Full reference →

markdownToFragment

editor.doc.markdownToFragment(...)

Field	Type	Req	Description
markdown	string	✓

Full reference →

info

editor.doc.info(...)

No input fields.

Full reference →

extract

editor.doc.extract(...)

No input fields.

Full reference →

clearContent

editor.doc.clearContent(...)

No input fields.

Full reference →

insert

editor.doc.insert(...)

No input fields.

Full reference →

replace

editor.doc.replace(...)

No input fields.

Full reference →

delete

editor.doc.delete(...)

No input fields.

Full reference →

Create (6)

create.paragraph

editor.doc.create.paragraph(...)

Field	Type	Req	Description
at	{ kind: "documentStart" } | { kind: "documentEnd" } | { kind: "before" } | { kind: "after" }		One of: object(kind=“documentStart”), object(kind=“documentEnd”), object(kind=“before”), object(kind=“after”)
in	StoryLocator		StoryLocator
text	string

Full reference →

create.heading

editor.doc.create.heading(...)

Field	Type	Req	Description
at	{ kind: "documentStart" } | { kind: "documentEnd" } | { kind: "before" } | { kind: "after" }		One of: object(kind=“documentStart”), object(kind=“documentEnd”), object(kind=“before”), object(kind=“after”)
in	StoryLocator		StoryLocator
level	integer	✓
text	string

Full reference →

create.sectionBreak

editor.doc.create.sectionBreak(...)

Field	Type	Req	Description
at	{ kind: "documentStart" } | { kind: "documentEnd" } | { kind: "before" } | { kind: "after" }		One of: object(kind=“documentStart”), object(kind=“documentEnd”), object(kind=“before”), object(kind=“after”)
breakType	”continuous” | “nextPage” | “evenPage” | …		"continuous", "nextPage", "evenPage", "oddPage"
headerFooterMargins	object
headerFooterMargins.footer	number
headerFooterMargins.header	number
pageMargins	object
pageMargins.bottom	number
pageMargins.gutter	number
pageMargins.left	number
pageMargins.right	number
pageMargins.top	number

Full reference →

create.table

editor.doc.create.table(...)

Field	Type	Req	Description
at	{ kind: "documentStart" } | { kind: "documentEnd" } | { kind: "before" } | { kind: "after" }		One of: object(kind=“documentStart”), object(kind=“documentEnd”), object(kind=“before”), object(kind=“after”), object(kind=“before”), object(kind=“after”)
columns	integer	✓
rows	integer	✓

Full reference →

create.tableOfContents

editor.doc.create.tableOfContents(...)

Field	Type	Req	Description
at	{ kind: "documentStart" } | { kind: "documentEnd" } | { kind: "before" } | { kind: "after" }		One of: object(kind=“documentStart”), object(kind=“documentEnd”), object(kind=“before”), object(kind=“after”)
config	object
config.hideInWebView	boolean
config.hyperlinks	boolean
config.includePageNumbers	boolean
config.omitPageNumberLevels	object
config.omitPageNumberLevels.from	integer
config.omitPageNumberLevels.to	integer
config.outlineLevels	object
config.outlineLevels.from	integer
config.outlineLevels.to	integer
config.rightAlignPageNumbers	boolean
config.separator	string
config.tabLeader	”none” | “dot” | “hyphen” | …		"none", "dot", "hyphen", "underscore", "middleDot"
config.tcFieldIdentifier	string
config.tcFieldLevels	object
config.tcFieldLevels.from	integer
config.tcFieldLevels.to	integer
config.useAppliedOutlineLevel	boolean

Full reference →

create.image

editor.doc.create.image(...)

Field	Type	Req	Description
alt	string
at	{ kind: "documentStart" } | { kind: "documentEnd" } | { kind: "before" } | …		One of: object(kind=“documentStart”), object(kind=“documentEnd”), object(kind=“before”), object(kind=“after”), object(kind=“inParagraph”)
in	StoryLocator		StoryLocator
size	object
size.height	number
size.width	number
src	string	✓
title	string

Full reference →

Cross-References (5)

crossRefs.list

editor.doc.crossRefs.list(...)

Field	Type	Req	Description
limit	integer
offset	integer

Full reference →

crossRefs.get

editor.doc.crossRefs.get(...)

Field	Type	Req	Description
target	{ kind: "inline", nodeType: "crossRef" }	✓
target.anchor	InlineAnchor	✓	InlineAnchor
target.anchor.end	Position	✓	Position
target.anchor.end.blockId	string	✓
target.anchor.end.offset	integer	✓
target.anchor.start	Position	✓	Position
target.anchor.start.blockId	string	✓
target.anchor.start.offset	integer	✓
target.kind	"inline"	✓	Constant: "inline"
target.nodeType	"crossRef"	✓	Constant: "crossRef"

Full reference →

crossRefs.insert

editor.doc.crossRefs.insert(...)

Field	Type	Req	Description
at	TextTarget	✓	TextTarget
at.kind	"text"	✓	Constant: "text"
at.segments	TextSegment[]	✓
at.story	StoryLocator		StoryLocator
display	”content” | “pageNumber” | “noteNumber” | …	✓	"content", "pageNumber", "noteNumber", "labelAndNumber", "aboveBelow", "numberOnly", "numberFullContext", "styledContent", "styledPageNumber"
target	{ kind: "bookmark" } | { kind: "heading" } | { kind: "note" } | …	✓	One of: object(kind=“bookmark”), object(kind=“heading”), object(kind=“note”), object(kind=“caption”), object(kind=“numberedItem”), object(kind=“styledParagraph”)

Full reference →

crossRefs.rebuild

editor.doc.crossRefs.rebuild(...)

Field	Type	Req	Description
target	{ kind: "inline", nodeType: "crossRef" }	✓
target.anchor	InlineAnchor	✓	InlineAnchor
target.anchor.end	Position	✓	Position
target.anchor.end.blockId	string	✓
target.anchor.end.offset	integer	✓
target.anchor.start	Position	✓	Position
target.anchor.start.blockId	string	✓
target.anchor.start.offset	integer	✓
target.kind	"inline"	✓	Constant: "inline"
target.nodeType	"crossRef"	✓	Constant: "crossRef"

Full reference →

crossRefs.remove

editor.doc.crossRefs.remove(...)

Field	Type	Req	Description
target	{ kind: "inline", nodeType: "crossRef" }	✓
target.anchor	InlineAnchor	✓	InlineAnchor
target.anchor.end	Position	✓	Position
target.anchor.end.blockId	string	✓
target.anchor.end.offset	integer	✓
target.anchor.start	Position	✓	Position
target.anchor.start.blockId	string	✓
target.anchor.start.offset	integer	✓
target.kind	"inline"	✓	Constant: "inline"
target.nodeType	"crossRef"	✓	Constant: "crossRef"

Full reference →

Custom XML (5)

customXml.parts.list

editor.doc.customXml.parts.list(...)

Field	Type	Req	Description
limit	integer
offset	integer
rootNamespace	string
schemaRef	string

Full reference →

customXml.parts.get

editor.doc.customXml.parts.get(...)

Field	Type	Req	Description
target	object	✓	One of: object, object

Full reference →

customXml.parts.create

editor.doc.customXml.parts.create(...)

Field	Type	Req	Description
content	string	✓
schemaRefs	string[]

Full reference →

customXml.parts.patch

editor.doc.customXml.parts.patch(...)

Field	Type	Req	Description
content	string
schemaRefs	string[]
target	object	✓	One of: object, object

Full reference →

customXml.parts.remove

editor.doc.customXml.parts.remove(...)

Field	Type	Req	Description
target	object	✓	One of: object, object

Full reference →

Diff (3)

diff.capture

editor.doc.diff.capture(...)

No input fields.

Full reference →

diff.compare

editor.doc.diff.compare(...)

Field	Type	Req	Description
targetSnapshot	object	✓
targetSnapshot.coverage	{ body: true }	✓
targetSnapshot.coverage.body	true	✓	Constant: true
targetSnapshot.coverage.comments	boolean	✓
targetSnapshot.coverage.headerFooters	boolean	✓
targetSnapshot.coverage.numbering	boolean	✓
targetSnapshot.coverage.styles	boolean	✓
targetSnapshot.engine	”super-editor”	✓	"super-editor"
targetSnapshot.fingerprint	string	✓
targetSnapshot.payload	object	✓
targetSnapshot.version	”sd-diff-snapshot/v1” | “sd-diff-snapshot/v2”	✓	"sd-diff-snapshot/v1", "sd-diff-snapshot/v2"

Full reference →

diff.apply

editor.doc.diff.apply(...)

Field	Type	Req	Description
diff	object	✓
diff.baseFingerprint	string	✓
diff.coverage	{ body: true }	✓
diff.coverage.body	true	✓	Constant: true
diff.coverage.comments	boolean	✓
diff.coverage.headerFooters	boolean	✓
diff.coverage.numbering	boolean	✓
diff.coverage.styles	boolean	✓
diff.engine	”super-editor”	✓	"super-editor"
diff.payload	object	✓
diff.summary	object	✓
diff.summary.body	object	✓
diff.summary.body.hasChanges	boolean	✓
diff.summary.changedComponents	”body” | “comments” | “styles” | …[]	✓
diff.summary.comments	object	✓
diff.summary.comments.hasChanges	boolean	✓
diff.summary.hasChanges	boolean	✓
diff.summary.headerFooters	object	✓
diff.summary.headerFooters.hasChanges	boolean	✓
diff.summary.numbering	object	✓
diff.summary.numbering.hasChanges	boolean	✓
diff.summary.parts	object	✓
diff.summary.parts.hasChanges	boolean	✓
diff.summary.styles	object	✓
diff.summary.styles.hasChanges	boolean	✓
diff.targetFingerprint	string	✓
diff.version	”sd-diff-payload/v1” | “sd-diff-payload/v2”	✓	"sd-diff-payload/v1", "sd-diff-payload/v2"

Full reference →

Fields (5)

fields.list

editor.doc.fields.list(...)

Field	Type	Req	Description
limit	integer
offset	integer

Full reference →

fields.get

editor.doc.fields.get(...)

Field	Type	Req	Description
target	{ kind: "field" }	✓
target.blockId	string	✓
target.kind	"field"	✓	Constant: "field"
target.nestingDepth	integer
target.occurrenceIndex	integer	✓

Full reference →

fields.insert

editor.doc.fields.insert(...)

Field	Type	Req	Description
at	TextTarget	✓	TextTarget
at.kind	"text"	✓	Constant: "text"
at.segments	TextSegment[]	✓
at.story	StoryLocator		StoryLocator
instruction	string	✓
mode	"raw"	✓	Constant: "raw"

Full reference →

fields.rebuild

editor.doc.fields.rebuild(...)

Field	Type	Req	Description
target	{ kind: "field" }	✓
target.blockId	string	✓
target.kind	"field"	✓	Constant: "field"
target.nestingDepth	integer
target.occurrenceIndex	integer	✓

Full reference →

fields.remove

editor.doc.fields.remove(...)

Field	Type	Req	Description
mode	"raw"	✓	Constant: "raw"
target	{ kind: "field" }	✓
target.blockId	string	✓
target.kind	"field"	✓	Constant: "field"
target.nestingDepth	integer
target.occurrenceIndex	integer	✓

Full reference →

Footnotes (6)

footnotes.list

editor.doc.footnotes.list(...)

Field	Type	Req	Description
limit	integer
offset	integer
type	”footnote” | “endnote”		"footnote", "endnote"

Full reference →

footnotes.get

editor.doc.footnotes.get(...)

Field	Type	Req	Description
target	{ kind: "entity", entityType: "footnote" }	✓
target.entityType	"footnote"	✓	Constant: "footnote"
target.kind	"entity"	✓	Constant: "entity"
target.noteId	string	✓

Full reference →

footnotes.insert

editor.doc.footnotes.insert(...)

Field	Type	Req	Description
at	TextTarget	✓	TextTarget
at.kind	"text"	✓	Constant: "text"
at.segments	TextSegment[]	✓
at.story	StoryLocator		StoryLocator
content	string	✓
type	”footnote” | “endnote”	✓	"footnote", "endnote"

Full reference →

footnotes.update

editor.doc.footnotes.update(...)

Field	Type	Req	Description
patch	object	✓
patch.content	string
target	{ kind: "entity", entityType: "footnote" }	✓
target.entityType	"footnote"	✓	Constant: "footnote"
target.kind	"entity"	✓	Constant: "entity"
target.noteId	string	✓

Full reference →

footnotes.remove

editor.doc.footnotes.remove(...)

Field	Type	Req	Description
target	{ kind: "entity", entityType: "footnote" }	✓
target.entityType	"footnote"	✓	Constant: "footnote"
target.kind	"entity"	✓	Constant: "entity"
target.noteId	string	✓

Full reference →

footnotes.configure

editor.doc.footnotes.configure(...)

Field	Type	Req	Description
numbering	object
numbering.format	”decimal” | “lowerRoman” | “upperRoman” | …		"decimal", "lowerRoman", "upperRoman", "lowerLetter", "upperLetter", "symbol"
numbering.position	”pageBottom” | “beneathText” | “sectionEnd” | …		"pageBottom", "beneathText", "sectionEnd", "documentEnd"
numbering.restartPolicy	”continuous” | “eachSection” | “eachPage”		"continuous", "eachSection", "eachPage"
numbering.start	integer
scope	{ kind: "document" } | { kind: "section" }	✓	One of: object(kind=“document”), object(kind=“section”)
type	”footnote” | “endnote”	✓	"footnote", "endnote"

Full reference →

Format (45)

formatRange

editor.doc.formatRange(...)

No input fields.

Full reference →

format.apply

editor.doc.format.apply(...)

No input fields.

Full reference →

format.bold

editor.doc.format.bold(...)

No input fields.

Full reference →

format.italic

editor.doc.format.italic(...)

No input fields.

Full reference →

format.strike

editor.doc.format.strike(...)

No input fields.

Full reference →

format.underline

editor.doc.format.underline(...)

No input fields.

Full reference →

format.highlight

editor.doc.format.highlight(...)

No input fields.

Full reference →

format.color

editor.doc.format.color(...)

No input fields.

Full reference →

format.fontSize

editor.doc.format.fontSize(...)

No input fields.

Full reference →

format.fontFamily

editor.doc.format.fontFamily(...)

No input fields.

Full reference →

format.letterSpacing

editor.doc.format.letterSpacing(...)

No input fields.

Full reference →

format.vertAlign

editor.doc.format.vertAlign(...)

No input fields.

Full reference →

format.position

editor.doc.format.position(...)

No input fields.

Full reference →

format.dstrike

editor.doc.format.dstrike(...)

No input fields.

Full reference →

format.smallCaps

editor.doc.format.smallCaps(...)

No input fields.

Full reference →

format.caps

editor.doc.format.caps(...)

No input fields.

Full reference →

format.shading

editor.doc.format.shading(...)

No input fields.

Full reference →

format.border

editor.doc.format.border(...)

No input fields.

Full reference →

format.outline

editor.doc.format.outline(...)

No input fields.

Full reference →

format.shadow

editor.doc.format.shadow(...)

No input fields.

Full reference →

format.emboss

editor.doc.format.emboss(...)

No input fields.

Full reference →

format.imprint

editor.doc.format.imprint(...)

No input fields.

Full reference →

format.charScale

editor.doc.format.charScale(...)

No input fields.

Full reference →

format.kerning

editor.doc.format.kerning(...)

No input fields.

Full reference →

format.vanish

editor.doc.format.vanish(...)

No input fields.

Full reference →

format.webHidden

editor.doc.format.webHidden(...)

No input fields.

Full reference →

format.specVanish

editor.doc.format.specVanish(...)

No input fields.

Full reference →

format.rtl

editor.doc.format.rtl(...)

No input fields.

Full reference →

format.cs

editor.doc.format.cs(...)

No input fields.

Full reference →

format.bCs

editor.doc.format.bCs(...)

No input fields.

Full reference →

format.iCs

editor.doc.format.iCs(...)

No input fields.

Full reference →

format.eastAsianLayout

editor.doc.format.eastAsianLayout(...)

No input fields.

Full reference →

format.em

editor.doc.format.em(...)

No input fields.

Full reference →

format.fitText

editor.doc.format.fitText(...)

No input fields.

Full reference →

format.snapToGrid

editor.doc.format.snapToGrid(...)

No input fields.

Full reference →

format.lang

editor.doc.format.lang(...)

No input fields.

Full reference →

format.oMath

editor.doc.format.oMath(...)

No input fields.

Full reference →

format.rStyle

editor.doc.format.rStyle(...)

No input fields.

Full reference →

format.rFonts

editor.doc.format.rFonts(...)

No input fields.

Full reference →

format.fontSizeCs

editor.doc.format.fontSizeCs(...)

No input fields.

Full reference →

format.ligatures

editor.doc.format.ligatures(...)

No input fields.

Full reference →

format.numForm

editor.doc.format.numForm(...)

No input fields.

Full reference →

format.numSpacing

editor.doc.format.numSpacing(...)

No input fields.

Full reference →

format.stylisticSets

editor.doc.format.stylisticSets(...)

No input fields.

Full reference →

format.contextualAlternates

editor.doc.format.contextualAlternates(...)

No input fields.

Full reference →

Headers & Footers (9)

headerFooters.list

editor.doc.headerFooters.list(...)

Field	Type	Req	Description
kind	”header” | “footer”		"header", "footer"
limit	integer
offset	integer
section	SectionAddress		SectionAddress
section.kind	"section"		Constant: "section"
section.sectionId	string

Full reference →

headerFooters.get

editor.doc.headerFooters.get(...)

Field	Type	Req	Description
target	{ kind: "headerFooterSlot" }	✓
target.headerFooterKind	”header” | “footer”	✓	"header", "footer"
target.kind	"headerFooterSlot"	✓	Constant: "headerFooterSlot"
target.section	SectionAddress	✓	SectionAddress
target.section.kind	"section"	✓	Constant: "section"
target.section.sectionId	string	✓
target.variant	”default” | “first” | “even”	✓	"default", "first", "even"

Full reference →

headerFooters.resolve

editor.doc.headerFooters.resolve(...)

Field	Type	Req	Description
target	{ kind: "headerFooterSlot" }	✓
target.headerFooterKind	”header” | “footer”	✓	"header", "footer"
target.kind	"headerFooterSlot"	✓	Constant: "headerFooterSlot"
target.section	SectionAddress	✓	SectionAddress
target.section.kind	"section"	✓	Constant: "section"
target.section.sectionId	string	✓
target.variant	”default” | “first” | “even”	✓	"default", "first", "even"

Full reference →

headerFooters.refs.set

editor.doc.headerFooters.refs.set(...)

Field	Type	Req	Description
refId	string	✓
target	{ kind: "headerFooterSlot" }	✓
target.headerFooterKind	”header” | “footer”	✓	"header", "footer"
target.kind	"headerFooterSlot"	✓	Constant: "headerFooterSlot"
target.section	SectionAddress	✓	SectionAddress
target.section.kind	"section"	✓	Constant: "section"
target.section.sectionId	string	✓
target.variant	”default” | “first” | “even”	✓	"default", "first", "even"

Full reference →

headerFooters.refs.clear

editor.doc.headerFooters.refs.clear(...)

Field	Type	Req	Description
target	{ kind: "headerFooterSlot" }	✓
target.headerFooterKind	”header” | “footer”	✓	"header", "footer"
target.kind	"headerFooterSlot"	✓	Constant: "headerFooterSlot"
target.section	SectionAddress	✓	SectionAddress
target.section.kind	"section"	✓	Constant: "section"
target.section.sectionId	string	✓
target.variant	”default” | “first” | “even”	✓	"default", "first", "even"

Full reference →

headerFooters.refs.setLinkedToPrevious

editor.doc.headerFooters.refs.setLinkedToPrevious(...)

Field	Type	Req	Description
linked	boolean	✓
target	{ kind: "headerFooterSlot" }	✓
target.headerFooterKind	”header” | “footer”	✓	"header", "footer"
target.kind	"headerFooterSlot"	✓	Constant: "headerFooterSlot"
target.section	SectionAddress	✓	SectionAddress
target.section.kind	"section"	✓	Constant: "section"
target.section.sectionId	string	✓
target.variant	”default” | “first” | “even”	✓	"default", "first", "even"

Full reference →

headerFooters.parts.list

editor.doc.headerFooters.parts.list(...)

Field	Type	Req	Description
kind	”header” | “footer”		"header", "footer"
limit	integer
offset	integer

Full reference →

headerFooters.parts.create

editor.doc.headerFooters.parts.create(...)

Field	Type	Req	Description
kind	”header” | “footer”	✓	"header", "footer"
sourceRefId	string

Full reference →

headerFooters.parts.delete

editor.doc.headerFooters.parts.delete(...)

Field	Type	Req	Description
target	{ kind: "headerFooterPart" }	✓
target.kind	"headerFooterPart"	✓	Constant: "headerFooterPart"
target.refId	string	✓

Full reference →

History (3)

history.get

editor.doc.history.get(...)

No input fields.

Full reference →

history.undo

editor.doc.history.undo(...)

No input fields.

Full reference →

history.redo

editor.doc.history.redo(...)

No input fields.

Full reference →

Hyperlinks (6)

hyperlinks.list

editor.doc.hyperlinks.list(...)

Field	Type	Req	Description
anchor	string
hrefPattern	string
limit	integer
offset	integer
textPattern	string
within	BlockNodeAddress		BlockNodeAddress
within.kind	"block"		Constant: "block"
within.nodeId	string
within.nodeType	”paragraph” | “heading” | “listItem” | …		"paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt"

Full reference →

hyperlinks.get

editor.doc.hyperlinks.get(...)

Field	Type	Req	Description
target	{ kind: "inline", nodeType: "hyperlink" }	✓
target.anchor	InlineAnchor	✓	InlineAnchor
target.anchor.end	Position	✓	Position
target.anchor.end.blockId	string	✓
target.anchor.end.offset	integer	✓
target.anchor.start	Position	✓	Position
target.anchor.start.blockId	string	✓
target.anchor.start.offset	integer	✓
target.kind	"inline"	✓	Constant: "inline"
target.nodeType	"hyperlink"	✓	Constant: "hyperlink"

Full reference →

hyperlinks.wrap

editor.doc.hyperlinks.wrap(...)

Field	Type	Req	Description
link	object	✓
link.destination	object	✓
link.destination.anchor	string
link.destination.docLocation	string
link.destination.href	string
link.rel	string
link.target	string
link.tooltip	string
target	TextAddress	✓	TextAddress
target.blockId	string	✓
target.kind	"text"	✓	Constant: "text"
target.range	Range	✓	Range
target.range.end	integer	✓
target.range.start	integer	✓

Full reference →

hyperlinks.insert

editor.doc.hyperlinks.insert(...)

Field	Type	Req	Description
link	object	✓
link.destination	object	✓
link.destination.anchor	string
link.destination.docLocation	string
link.destination.href	string
link.rel	string
link.target	string
link.tooltip	string
target	TextAddress		TextAddress
target.blockId	string
target.kind	"text"		Constant: "text"
target.range	Range		Range
target.range.end	integer
target.range.start	integer
text	string	✓

Full reference →

hyperlinks.patch

editor.doc.hyperlinks.patch(...)

Field	Type	Req	Description
patch	object	✓
patch.anchor	string | null		One of: string, null
patch.docLocation	string | null		One of: string, null
patch.href	string | null		One of: string, null
patch.rel	string | null		One of: string, null
patch.target	string | null		One of: string, null
patch.tooltip	string | null		One of: string, null
target	{ kind: "inline", nodeType: "hyperlink" }	✓
target.anchor	InlineAnchor	✓	InlineAnchor
target.anchor.end	Position	✓	Position
target.anchor.end.blockId	string	✓
target.anchor.end.offset	integer	✓
target.anchor.start	Position	✓	Position
target.anchor.start.blockId	string	✓
target.anchor.start.offset	integer	✓
target.kind	"inline"	✓	Constant: "inline"
target.nodeType	"hyperlink"	✓	Constant: "hyperlink"

Full reference →

hyperlinks.remove

editor.doc.hyperlinks.remove(...)

Field	Type	Req	Description
mode	”unwrap” | “deleteText”		"unwrap", "deleteText"
target	{ kind: "inline", nodeType: "hyperlink" }	✓
target.anchor	InlineAnchor	✓	InlineAnchor
target.anchor.end	Position	✓	Position
target.anchor.end.blockId	string	✓
target.anchor.end.offset	integer	✓
target.anchor.start	Position	✓	Position
target.anchor.start.blockId	string	✓
target.anchor.start.offset	integer	✓
target.kind	"inline"	✓	Constant: "inline"
target.nodeType	"hyperlink"	✓	Constant: "hyperlink"

Full reference →

Images (27)

images.list

editor.doc.images.list(...)

Field	Type	Req	Description
limit	integer
offset	integer

Full reference →

images.get

editor.doc.images.get(...)

Field	Type	Req	Description
imageId	string	✓

Full reference →

images.delete

editor.doc.images.delete(...)

Field	Type	Req	Description
imageId	string	✓

Full reference →

images.move

editor.doc.images.move(...)

Field	Type	Req	Description
imageId	string	✓
to	{ kind: "documentStart" } | { kind: "documentEnd" } | { kind: "before" } | …	✓	One of: object(kind=“documentStart”), object(kind=“documentEnd”), object(kind=“before”), object(kind=“after”), object(kind=“inParagraph”)

Full reference →

images.convertToInline

editor.doc.images.convertToInline(...)

Field	Type	Req	Description
imageId	string	✓

Full reference →

images.convertToFloating

editor.doc.images.convertToFloating(...)

Field	Type	Req	Description
imageId	string	✓

Full reference →

images.setSize

editor.doc.images.setSize(...)

Field	Type	Req	Description
imageId	string	✓
size	object	✓
size.height	number	✓
size.unit	”px” | “pt” | “twip”		"px", "pt", "twip"
size.width	number	✓

Full reference →

images.setWrapType

editor.doc.images.setWrapType(...)

Field	Type	Req	Description
imageId	string	✓
type	”None” | “Square” | “Through” | …	✓	"None", "Square", "Through", "Tight", "TopAndBottom", "Inline"

Full reference →

images.setWrapSide

editor.doc.images.setWrapSide(...)

Field	Type	Req	Description
imageId	string	✓
side	”bothSides” | “left” | “right” | …	✓	"bothSides", "left", "right", "largest"

Full reference →

images.setWrapDistances

editor.doc.images.setWrapDistances(...)

Field	Type	Req	Description
distances	object	✓
distances.distBottom	number
distances.distLeft	number
distances.distRight	number
distances.distTop	number
imageId	string	✓

Full reference →

images.setPosition

editor.doc.images.setPosition(...)

Field	Type	Req	Description
imageId	string	✓
position	object	✓
position.alignH	string
position.alignV	string
position.hRelativeFrom	string
position.marginOffset	object
position.marginOffset.horizontal	number
position.marginOffset.top	number
position.vRelativeFrom	string

Full reference →

images.setAnchorOptions

editor.doc.images.setAnchorOptions(...)

Field	Type	Req	Description
imageId	string	✓
options	object	✓
options.allowOverlap	boolean
options.behindDoc	boolean
options.layoutInCell	boolean
options.lockAnchor	boolean
options.simplePos	boolean

Full reference →

images.setZOrder

editor.doc.images.setZOrder(...)

Field	Type	Req	Description
imageId	string	✓
zOrder	object	✓
zOrder.relativeHeight	integer	✓

Full reference →

images.scale

editor.doc.images.scale(...)

Field	Type	Req	Description
factor	number	✓
imageId	string	✓

Full reference →

images.setLockAspectRatio

editor.doc.images.setLockAspectRatio(...)

Field	Type	Req	Description
imageId	string	✓
locked	boolean	✓

Full reference →

images.rotate

editor.doc.images.rotate(...)

Field	Type	Req	Description
angle	number	✓
imageId	string	✓

Full reference →

images.flip

editor.doc.images.flip(...)

Field	Type	Req	Description
horizontal	boolean
imageId	string	✓
vertical	boolean

Full reference →

images.crop

editor.doc.images.crop(...)

Field	Type	Req	Description
crop	object	✓
crop.bottom	number
crop.left	number
crop.right	number
crop.top	number
imageId	string	✓

Full reference →

images.resetCrop

editor.doc.images.resetCrop(...)

Field	Type	Req	Description
imageId	string	✓

Full reference →

images.replaceSource

editor.doc.images.replaceSource(...)

Field	Type	Req	Description
imageId	string	✓
resetSize	boolean
src	string	✓

Full reference →

images.setAltText

editor.doc.images.setAltText(...)

Field	Type	Req	Description
description	string	✓
imageId	string	✓

Full reference →

images.setDecorative

editor.doc.images.setDecorative(...)

Field	Type	Req	Description
decorative	boolean	✓
imageId	string	✓

Full reference →

images.setName

editor.doc.images.setName(...)

Field	Type	Req	Description
imageId	string	✓
name	string	✓

Full reference →

images.setHyperlink

editor.doc.images.setHyperlink(...)

Field	Type	Req	Description
imageId	string	✓
tooltip	string
url	string | null	✓

Full reference →

images.insertCaption

editor.doc.images.insertCaption(...)

Field	Type	Req	Description
imageId	string	✓
text	string	✓

Full reference →

images.updateCaption

editor.doc.images.updateCaption(...)

Field	Type	Req	Description
imageId	string	✓
text	string	✓

Full reference →

images.removeCaption

editor.doc.images.removeCaption(...)

Field	Type	Req	Description
imageId	string	✓

Full reference →

Index (11)

index.list

editor.doc.index.list(...)

Field	Type	Req	Description
limit	integer
offset	integer

Full reference →

index.get

editor.doc.index.get(...)

Field	Type	Req	Description
target	{ kind: "block", nodeType: "index" }	✓
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"index"	✓	Constant: "index"

Full reference →

index.insert

editor.doc.index.insert(...)

Field	Type	Req	Description
at	{ kind: "documentStart" } | { kind: "documentEnd" } | { kind: "before" } | { kind: "after" }	✓	One of: object(kind=“documentStart”), object(kind=“documentEnd”), object(kind=“before”), object(kind=“after”)
config	object
config.accentedSorting	boolean
config.columns	integer
config.entryPageSeparator	string
config.entryTypeFilter	string
config.headingSeparator	string
config.letterRange	object
config.letterRange.from	string
config.letterRange.to	string
config.pageRangeBookmark	string
config.pageRangeSeparator	string
config.runIn	boolean
config.sequenceId	string

Full reference →

index.configure

editor.doc.index.configure(...)

Field	Type	Req	Description
patch	object	✓
patch.accentedSorting	boolean
patch.columns	integer
patch.entryPageSeparator	string
patch.entryTypeFilter	string
patch.headingSeparator	string
patch.letterRange	object
patch.letterRange.from	string
patch.letterRange.to	string
patch.pageRangeBookmark	string
patch.pageRangeSeparator	string
patch.runIn	boolean
patch.sequenceId	string
target	{ kind: "block", nodeType: "index" }	✓
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"index"	✓	Constant: "index"

Full reference →

index.rebuild

editor.doc.index.rebuild(...)

Field	Type	Req	Description
target	{ kind: "block", nodeType: "index" }	✓
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"index"	✓	Constant: "index"

Full reference →

index.remove

editor.doc.index.remove(...)

Field	Type	Req	Description
target	{ kind: "block", nodeType: "index" }	✓
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"index"	✓	Constant: "index"

Full reference →

index.entries.list

editor.doc.index.entries.list(...)

Field	Type	Req	Description
entryType	string
limit	integer
offset	integer

Full reference →

index.entries.get

editor.doc.index.entries.get(...)

Field	Type	Req	Description
target	{ kind: "inline", nodeType: "indexEntry" }	✓
target.anchor	InlineAnchor	✓	InlineAnchor
target.anchor.end	Position	✓	Position
target.anchor.end.blockId	string	✓
target.anchor.end.offset	integer	✓
target.anchor.start	Position	✓	Position
target.anchor.start.blockId	string	✓
target.anchor.start.offset	integer	✓
target.kind	"inline"	✓	Constant: "inline"
target.nodeType	"indexEntry"	✓	Constant: "indexEntry"

Full reference →

index.entries.insert

editor.doc.index.entries.insert(...)

Field	Type	Req	Description
at	TextTarget	✓	TextTarget
at.kind	"text"	✓	Constant: "text"
at.segments	TextSegment[]	✓
at.story	StoryLocator		StoryLocator
entry	object	✓
entry.bold	boolean
entry.crossReference	string
entry.entryType	string
entry.italic	boolean
entry.pageRangeBookmark	string
entry.subEntry	string
entry.text	string	✓
entry.yomi	string

Full reference →

index.entries.update

editor.doc.index.entries.update(...)

Field	Type	Req	Description
patch	object	✓
patch.bold	boolean
patch.crossReference	string
patch.entryType	string
patch.italic	boolean
patch.pageRangeBookmark	string
patch.subEntry	string
patch.text	string
patch.yomi	string
target	{ kind: "inline", nodeType: "indexEntry" }	✓
target.anchor	InlineAnchor	✓	InlineAnchor
target.anchor.end	Position	✓	Position
target.anchor.end.blockId	string	✓
target.anchor.end.offset	integer	✓
target.anchor.start	Position	✓	Position
target.anchor.start.blockId	string	✓
target.anchor.start.offset	integer	✓
target.kind	"inline"	✓	Constant: "inline"
target.nodeType	"indexEntry"	✓	Constant: "indexEntry"

Full reference →

index.entries.remove

editor.doc.index.entries.remove(...)

Field	Type	Req	Description
target	{ kind: "inline", nodeType: "indexEntry" }	✓
target.anchor	InlineAnchor	✓	InlineAnchor
target.anchor.end	Position	✓	Position
target.anchor.end.blockId	string	✓
target.anchor.end.offset	integer	✓
target.anchor.start	Position	✓	Position
target.anchor.start.blockId	string	✓
target.anchor.start.offset	integer	✓
target.kind	"inline"	✓	Constant: "inline"
target.nodeType	"indexEntry"	✓	Constant: "indexEntry"

Full reference →

Lists (39)

lists.list

editor.doc.lists.list(...)

Field	Type	Req	Description
kind	”ordered” | “bullet”		"ordered", "bullet"
level	integer
limit	integer
offset	integer
ordinal	integer
within	BlockNodeAddress		BlockNodeAddress
within.kind	"block"		Constant: "block"
within.nodeId	string
within.nodeType	”paragraph” | “heading” | “listItem” | …		"paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt"

Full reference →

lists.get

editor.doc.lists.get(...)

Field	Type	Req	Description
address	ListItemAddress	✓	ListItemAddress
address.kind	"block"	✓	Constant: "block"
address.nodeId	string	✓
address.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.insert

editor.doc.lists.insert(...)

Field	Type	Req	Description
position	”before” | “after”	✓	"before", "after"
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"
text	string

Full reference →

lists.create

editor.doc.lists.create(...)

No input fields.

Full reference →

lists.attach

editor.doc.lists.attach(...)

Field	Type	Req	Description
attachTo	ListItemAddress	✓	ListItemAddress
attachTo.kind	"block"	✓	Constant: "block"
attachTo.nodeId	string	✓
attachTo.nodeType	"listItem"	✓	Constant: "listItem"
level	integer
target	BlockAddressOrRange	✓	BlockAddressOrRange

Full reference →

lists.detach

editor.doc.lists.detach(...)

Field	Type	Req	Description
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.delete

editor.doc.lists.delete(...)

Field	Type	Req	Description
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.indent

editor.doc.lists.indent(...)

Field	Type	Req	Description
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.outdent

editor.doc.lists.outdent(...)

Field	Type	Req	Description
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.join

editor.doc.lists.join(...)

Field	Type	Req	Description
direction	”withPrevious” | “withNext”	✓	"withPrevious", "withNext"
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.canJoin

editor.doc.lists.canJoin(...)

Field	Type	Req	Description
direction	”withPrevious” | “withNext”	✓	"withPrevious", "withNext"
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.separate

editor.doc.lists.separate(...)

Field	Type	Req	Description
copyOverrides	boolean
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.merge

editor.doc.lists.merge(...)

Field	Type	Req	Description
direction	”withPrevious” | “withNext”	✓	"withPrevious", "withNext"
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.split

editor.doc.lists.split(...)

Field	Type	Req	Description
restartNumbering	boolean
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.setLevel

editor.doc.lists.setLevel(...)

Field	Type	Req	Description
level	integer	✓
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.setValue

editor.doc.lists.setValue(...)

Field	Type	Req	Description
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"
value	integer | null	✓

Full reference →

lists.continuePrevious

editor.doc.lists.continuePrevious(...)

Field	Type	Req	Description
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.canContinuePrevious

editor.doc.lists.canContinuePrevious(...)

Field	Type	Req	Description
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.setLevelRestart

editor.doc.lists.setLevelRestart(...)

Field	Type	Req	Description
level	integer	✓
restartAfterLevel	integer | null	✓
scope	”definition” | “instance”		"definition", "instance"
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.convertToText

editor.doc.lists.convertToText(...)

Field	Type	Req	Description
includeMarker	boolean
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.applyTemplate

editor.doc.lists.applyTemplate(...)

Field	Type	Req	Description
levels	integer[]
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"
template	{ version: 1 }	✓
template.levels	object[]	✓
template.version	1	✓	Constant: 1

Full reference →

lists.applyPreset

editor.doc.lists.applyPreset(...)

Field	Type	Req	Description
levels	integer[]
preset	”decimal” | “decimalParenthesis” | “lowerLetter” | …	✓	"decimal", "decimalParenthesis", "lowerLetter", "upperLetter", "lowerRoman", "upperRoman", "disc", "circle", "square", "dash"
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.setType

editor.doc.lists.setType(...)

Field	Type	Req	Description
continuity	”preserve” | “none”		"preserve", "none"
kind	”ordered” | “bullet”	✓	"ordered", "bullet"
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.captureTemplate

editor.doc.lists.captureTemplate(...)

Field	Type	Req	Description
levels	integer[]
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.setLevelNumbering

editor.doc.lists.setLevelNumbering(...)

Field	Type	Req	Description
level	integer	✓
lvlText	string	✓
numFmt	string	✓
start	integer
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.setLevelBullet

editor.doc.lists.setLevelBullet(...)

Field	Type	Req	Description
level	integer	✓
markerText	string	✓
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.setLevelPictureBullet

editor.doc.lists.setLevelPictureBullet(...)

Field	Type	Req	Description
level	integer	✓
pictureBulletId	integer	✓
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.setLevelAlignment

editor.doc.lists.setLevelAlignment(...)

Field	Type	Req	Description
alignment	”left” | “center” | “right”	✓	"left", "center", "right"
level	integer	✓
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.setLevelIndents

editor.doc.lists.setLevelIndents(...)

Field	Type	Req	Description
firstLine	integer
hanging	integer
left	integer
level	integer	✓
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.setLevelTrailingCharacter

editor.doc.lists.setLevelTrailingCharacter(...)

Field	Type	Req	Description
level	integer	✓
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"
trailingCharacter	”tab” | “space” | “nothing”	✓	"tab", "space", "nothing"

Full reference →

lists.setLevelMarkerFont

editor.doc.lists.setLevelMarkerFont(...)

Field	Type	Req	Description
fontFamily	string	✓
level	integer	✓
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.clearLevelOverrides

editor.doc.lists.clearLevelOverrides(...)

Field	Type	Req	Description
level	integer	✓
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.getStyle

editor.doc.lists.getStyle(...)

Field	Type	Req	Description
levels	integer[]
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.applyStyle

editor.doc.lists.applyStyle(...)

Field	Type	Req	Description
levels	integer[]
style	{ version: 1 }	✓
style.levels	object[]	✓
style.version	1	✓	Constant: 1
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.restartAt

editor.doc.lists.restartAt(...)

Field	Type	Req	Description
startAt	integer	✓
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.setLevelNumberStyle

editor.doc.lists.setLevelNumberStyle(...)

Field	Type	Req	Description
level	integer	✓
numberStyle	string	✓
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.setLevelText

editor.doc.lists.setLevelText(...)

Field	Type	Req	Description
level	integer	✓
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"
text	string	✓

Full reference →

lists.setLevelStart

editor.doc.lists.setLevelStart(...)

Field	Type	Req	Description
level	integer	✓
startAt	integer	✓
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

lists.setLevelLayout

editor.doc.lists.setLevelLayout(...)

Field	Type	Req	Description
layout	object	✓
layout.alignedAt	integer
layout.alignment	”left” | “center” | “right”		"left", "center", "right"
layout.followCharacter	”tab” | “space” | “nothing”		"tab", "space", "nothing"
layout.tabStopAt	integer | null
layout.textIndentAt	integer
level	integer	✓
target	ListItemAddress	✓	ListItemAddress
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"listItem"	✓	Constant: "listItem"

Full reference →

Mutations (2)

mutations.preview

editor.doc.mutations.preview(...)

Field	Type	Req	Description
atomic	true	✓	Constant: true
changeMode	”direct” | “tracked”	✓	"direct", "tracked"
expectedRevision	string
in	StoryLocator		StoryLocator
steps	{ op: "text.rewrite" } | { op: "text.insert" } | { op: "text.delete" } | …[]	✓

Full reference →

mutations.apply

editor.doc.mutations.apply(...)

Field	Type	Req	Description
atomic	true	✓	Constant: true
changeMode	”direct” | “tracked”	✓	"direct", "tracked"
expectedRevision	string
in	StoryLocator		StoryLocator
steps	{ op: "text.rewrite" } | { op: "text.insert" } | { op: "text.delete" } | …[]	✓

Full reference →

Paragraph Formatting (19)

format.paragraph.resetDirectFormatting

editor.doc.format.paragraph.resetDirectFormatting(...)

Field	Type	Req	Description
target	{ kind: "block", nodeType: "paragraph" } | { kind: "block", nodeType: "heading" } | { kind: "block", nodeType: "listItem" }	✓	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Full reference →

format.paragraph.setAlignment

editor.doc.format.paragraph.setAlignment(...)

Field	Type	Req	Description
alignment	”left” | “center” | “right” | …	✓	"left", "center", "right", "justify"
target	{ kind: "block", nodeType: "paragraph" } | { kind: "block", nodeType: "heading" } | { kind: "block", nodeType: "listItem" }	✓	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Full reference →

format.paragraph.clearAlignment

editor.doc.format.paragraph.clearAlignment(...)

Field	Type	Req	Description
target	{ kind: "block", nodeType: "paragraph" } | { kind: "block", nodeType: "heading" } | { kind: "block", nodeType: "listItem" }	✓	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Full reference →

format.paragraph.setIndentation

editor.doc.format.paragraph.setIndentation(...)

Field	Type	Req	Description
firstLine	integer
hanging	integer
left	integer
right	integer
target	{ kind: "block", nodeType: "paragraph" } | { kind: "block", nodeType: "heading" } | { kind: "block", nodeType: "listItem" }	✓	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Full reference →

format.paragraph.clearIndentation

editor.doc.format.paragraph.clearIndentation(...)

Field	Type	Req	Description
target	{ kind: "block", nodeType: "paragraph" } | { kind: "block", nodeType: "heading" } | { kind: "block", nodeType: "listItem" }	✓	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Full reference →

format.paragraph.setSpacing

editor.doc.format.paragraph.setSpacing(...)

Field	Type	Req	Description
after	integer
before	integer
line	integer
lineRule	”auto” | “exact” | “atLeast”		"auto", "exact", "atLeast"
target	{ kind: "block", nodeType: "paragraph" } | { kind: "block", nodeType: "heading" } | { kind: "block", nodeType: "listItem" }	✓	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Full reference →

format.paragraph.clearSpacing

editor.doc.format.paragraph.clearSpacing(...)

Field	Type	Req	Description
target	{ kind: "block", nodeType: "paragraph" } | { kind: "block", nodeType: "heading" } | { kind: "block", nodeType: "listItem" }	✓	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Full reference →

format.paragraph.setKeepOptions

editor.doc.format.paragraph.setKeepOptions(...)

Field	Type	Req	Description
keepLines	boolean
keepNext	boolean
target	{ kind: "block", nodeType: "paragraph" } | { kind: "block", nodeType: "heading" } | { kind: "block", nodeType: "listItem" }	✓	One of: ParagraphAddress, HeadingAddress, ListItemAddress
widowControl	boolean

Full reference →

format.paragraph.setOutlineLevel

editor.doc.format.paragraph.setOutlineLevel(...)

Field	Type	Req	Description
outlineLevel	integer | null	✓	One of: integer, null
target	{ kind: "block", nodeType: "paragraph" } | { kind: "block", nodeType: "heading" } | { kind: "block", nodeType: "listItem" }	✓	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Full reference →

format.paragraph.setFlowOptions

editor.doc.format.paragraph.setFlowOptions(...)

Field	Type	Req	Description
contextualSpacing	boolean
pageBreakBefore	boolean
suppressAutoHyphens	boolean
target	{ kind: "block", nodeType: "paragraph" } | { kind: "block", nodeType: "heading" } | { kind: "block", nodeType: "listItem" }	✓	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Full reference →

format.paragraph.setTabStop

editor.doc.format.paragraph.setTabStop(...)

Field	Type	Req	Description
alignment	”left” | “center” | “right” | …	✓	"left", "center", "right", "decimal", "bar"
leader	”none” | “dot” | “hyphen” | …		"none", "dot", "hyphen", "underscore", "heavy", "middleDot"
position	integer	✓
target	{ kind: "block", nodeType: "paragraph" } | { kind: "block", nodeType: "heading" } | { kind: "block", nodeType: "listItem" }	✓	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Full reference →

format.paragraph.clearTabStop

editor.doc.format.paragraph.clearTabStop(...)

Field	Type	Req	Description
position	integer	✓
target	{ kind: "block", nodeType: "paragraph" } | { kind: "block", nodeType: "heading" } | { kind: "block", nodeType: "listItem" }	✓	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Full reference →

format.paragraph.clearAllTabStops

editor.doc.format.paragraph.clearAllTabStops(...)

Field	Type	Req	Description
target	{ kind: "block", nodeType: "paragraph" } | { kind: "block", nodeType: "heading" } | { kind: "block", nodeType: "listItem" }	✓	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Full reference →

format.paragraph.setBorder

editor.doc.format.paragraph.setBorder(...)

Field	Type	Req	Description
color	string
side	”top” | “bottom” | “left” | …	✓	"top", "bottom", "left", "right", "between", "bar"
size	integer
space	integer
style	string	✓
target	{ kind: "block", nodeType: "paragraph" } | { kind: "block", nodeType: "heading" } | { kind: "block", nodeType: "listItem" }	✓	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Full reference →

format.paragraph.clearBorder

editor.doc.format.paragraph.clearBorder(...)

Field	Type	Req	Description
side	”top” | “bottom” | “left” | …	✓	"top", "bottom", "left", "right", "between", "bar", "all"
target	{ kind: "block", nodeType: "paragraph" } | { kind: "block", nodeType: "heading" } | { kind: "block", nodeType: "listItem" }	✓	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Full reference →

format.paragraph.setShading

editor.doc.format.paragraph.setShading(...)

Field	Type	Req	Description
color	string
fill	string
pattern	string
target	{ kind: "block", nodeType: "paragraph" } | { kind: "block", nodeType: "heading" } | { kind: "block", nodeType: "listItem" }	✓	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Full reference →

format.paragraph.clearShading

editor.doc.format.paragraph.clearShading(...)

Field	Type	Req	Description
target	{ kind: "block", nodeType: "paragraph" } | { kind: "block", nodeType: "heading" } | { kind: "block", nodeType: "listItem" }	✓	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Full reference →

format.paragraph.setDirection

editor.doc.format.paragraph.setDirection(...)

Field	Type	Req	Description
alignmentPolicy	”preserve” | “matchDirection”		"preserve", "matchDirection"
direction	”ltr” | “rtl”	✓	"ltr", "rtl"
target	{ kind: "block", nodeType: "paragraph" } | { kind: "block", nodeType: "heading" } | { kind: "block", nodeType: "listItem" }	✓	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Full reference →

format.paragraph.clearDirection

editor.doc.format.paragraph.clearDirection(...)

Field	Type	Req	Description
target	{ kind: "block", nodeType: "paragraph" } | { kind: "block", nodeType: "heading" } | { kind: "block", nodeType: "listItem" }	✓	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Full reference →

Paragraph Styles (2)

styles.paragraph.setStyle

editor.doc.styles.paragraph.setStyle(...)

Field	Type	Req	Description
styleId	string	✓
target	{ kind: "block", nodeType: "paragraph" } | { kind: "block", nodeType: "heading" } | { kind: "block", nodeType: "listItem" }	✓	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Full reference →

styles.paragraph.clearStyle

editor.doc.styles.paragraph.clearStyle(...)

Field	Type	Req	Description
target	{ kind: "block", nodeType: "paragraph" } | { kind: "block", nodeType: "heading" } | { kind: "block", nodeType: "listItem" }	✓	One of: ParagraphAddress, HeadingAddress, ListItemAddress

Full reference →

Permission Ranges (5)

permissionRanges.list

editor.doc.permissionRanges.list(...)

Field	Type	Req	Description
limit	integer
offset	integer

Full reference →

permissionRanges.get

editor.doc.permissionRanges.get(...)

Field	Type	Req	Description
id	string	✓

Full reference →

permissionRanges.create

editor.doc.permissionRanges.create(...)

Field	Type	Req	Description
id	string
principal	object	✓
principal.id	string
principal.kind	”everyone” | “editor”	✓	"everyone", "editor"
target	SelectionTarget	✓	SelectionTarget
target.end	SelectionPoint	✓	SelectionPoint
target.kind	"selection"	✓	Constant: "selection"
target.start	SelectionPoint	✓	SelectionPoint

Full reference →

permissionRanges.remove

editor.doc.permissionRanges.remove(...)

Field	Type	Req	Description
id	string	✓

Full reference →

permissionRanges.updatePrincipal

editor.doc.permissionRanges.updatePrincipal(...)

Field	Type	Req	Description
id	string	✓
principal	object	✓
principal.id	string
principal.kind	”everyone” | “editor”	✓	"everyone", "editor"

Full reference →

Protection (3)

protection.get

editor.doc.protection.get(...)

No input fields.

Full reference →

protection.setEditingRestriction

editor.doc.protection.setEditingRestriction(...)

Field	Type	Req	Description
formattingRestricted	boolean
mode	”readOnly”	✓	"readOnly"

Full reference →

protection.clearEditingRestriction

editor.doc.protection.clearEditingRestriction(...)

No input fields.

Full reference →

Query (1)

query.match

editor.doc.query.match(...)

Field	Type	Req	Description
in	StoryLocator		StoryLocator
includeNodes	boolean
limit	integer
mode	”strict” | “candidates”		"strict", "candidates"
offset	integer
require	”any” | “first” | “exactlyOne” | …		"any", "first", "exactlyOne", "all"
select	{ type: "text" } | { type: "node" }	✓	One of: object(type=“text”), object(type=“node”)
within	BlockNodeAddress		BlockNodeAddress
within.kind	"block"		Constant: "block"
within.nodeId	string
within.nodeType	”paragraph” | “heading” | “listItem” | …		"paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt"

Full reference →

Ranges (1)

ranges.resolve

editor.doc.ranges.resolve(...)

Field	Type	Req	Description
end	{ kind: "document" } | { kind: "point" } | { kind: "ref" }	✓	One of: object(kind=“document”), object(kind=“point”), object(kind=“ref”)
expectedRevision	string
start	{ kind: "document" } | { kind: "point" } | { kind: "ref" }	✓	One of: object(kind=“document”), object(kind=“point”), object(kind=“ref”)

Full reference →

Sections (18)

sections.list

editor.doc.sections.list(...)

Field	Type	Req	Description
limit	integer
offset	integer

Full reference →

sections.get

editor.doc.sections.get(...)

Field	Type	Req	Description
address	SectionAddress	✓	SectionAddress
address.kind	"section"	✓	Constant: "section"
address.sectionId	string	✓

Full reference →

sections.setBreakType

editor.doc.sections.setBreakType(...)

Field	Type	Req	Description
breakType	”continuous” | “nextPage” | “evenPage” | …	✓	"continuous", "nextPage", "evenPage", "oddPage"
target	SectionAddress	✓	SectionAddress
target.kind	"section"	✓	Constant: "section"
target.sectionId	string	✓

Full reference →

sections.setPageMargins

editor.doc.sections.setPageMargins(...)

Field	Type	Req	Description
bottom	number
gutter	number
left	number
right	number
target	SectionAddress	✓	SectionAddress
target.kind	"section"	✓	Constant: "section"
target.sectionId	string	✓
top	number

Full reference →

sections.setHeaderFooterMargins

editor.doc.sections.setHeaderFooterMargins(...)

Field	Type	Req	Description
footer	number
header	number
target	SectionAddress	✓	SectionAddress
target.kind	"section"	✓	Constant: "section"
target.sectionId	string	✓

Full reference →

sections.setPageSetup

editor.doc.sections.setPageSetup(...)

Field	Type	Req	Description
height	number
orientation	”portrait” | “landscape”		"portrait", "landscape"
paperSize	string
target	SectionAddress	✓	SectionAddress
target.kind	"section"	✓	Constant: "section"
target.sectionId	string	✓
width	number

Full reference →

sections.setColumns

editor.doc.sections.setColumns(...)

Field	Type	Req	Description
count	integer
equalWidth	boolean
gap	number
target	SectionAddress	✓	SectionAddress
target.kind	"section"	✓	Constant: "section"
target.sectionId	string	✓

Full reference →

sections.setLineNumbering

editor.doc.sections.setLineNumbering(...)

Field	Type	Req	Description
countBy	integer
distance	number
enabled	boolean	✓
restart	”continuous” | “newPage” | “newSection”		"continuous", "newPage", "newSection"
start	integer
target	SectionAddress	✓	SectionAddress
target.kind	"section"	✓	Constant: "section"
target.sectionId	string	✓

Full reference →

sections.setPageNumbering

editor.doc.sections.setPageNumbering(...)

Field	Type	Req	Description
chapterSeparator	”hyphen” | “period” | “colon” | …		"hyphen", "period", "colon", "emDash", "enDash"
chapterStyle	integer
format	”decimal” | “lowerLetter” | “upperLetter” | …		"decimal", "lowerLetter", "upperLetter", "lowerRoman", "upperRoman", "numberInDash"
start	integer
target	SectionAddress	✓	SectionAddress
target.kind	"section"	✓	Constant: "section"
target.sectionId	string	✓

Full reference →

sections.setTitlePage

editor.doc.sections.setTitlePage(...)

Field	Type	Req	Description
enabled	boolean	✓
target	SectionAddress	✓	SectionAddress
target.kind	"section"	✓	Constant: "section"
target.sectionId	string	✓

Full reference →

sections.setOddEvenHeadersFooters

editor.doc.sections.setOddEvenHeadersFooters(...)

Field	Type	Req	Description
enabled	boolean	✓

Full reference →

sections.setVerticalAlign

editor.doc.sections.setVerticalAlign(...)

Field	Type	Req	Description
target	SectionAddress	✓	SectionAddress
target.kind	"section"	✓	Constant: "section"
target.sectionId	string	✓
value	”top” | “center” | “bottom” | …	✓	"top", "center", "bottom", "both"

Full reference →

sections.setSectionDirection

editor.doc.sections.setSectionDirection(...)

Field	Type	Req	Description
direction	”ltr” | “rtl”	✓	"ltr", "rtl"
target	SectionAddress	✓	SectionAddress
target.kind	"section"	✓	Constant: "section"
target.sectionId	string	✓

Full reference →

sections.setHeaderFooterRef

editor.doc.sections.setHeaderFooterRef(...)

Field	Type	Req	Description
kind	”header” | “footer”	✓	"header", "footer"
refId	string	✓
target	SectionAddress	✓	SectionAddress
target.kind	"section"	✓	Constant: "section"
target.sectionId	string	✓
variant	”default” | “first” | “even”	✓	"default", "first", "even"

Full reference →

sections.clearHeaderFooterRef

editor.doc.sections.clearHeaderFooterRef(...)

Field	Type	Req	Description
kind	”header” | “footer”	✓	"header", "footer"
target	SectionAddress	✓	SectionAddress
target.kind	"section"	✓	Constant: "section"
target.sectionId	string	✓
variant	”default” | “first” | “even”	✓	"default", "first", "even"

Full reference →

sections.setLinkToPrevious

editor.doc.sections.setLinkToPrevious(...)

Field	Type	Req	Description
kind	”header” | “footer”	✓	"header", "footer"
linked	boolean	✓
target	SectionAddress	✓	SectionAddress
target.kind	"section"	✓	Constant: "section"
target.sectionId	string	✓
variant	”default” | “first” | “even”	✓	"default", "first", "even"

Full reference →

sections.setPageBorders

editor.doc.sections.setPageBorders(...)

Field	Type	Req	Description
borders	any	✓	One of: any, any, any, any, any, any, any
borders.bottom	any		One of: any, any, any, any, any, any
borders.bottom.color	string
borders.bottom.frame	boolean
borders.bottom.shadow	boolean
borders.bottom.size	number
borders.bottom.space	number
borders.bottom.style	string
borders.display	”allPages” | “firstPage” | “notFirstPage”		"allPages", "firstPage", "notFirstPage"
borders.left	any		One of: any, any, any, any, any, any
borders.left.color	string
borders.left.frame	boolean
borders.left.shadow	boolean
borders.left.size	number
borders.left.space	number
borders.left.style	string
borders.offsetFrom	”page” | “text”		"page", "text"
borders.right	any		One of: any, any, any, any, any, any
borders.right.color	string
borders.right.frame	boolean
borders.right.shadow	boolean
borders.right.size	number
borders.right.space	number
borders.right.style	string
borders.top	any		One of: any, any, any, any, any, any
borders.top.color	string
borders.top.frame	boolean
borders.top.shadow	boolean
borders.top.size	number
borders.top.space	number
borders.top.style	string
borders.zOrder	”front” | “back”		"front", "back"
target	SectionAddress	✓	SectionAddress
target.kind	"section"	✓	Constant: "section"
target.sectionId	string	✓

Full reference →

sections.clearPageBorders

editor.doc.sections.clearPageBorders(...)

Field	Type	Req	Description
target	SectionAddress	✓	SectionAddress
target.kind	"section"	✓	Constant: "section"
target.sectionId	string	✓

Full reference →

Selection (1)

selection.current

editor.doc.selection.current(...)

Field	Type	Req	Description
includeText	boolean

Full reference →

Styles (1)

styles.apply

editor.doc.styles.apply(...)

No input fields.

Full reference →

Table of Authorities (11)

authorities.list

editor.doc.authorities.list(...)

Field	Type	Req	Description
limit	integer
offset	integer

Full reference →

authorities.get

editor.doc.authorities.get(...)

Field	Type	Req	Description
target	{ kind: "block", nodeType: "tableOfAuthorities" }	✓
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"tableOfAuthorities"	✓	Constant: "tableOfAuthorities"

Full reference →

authorities.insert

editor.doc.authorities.insert(...)

Field	Type	Req	Description
at	{ kind: "documentStart" } | { kind: "documentEnd" } | { kind: "before" } | { kind: "after" }	✓	One of: object(kind=“documentStart”), object(kind=“documentEnd”), object(kind=“before”), object(kind=“after”)
config	object
config.category	integer
config.entryPageSeparator	string
config.includeHeadings	boolean
config.pageRangeSeparator	string
config.tabLeader	string
config.usePassim	boolean

Full reference →

authorities.configure

editor.doc.authorities.configure(...)

Field	Type	Req	Description
patch	object	✓
patch.category	integer
patch.entryPageSeparator	string
patch.includeHeadings	boolean
patch.pageRangeSeparator	string
patch.tabLeader	string
patch.usePassim	boolean
target	{ kind: "block", nodeType: "tableOfAuthorities" }	✓
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"tableOfAuthorities"	✓	Constant: "tableOfAuthorities"

Full reference →

authorities.rebuild

editor.doc.authorities.rebuild(...)

Field	Type	Req	Description
target	{ kind: "block", nodeType: "tableOfAuthorities" }	✓
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"tableOfAuthorities"	✓	Constant: "tableOfAuthorities"

Full reference →

authorities.remove

editor.doc.authorities.remove(...)

Field	Type	Req	Description
target	{ kind: "block", nodeType: "tableOfAuthorities" }	✓
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"tableOfAuthorities"	✓	Constant: "tableOfAuthorities"

Full reference →

authorities.entries.list

editor.doc.authorities.entries.list(...)

Field	Type	Req	Description
category	string | integer		One of: string, integer
limit	integer
offset	integer

Full reference →

authorities.entries.get

editor.doc.authorities.entries.get(...)

Field	Type	Req	Description
target	{ kind: "inline", nodeType: "authorityEntry" }	✓
target.anchor	InlineAnchor	✓	InlineAnchor
target.anchor.end	Position	✓	Position
target.anchor.end.blockId	string	✓
target.anchor.end.offset	integer	✓
target.anchor.start	Position	✓	Position
target.anchor.start.blockId	string	✓
target.anchor.start.offset	integer	✓
target.kind	"inline"	✓	Constant: "inline"
target.nodeType	"authorityEntry"	✓	Constant: "authorityEntry"

Full reference →

authorities.entries.insert

editor.doc.authorities.entries.insert(...)

Field	Type	Req	Description
at	TextTarget	✓	TextTarget
at.kind	"text"	✓	Constant: "text"
at.segments	TextSegment[]	✓
at.story	StoryLocator		StoryLocator
entry	object	✓
entry.bold	boolean
entry.category	string | integer	✓	One of: string, integer
entry.italic	boolean
entry.longCitation	string	✓
entry.shortCitation	string

Full reference →

authorities.entries.update

editor.doc.authorities.entries.update(...)

Field	Type	Req	Description
patch	object	✓
patch.bold	boolean
patch.category	string | integer		One of: string, integer
patch.italic	boolean
patch.longCitation	string
patch.shortCitation	string
target	{ kind: "inline", nodeType: "authorityEntry" }	✓
target.anchor	InlineAnchor	✓	InlineAnchor
target.anchor.end	Position	✓	Position
target.anchor.end.blockId	string	✓
target.anchor.end.offset	integer	✓
target.anchor.start	Position	✓	Position
target.anchor.start.blockId	string	✓
target.anchor.start.offset	integer	✓
target.kind	"inline"	✓	Constant: "inline"
target.nodeType	"authorityEntry"	✓	Constant: "authorityEntry"

Full reference →

authorities.entries.remove

editor.doc.authorities.entries.remove(...)

Field	Type	Req	Description
target	{ kind: "inline", nodeType: "authorityEntry" }	✓
target.anchor	InlineAnchor	✓	InlineAnchor
target.anchor.end	Position	✓	Position
target.anchor.end.blockId	string	✓
target.anchor.end.offset	integer	✓
target.anchor.start	Position	✓	Position
target.anchor.start.blockId	string	✓
target.anchor.start.offset	integer	✓
target.kind	"inline"	✓	Constant: "inline"
target.nodeType	"authorityEntry"	✓	Constant: "authorityEntry"

Full reference →

Table of Contents (10)

toc.list

editor.doc.toc.list(...)

Field	Type	Req	Description
limit	integer
offset	integer

Full reference →

toc.get

editor.doc.toc.get(...)

Field	Type	Req	Description
target	{ kind: "block", nodeType: "tableOfContents" }	✓
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"tableOfContents"	✓	Constant: "tableOfContents"

Full reference →

toc.configure

editor.doc.toc.configure(...)

Field	Type	Req	Description
patch	object	✓
patch.hideInWebView	boolean
patch.hyperlinks	boolean
patch.includePageNumbers	boolean
patch.omitPageNumberLevels	object
patch.omitPageNumberLevels.from	integer
patch.omitPageNumberLevels.to	integer
patch.outlineLevels	object
patch.outlineLevels.from	integer
patch.outlineLevels.to	integer
patch.rightAlignPageNumbers	boolean
patch.separator	string
patch.tabLeader	”none” | “dot” | “hyphen” | …		"none", "dot", "hyphen", "underscore", "middleDot"
patch.tcFieldIdentifier	string
patch.tcFieldLevels	object
patch.tcFieldLevels.from	integer
patch.tcFieldLevels.to	integer
patch.useAppliedOutlineLevel	boolean
target	{ kind: "block", nodeType: "tableOfContents" }	✓
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"tableOfContents"	✓	Constant: "tableOfContents"

Full reference →

toc.update

editor.doc.toc.update(...)

Field	Type	Req	Description
mode	”all” | “pageNumbers”		"all", "pageNumbers"
target	{ kind: "block", nodeType: "tableOfContents" }	✓
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"tableOfContents"	✓	Constant: "tableOfContents"

Full reference →

toc.remove

editor.doc.toc.remove(...)

Field	Type	Req	Description
target	{ kind: "block", nodeType: "tableOfContents" }	✓
target.kind	"block"	✓	Constant: "block"
target.nodeId	string	✓
target.nodeType	"tableOfContents"	✓	Constant: "tableOfContents"

Full reference →

toc.markEntry

editor.doc.toc.markEntry(...)

Field	Type	Req	Description
level	integer
omitPageNumber	boolean
tableIdentifier	string
target	{ kind: "inline-insert" }	✓
target.anchor	{ nodeType: "paragraph" }	✓
target.anchor.nodeId	string	✓
target.anchor.nodeType	"paragraph"	✓	Constant: "paragraph"
target.kind	"inline-insert"	✓	Constant: "inline-insert"
target.position	”start” | “end”		"start", "end"
text	string	✓

Full reference →

toc.unmarkEntry

editor.doc.toc.unmarkEntry(...)

Field	Type	Req	Description
target	{ kind: "inline", nodeType: "tableOfContentsEntry" }	✓
target.kind	"inline"	✓	Constant: "inline"
target.nodeId	string	✓
target.nodeType	"tableOfContentsEntry"	✓	Constant: "tableOfContentsEntry"

Full reference →

toc.listEntries

editor.doc.toc.listEntries(...)

Field	Type	Req	Description
levelRange	object
levelRange.from	integer
levelRange.to	integer
limit	integer
offset	integer
tableIdentifier	string

Full reference →

toc.getEntry

editor.doc.toc.getEntry(...)

Field	Type	Req	Description
target	{ kind: "inline", nodeType: "tableOfContentsEntry" }	✓
target.kind	"inline"	✓	Constant: "inline"
target.nodeId	string	✓
target.nodeType	"tableOfContentsEntry"	✓	Constant: "tableOfContentsEntry"

Full reference →

toc.editEntry

editor.doc.toc.editEntry(...)

Field	Type	Req	Description
patch	object	✓
patch.level	integer
patch.omitPageNumber	boolean
patch.tableIdentifier	string
patch.text	string
target	{ kind: "inline", nodeType: "tableOfContentsEntry" }	✓
target.kind	"inline"	✓	Constant: "inline"
target.nodeId	string	✓
target.nodeType	"tableOfContentsEntry"	✓	Constant: "tableOfContentsEntry"

Full reference →

Tables (47)

tables.convertFromText

editor.doc.tables.convertFromText(...)

Field	Type	Req	Description
columns	integer
delimiter	”tab” | “comma” | “paragraph” | object		One of: enum, object
inferColumns	boolean
nodeId	string
target	BlockNodeAddress		BlockNodeAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	”paragraph” | “heading” | “listItem” | …		"paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt"

Full reference →

tables.delete

editor.doc.tables.delete(...)

Field	Type	Req	Description
nodeId	string
target	TableAddress		TableAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"table"		Constant: "table"

Full reference →

tables.clearContents

editor.doc.tables.clearContents(...)

Field	Type	Req	Description
nodeId	string
target	TableAddress		TableAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"table"		Constant: "table"

Full reference →

tables.move

editor.doc.tables.move(...)

Field	Type	Req	Description
destination	{ kind: "documentStart" } | { kind: "documentEnd" } | { kind: "before" } | { kind: "after" }	✓	One of: object(kind=“documentStart”), object(kind=“documentEnd”), object(kind=“before”), object(kind=“after”), object(kind=“before”), object(kind=“after”)
nodeId	string
target	TableAddress		TableAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"table"		Constant: "table"

Full reference →

tables.split

editor.doc.tables.split(...)

Field	Type	Req	Description
nodeId	string
rowIndex	integer	✓
target	TableAddress		TableAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"table"		Constant: "table"

Full reference →

tables.convertToText

editor.doc.tables.convertToText(...)

Field	Type	Req	Description
delimiter	”tab” | “comma” | “paragraph”		"tab", "comma", "paragraph"
nodeId	string
target	TableAddress		TableAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"table"		Constant: "table"

Full reference →

tables.setLayout

editor.doc.tables.setLayout(...)

Field	Type	Req	Description
alignment	”left” | “center” | “right”		"left", "center", "right"
autoFitMode	”fixedWidth” | “fitContents” | “fitWindow”		"fixedWidth", "fitContents", "fitWindow"
leftIndentPt	number
nodeId	string
preferredWidth	number
tableDirection	”ltr” | “rtl”		"ltr", "rtl"
target	TableAddress		TableAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"table"		Constant: "table"

Full reference →

tables.insertRow

editor.doc.tables.insertRow(...)

No input fields.

Full reference →

tables.deleteRow

editor.doc.tables.deleteRow(...)

No input fields.

Full reference →

tables.setRowHeight

editor.doc.tables.setRowHeight(...)

No input fields.

Full reference →

tables.distributeRows

editor.doc.tables.distributeRows(...)

Field	Type	Req	Description
nodeId	string
target	TableAddress		TableAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"table"		Constant: "table"

Full reference →

tables.setRowOptions

editor.doc.tables.setRowOptions(...)

No input fields.

Full reference →

tables.insertColumn

editor.doc.tables.insertColumn(...)

Field	Type	Req	Description
columnIndex	integer
count	integer
nodeId	string
position	”left” | “right” | “first” | …	✓	"left", "right", "first", "last"
target	TableAddress		TableAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"table"		Constant: "table"

Full reference →

tables.deleteColumn

editor.doc.tables.deleteColumn(...)

Field	Type	Req	Description
columnIndex	integer	✓
nodeId	string
target	TableAddress		TableAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"table"		Constant: "table"

Full reference →

tables.setColumnWidth

editor.doc.tables.setColumnWidth(...)

Field	Type	Req	Description
columnIndex	integer	✓
nodeId	string
target	TableAddress		TableAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"table"		Constant: "table"
widthPt	number	✓

Full reference →

tables.distributeColumns

editor.doc.tables.distributeColumns(...)

Field	Type	Req	Description
columnRange	object
columnRange.end	integer
columnRange.start	integer
nodeId	string
target	TableAddress		TableAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"table"		Constant: "table"

Full reference →

tables.insertCell

editor.doc.tables.insertCell(...)

Field	Type	Req	Description
mode	”shiftRight” | “shiftDown”	✓	"shiftRight", "shiftDown"
nodeId	string
target	TableCellAddress		TableCellAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"tableCell"		Constant: "tableCell"

Full reference →

tables.deleteCell

editor.doc.tables.deleteCell(...)

Field	Type	Req	Description
mode	”shiftLeft” | “shiftUp”	✓	"shiftLeft", "shiftUp"
nodeId	string
target	TableCellAddress		TableCellAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"tableCell"		Constant: "tableCell"

Full reference →

tables.mergeCells

editor.doc.tables.mergeCells(...)

Field	Type	Req	Description
end	object	✓
end.columnIndex	integer	✓
end.rowIndex	integer	✓
nodeId	string
start	object	✓
start.columnIndex	integer	✓
start.rowIndex	integer	✓
target	TableAddress		TableAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"table"		Constant: "table"

Full reference →

tables.unmergeCells

editor.doc.tables.unmergeCells(...)

No input fields.

Full reference →

tables.splitCell

editor.doc.tables.splitCell(...)

Field	Type	Req	Description
columns	integer	✓
nodeId	string
rows	integer	✓
target	TableCellAddress		TableCellAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"tableCell"		Constant: "tableCell"

Full reference →

tables.setCellProperties

editor.doc.tables.setCellProperties(...)

Field	Type	Req	Description
fitText	boolean
nodeId	string
preferredWidthPt	number
target	TableCellAddress		TableCellAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"tableCell"		Constant: "tableCell"
verticalAlign	”top” | “center” | “bottom”		"top", "center", "bottom"
wrapText	boolean

Full reference →

tables.setCellText

editor.doc.tables.setCellText(...)

No input fields.

Full reference →

tables.sort

editor.doc.tables.sort(...)

Field	Type	Req	Description
keys	object[]	✓
nodeId	string
target	TableAddress		TableAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"table"		Constant: "table"

Full reference →

tables.setAltText

editor.doc.tables.setAltText(...)

Field	Type	Req	Description
description	string
nodeId	string
target	TableAddress		TableAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"table"		Constant: "table"
title	string

Full reference →

tables.setStyle

editor.doc.tables.setStyle(...)

Field	Type	Req	Description
nodeId	string
styleId	string	✓
target	TableAddress		TableAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"table"		Constant: "table"

Full reference →

tables.clearStyle

editor.doc.tables.clearStyle(...)

Field	Type	Req	Description
nodeId	string
target	TableAddress		TableAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"table"		Constant: "table"

Full reference →

tables.setStyleOption

editor.doc.tables.setStyleOption(...)

Field	Type	Req	Description
enabled	boolean	✓
flag	”headerRow” | “lastRow” | “totalRow” | …	✓	"headerRow", "lastRow", "totalRow", "firstColumn", "lastColumn", "bandedRows", "bandedColumns"
nodeId	string
target	TableAddress		TableAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"table"		Constant: "table"

Full reference →

tables.setBorder

editor.doc.tables.setBorder(...)

Field	Type	Req	Description
color	string	✓
edge	”top” | “bottom” | “left” | …	✓	"top", "bottom", "left", "right", "insideH", "insideV", "diagonalDown", "diagonalUp"
lineStyle	string	✓
lineWeightPt	number	✓
nodeId	string
target	TableOrCellAddress		TableOrCellAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	”table” | “tableCell”		"table", "tableCell"

Full reference →

tables.clearBorder

editor.doc.tables.clearBorder(...)

Field	Type	Req	Description
edge	”top” | “bottom” | “left” | …	✓	"top", "bottom", "left", "right", "insideH", "insideV", "diagonalDown", "diagonalUp"
nodeId	string
target	TableOrCellAddress		TableOrCellAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	”table” | “tableCell”		"table", "tableCell"

Full reference →

tables.applyBorderPreset

editor.doc.tables.applyBorderPreset(...)

Field	Type	Req	Description
nodeId	string
preset	”box” | “all” | “none” | …	✓	"box", "all", "none", "grid", "custom"
target	TableAddress		TableAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"table"		Constant: "table"

Full reference →

tables.setShading

editor.doc.tables.setShading(...)

Field	Type	Req	Description
color	string | null	✓	One of: string, null
nodeId	string
target	TableOrCellAddress		TableOrCellAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	”table” | “tableCell”		"table", "tableCell"

Full reference →

tables.clearShading

editor.doc.tables.clearShading(...)

Field	Type	Req	Description
nodeId	string
target	TableOrCellAddress		TableOrCellAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	”table” | “tableCell”		"table", "tableCell"

Full reference →

tables.setTablePadding

editor.doc.tables.setTablePadding(...)

Field	Type	Req	Description
bottomPt	number	✓
leftPt	number	✓
nodeId	string
rightPt	number	✓
target	TableAddress		TableAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"table"		Constant: "table"
topPt	number	✓

Full reference →

tables.setCellPadding

editor.doc.tables.setCellPadding(...)

Field	Type	Req	Description
bottomPt	number	✓
leftPt	number	✓
nodeId	string
rightPt	number	✓
target	TableCellAddress		TableCellAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"tableCell"		Constant: "tableCell"
topPt	number	✓

Full reference →

tables.setCellSpacing

editor.doc.tables.setCellSpacing(...)

Field	Type	Req	Description
nodeId	string
spacingPt	number	✓
target	TableAddress		TableAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"table"		Constant: "table"

Full reference →

tables.clearCellSpacing

editor.doc.tables.clearCellSpacing(...)

Field	Type	Req	Description
nodeId	string
target	TableAddress		TableAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"table"		Constant: "table"

Full reference →

tables.applyStyle

editor.doc.tables.applyStyle(...)

Field	Type	Req	Description
nodeId	string
styleId	string
styleOptions	object
styleOptions.bandedColumns	boolean
styleOptions.bandedRows	boolean
styleOptions.firstColumn	boolean
styleOptions.headerRow	boolean
styleOptions.lastColumn	boolean
styleOptions.lastRow	boolean
styleOptions.totalRow	boolean
target	BlockNodeAddress		BlockNodeAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	”paragraph” | “heading” | “listItem” | …		"paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt"

Full reference →

tables.setBorders

editor.doc.tables.setBorders(...)

No input fields.

Full reference →

tables.setTableOptions

editor.doc.tables.setTableOptions(...)

Field	Type	Req	Description
cellSpacingPt	number | null		One of: number, null
defaultCellMargins	object
defaultCellMargins.bottomPt	number
defaultCellMargins.leftPt	number
defaultCellMargins.rightPt	number
defaultCellMargins.topPt	number
nodeId	string
target	BlockNodeAddress		BlockNodeAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	”paragraph” | “heading” | “listItem” | …		"paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt"

Full reference →

tables.applyPreset

editor.doc.tables.applyPreset(...)

Field	Type	Req	Description
accentColor	string
nodeId	string
preset	”grid” | “minimal” | “striped” | …	✓	"grid", "minimal", "striped", "accent"
target	TableAddress		TableAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"table"		Constant: "table"

Full reference →

tables.get

editor.doc.tables.get(...)

Field	Type	Req	Description
nodeId	string
target	TableAddress		TableAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"table"		Constant: "table"

Full reference →

tables.getCells

editor.doc.tables.getCells(...)

Field	Type	Req	Description
columnIndex	integer
nodeId	string
rowIndex	integer
target	TableAddress		TableAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"table"		Constant: "table"

Full reference →

tables.getProperties

editor.doc.tables.getProperties(...)

Field	Type	Req	Description
nodeId	string
target	TableAddress		TableAddress
target.kind	"block"		Constant: "block"
target.nodeId	string
target.nodeType	"table"		Constant: "table"

Full reference →

tables.getStyles

editor.doc.tables.getStyles(...)

No input fields.

Full reference →

tables.setDefaultStyle

editor.doc.tables.setDefaultStyle(...)

Field	Type	Req	Description
styleId	string	✓

Full reference →

tables.clearDefaultStyle

editor.doc.tables.clearDefaultStyle(...)

No input fields.

Full reference →

Templates (1)

templates.apply

editor.doc.templates.apply(...)

Field	Type	Req	Description
bodyPolicy	"preserve"		Constant: "preserve"
source	{ kind: "path" } | { kind: "base64" }	✓	One of: object(kind=“path”), object(kind=“base64”)

Full reference →

Track Changes (3)

trackChanges.list

editor.doc.trackChanges.list(...)

Field	Type	Req	Description
in	StoryLocator | "all"		One of: StoryLocator, "all"
limit	integer
offset	integer
type	”insert” | “delete” | “replacement” | …		"insert", "delete", "replacement", "format"

Full reference →

trackChanges.get

editor.doc.trackChanges.get(...)

Field	Type	Req	Description
id	string	✓
story	StoryLocator		StoryLocator

Full reference →

trackChanges.decide

editor.doc.trackChanges.decide(...)

Field	Type	Req	Description
decision	”accept” | “reject”	✓	"accept", "reject"
target	object | { kind: "range" }	✓	One of: object, object(kind=“range”), object

Full reference →