afterOverlay | (() => void) | null | Runs after each overlay paint: a drag puts its frame back on the pointer. |
busy | boolean | |
canMerge | boolean | |
canRedo | boolean | |
canUndo | boolean | |
chartSheetOpen | boolean | Word’s Edit Data: the chart’s workbook beside the pages, shown while a chart is selected. |
controls | ContentControlsModel | |
customizableKeys | boolean | read-only False: the host turned the Keyboard Shortcuts window off. |
drawingGrid | boolean | View > Gridlines, the drawing grid; set through setDrawingGrid. |
error | string | null | |
find | FindModel | |
fonts | Pick<FaceProvider, “fetch” | “bytes”> | read-only |
format | FormatState | null | |
gridlines | boolean | View Gridlines; set through setGridlines. |
historyTurns | number | Counts undo and redo, so an open data window reloads what they put back. |
host | BrowserEditorHost | null | |
hover | StoryHit | null | The closed header/footer under the pointer; its band is hinted so a double-click has a target. |
i18n | EditorI18n | The editor’s language, from the locale and messages it was made with. |
inputEl | HTMLElement | null | |
inspectorVisible | boolean | The format panel beside the pages: borders, shading, padding, row flow. |
ir | LayoutDocument | null | |
keys | DocxKeymap | read-only Every key’s command; hosts and users rebind them here. |
licenseError | string | null | Set once the package refused to open documents; the empty stage shows it instead of a drop target. |
links | LinkHandlers | Hooks on link clicks and link hover; replace them at any time. |
locked | boolean | Another writer owns the session (an agent turn); commands are dropped until it is done. |
markup | Markup | Word’s Display for Review; a new document opens in All Markup. |
memory | EditMemory | Repeat, Go Back and the format painter’s copied formatting. |
modifyPrompt | ModifyPrompt | null | Set when an opened file carries a password to modify or read-only recommended; answer with answerModify. |
name | string | |
nav | NavModel | Word’s Navigation pane: the heading outline and find, in one left panel. |
notice | string | null | Transient progress line, e.g. while an image decodes. |
opening | boolean | |
openPassword | string | null | File > Passwords: a save encrypts with it. Kept from the password the file opened with. |
outline | OutlineView | null | Word’s Outline view (View > Outline); null lays the pages. |
overlayTick | number | Bumps whenever the overlay is repainted or the pages scroll; anchored chrome follows it. |
page | number | The page most in view, 1-based; 0 before a document is open. |
pageLabel | string | |
pagesEl | HTMLElement | null | |
passwordPrompt | PasswordPrompt | null | Set when open met an encrypted file: answer with unlock or cancelUnlock. |
peerColor | (name: string) => string | The colour of a writer’s caret and range; LiveOptions.peerColor sets it. |
peers | PeerCursor[] | Other writers’ selections, painted over the pages in a shared session. |
pointing | boolean | True while a pointer drag that selects text is held down. |
previewer | DocumentPreviewer | null | |
previewing | boolean | Pages of the document still opening are on screen, read-only. |
progress | ProgressView | null | Phase block over the stage while a document opens; null when idle. |
readOnly | boolean | A reader’s view: the caret moves, text selects, Find and Copy work; every edit is dropped. |
review | ReviewModel | |
revisionAuthor | string | The name new tracked changes and comments carry; the session’s default until one is set. |
rulerVisible | boolean | Word’s View › Ruler. |
scheme | ”light” | “dark” | Page ink on screen; exports always paint light. |
selection | Selection | null | |
spell | SpellModel | read-only |
story | StoryHit | null | |
suggesting | boolean | |
suggestingPolicy | SuggestingPolicy | Whether the user may switch Suggesting; “off” and “on” also win over the file’s own setting. |
toolbarItems | ToolbarItems | Controls the built-in format bar leaves off or adds; assign a new object to change it. |
transport | EditorTransport | read-only |
ui | EditorUi | read-only Menu, dialogs and other chrome state scoped to this editor. |
version | number | Bumps on every change of this object or an adopted child. |
zoom | number | CSS px per page px at the current zoom; 1 is 100%. |
zoomMode | ZoomMode | What the host asked for: a scale, or “fit”/“page” that follow the window. |
openTextbox | PictureHit & { owner: StoryHit | undefined } | null | read-only The text box being typed in, as a shape with a frame and handles. |
overlays | PageOverlays | read-only Host nodes pinned to pages in points; they survive scroll, zoom and relayout. |
picture | PictureHit | null | read-only The picture the selection addresses, straight off the IR. |
scope | IndexScope | undefined | read-only |