Skip to content
SumOfficeSumOfficeSumOffice
Menu
What SumOffice isProduct and deliveryAI and MCPContact us
Overview
SumDoc — what it isWhat SumDoc can do with a documentArchitecture: objects and relationshipsDocument lifecyclePlatforms and deploymentResponsibility and security
Getting started
Installation and verificationQuick start: your first JSONL sessionDiagnostics and checklist
Guides
Request and response objectsThe same contract over WebSocketStarting Web SurfaceEditor in the browser: embedding through iframeEmbedding SurfaceDocument structure: how to get itHit-testing by coordinate, selection, and document editsIntegration recipesHost API: commands, events, and agentsInternal objects of the SumDoc application window
Examples
Live example: editor in the browserSumDoc examples
Contract and boundaries
Interaction contract for a pilotReadiness and boundariesWhere to start the pilotSumDoc version history
Reference
SumDoc referenceSumDoc session and conventionsSumDoc transport and message formatRust Session Protocol — 41 commandsTyped editing typesBrowser surface interface (Browser Surface API)window.fastdocShell · documentwindow.fastdocShell · editwindow.fastdocShell · reviewwindow.fastdocShell · viewwindow.fastdocShell · marketwindow.fastdocShell · smokewindow.fastdocShell · other methodsEvents between the application and the editorDTO · api-document.tsDTO · Text and paragraphsDTO · Tables: structureDTO · Tables: cells and formattingDTO · Tables: placement on the pageDTO · Page setup and document structureDTO · Objects and drawingsDTO · Fields, footnotes, and referencesDTO · api-market.tsDTO · api-quick-parts.tsDTO · api-review.tsDTO · api-smoke.tsDTO · api-view.tsSession types in TypeScriptMissing APIs and compatibility

DTO · Tables: structure

60 interfaces and 14 type aliases from the `api-edit.ts` module — creating tables, rows and columns, selection, and grid editing.

60 interfaces and 14 type aliases — creating tables, rows and columns, selection, and grid editing.

Contract module: api-edit.ts.

Other topics in this module: Text and paragraphs · Tables: structure · Tables: cells and formatting · Tables: placement on the page · Page setup and document structure · Objects and drawings · Fields, footnotes, and references.

Types on this page — 74

D37TableRangeRequest

Section titled “D37TableRangeRequest”

InterfaceDeclaration · api-edit.ts

interface D37TableRangeRequest {
  bodyBlockIndex: number;
  rowIndex: number;
  columnIndex: number;
  rowCount: number;
  columnCount: number;
  clipboardText?: string;
  clipboardHtml?: string;
  trackRevisions?: boolean;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

D37TableRangeResult

Section titled “D37TableRangeResult”

InterfaceDeclaration · api-edit.ts

interface D37TableRangeResult {
  schema: "fastdoc.shell.d37-table-range-clipboard.v1";
  operationKind: "copy-table-cell-text-range" | "paste-table-cell-text-into-range";
  applied: boolean;
  documentPath: string | null;
  outputPath: string | null;
  clipboardText: string | null;
  clipboardHtml: string | null;
  range: {
    bodyBlockIndex: number;
    rowIndex: number;
    columnIndex: number;
    rowCount: number;
    columnCount: number;
  };
  resultKind: string | null;
  writebackResultKind: string | null;
  snapshot: unknown;
}

D37TableCreateRequest

Section titled “D37TableCreateRequest”

InterfaceDeclaration · api-edit.ts

interface D37TableCreateRequest {
  bodyBlockIndex: number;
  clipboardText?: string;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

D37TableCreateResult

Section titled “D37TableCreateResult”

InterfaceDeclaration · api-edit.ts

interface D37TableCreateResult {
  schema: "fastdoc.shell.d37-table-create-clipboard.v1";
  operationKind: "create-simple-table-from-clipboard";
  applied: boolean;
  documentPath: string | null;
  outputPath: string | null;
  clipboardText: string | null;
  bodyBlockIndex: number;
  resultKind: string | null;
  writebackResultKind: string | null;
  snapshot: unknown;
}

D37TableGridCreateRequest

Section titled “D37TableGridCreateRequest”

InterfaceDeclaration · api-edit.ts

interface D37TableGridCreateRequest {
  bodyBlockIndex: number;
  targetKind?: "body-block" | "table-cell";
  rowIndex?: number | null;
  columnIndex?: number | null;
  rowCount: number;
  columnCount: number;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

D37TableGridCreateResult

Section titled “D37TableGridCreateResult”

InterfaceDeclaration · api-edit.ts

interface D37TableGridCreateResult {
  schema: "fastdoc.shell.d37-table-create-grid.v1";
  operationKind: "create-simple-table" | "create-nested-simple-table";
  applied: boolean;
  documentPath: string | null;
  outputPath: string | null;
  bodyBlockIndex: number;
  targetKind: "body-block" | "table-cell";
  rowIndex: number | null;
  columnIndex: number | null;
  rowCount: number;
  columnCount: number;
  resultKind: string | null;
  writebackResultKind: string | null;
  snapshot: unknown;
}

EditorV0ConvertTextToTableRequest

Section titled “EditorV0ConvertTextToTableRequest”

InterfaceDeclaration · api-edit.ts

interface EditorV0ConvertTextToTableRequest {
  bodyBlockIndex: number;
  clipboardText: string;
  separator: "paragraphs" | "tabs" | "semicolons" | `other:${string}`;
  columnCount: number;
  autofitMode: "fixed-auto" | "fixed" | "contents" | "window";
  fixedColumnWidthTwips?: number | null;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0ConvertTextToTableResult

Section titled “EditorV0ConvertTextToTableResult”

InterfaceDeclaration · api-edit.ts

interface EditorV0ConvertTextToTableResult {
  schema: "fastdoc.shell.editor-v0-convert-text-to-table.v1";
  operationKind: "convert-text-to-table";
  applied: boolean;
  documentPath: string | null;
  outputPath: string | null;
  transientWrite?: boolean;
  clipboardText: string | null;
  bodyBlockIndex: number;
  rowCount: number | null;
  columnCount: number | null;
  spanCount: number | null;
  separator: string;
  autofitMode: string;
  fixedColumnWidthTwips: number | null;
  resultKind: string | null;
  writebackResultKind: string | null;
  snapshot: unknown;
}

D37AnyTableCreateResult

Section titled “D37AnyTableCreateResult”

TypeAliasDeclaration · api-edit.ts

type D37AnyTableCreateResult = D37TableCreateResult | D37TableGridCreateResult;

EditorV0InsertTableCaptionRequest

Section titled “EditorV0InsertTableCaptionRequest”

InterfaceDeclaration · api-edit.ts

interface EditorV0InsertTableCaptionRequest {
  bodyBlockIndex: number;
  label?: string | null;
  captionText?: string | null;
  captionPosition?: string | null;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0UpdateTableRequest

Section titled “EditorV0UpdateTableRequest”

InterfaceDeclaration · api-edit.ts

interface EditorV0UpdateTableRequest {
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0TableOfFiguresRequest

Section titled “EditorV0TableOfFiguresRequest”

InterfaceDeclaration · api-edit.ts

interface EditorV0TableOfFiguresRequest {
  captionLabel?: string | null;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

EditorV0InsertTableCaptionResult

Section titled “EditorV0InsertTableCaptionResult”

InterfaceDeclaration · api-edit.ts

interface EditorV0InsertTableCaptionResult {
  schema: "fastdoc.shell.editor-v0-insert-table-caption-action.v1";
  operationKind: "insert-table-caption";
  applied: boolean;
  documentPath: string | null;
  outputPath: string | null;
  bodyBlockIndex: number;
  label: string;
  captionText: string;
  captionPosition: string;
  resultKind: string | null;
  writebackResultKind: string | null;
  writebackChangedPartCount: number | null;
  snapshot: unknown;
  popupWarningShown: false;
  technicalPanelAdded: false;
  wordParityClaim: false;
  pixelParityClaim: false;
  muscleMemoryParityClaim: false;
}

EditorV0UpdateTableResult

Section titled “EditorV0UpdateTableResult”

InterfaceDeclaration · api-edit.ts

interface EditorV0UpdateTableResult {
  schema: "fastdoc.shell.editor-v0-update-table-action.v1";
  operationKind: "update-toc";
  applied: boolean;
  documentPath: string | null;
  outputPath: string | null;
  documentPathAfterReopen: string | null;
  currentDocumentReopened: boolean;
  currentResultText: string | null;
  updatedResultText: string | null;
  resultKind: string | null;
  writebackResultKind: string | null;
  writebackChangedPartCount: number | null;
  snapshot: unknown;
  popupWarningShown: false;
  technicalPanelAdded: false;
  wordParityClaim: false;
  pixelParityClaim: false;
  muscleMemoryParityClaim: false;
}

EditorV0TableOfFiguresResult

Section titled “EditorV0TableOfFiguresResult”

InterfaceDeclaration · api-edit.ts

interface EditorV0TableOfFiguresResult {
  schema: "fastdoc.shell.editor-v0-table-of-figures-action.v1";
  operationKind: "insert-table-of-figures";
  applied: boolean;
  documentPath: string | null;
  outputPath: string | null;
  documentPathAfterReopen: string | null;
  currentDocumentReopened: boolean;
  captionLabel: string | null;
  captionCount: number | null;
  existingTableOfFiguresCount: number | null;
  insertedInstructionText: string | null;
  insertedResultText: string | null;
  resultKind: string | null;
  writebackResultKind: string | null;
  writebackChangedPartCount: number | null;
  snapshot: unknown;
  popupWarningShown: false;
  technicalPanelAdded: false;
  wordParityClaim: false;
  pixelParityClaim: false;
  muscleMemoryParityClaim: false;
}

EditorV0UpdateTableOfFiguresResult

Section titled “EditorV0UpdateTableOfFiguresResult”

InterfaceDeclaration · api-edit.ts

interface EditorV0UpdateTableOfFiguresResult {
  schema: "fastdoc.shell.editor-v0-update-table-of-figures-action.v1";
  operationKind: "update-table-of-figures";
  applied: boolean;
  documentPath: string | null;
  outputPath: string | null;
  documentPathAfterReopen: string | null;
  currentDocumentReopened: boolean;
  captionLabel: string | null;
  captionCount: number | null;
  existingTableOfFiguresCount: number | null;
  currentResultText: string | null;
  updatedResultText: string | null;
  resultKind: string | null;
  writebackResultKind: string | null;
  writebackChangedPartCount: number | null;
  snapshot: unknown;
  popupWarningShown: false;
  technicalPanelAdded: false;
  wordParityClaim: false;
  pixelParityClaim: false;
  muscleMemoryParityClaim: false;
}

D37TableMouseDrawSemanticRequest

Section titled “D37TableMouseDrawSemanticRequest”

InterfaceDeclaration · api-edit.ts

interface D37TableMouseDrawSemanticRequest {
  bodyBlockIndex: number;
  rowCount: number;
  columnCount: number;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

D37TableMouseDrawSemanticResult

Section titled “D37TableMouseDrawSemanticResult”

InterfaceDeclaration · api-edit.ts

interface D37TableMouseDrawSemanticResult {
  schema: "fastdoc.shell.d37-table-mouse-draw-semantic.v1";
  operationKind: "create-drawn-simple-table";
  applied: boolean;
  documentPath: string | null;
  outputPath: string | null;
  bodyBlockIndex: number;
  rowCount: number | null;
  columnCount: number | null;
  requestedRowCount: number;
  requestedColumnCount: number;
  tableInputProvenance: string | null;
  resultKind: string | null;
  writebackResultKind: string | null;
  mutatedTableCount: number | null;
  snapshot: unknown;
}

D37TableSelectionResizeAxis

Section titled “D37TableSelectionResizeAxis”

TypeAliasDeclaration · api-edit.ts

type D37TableSelectionResizeAxis = "column-width" | "row-height";

D37TableSelectionResizeEdge

Section titled “D37TableSelectionResizeEdge”

TypeAliasDeclaration · api-edit.ts

type D37TableSelectionResizeEdge = "left" | "right" | "bottom";

D37TableSelectionResizeRange

Section titled “D37TableSelectionResizeRange”

InterfaceDeclaration · api-edit.ts

interface D37TableSelectionResizeRange {
  bodyBlockIndex: number;
  rowIndex: number;
  columnIndex: number;
  rowCount: number;
  columnCount: number;
}

D37TableSelectionResizeRequest

Section titled “D37TableSelectionResizeRequest”

InterfaceDeclaration · api-edit.ts

interface D37TableSelectionResizeRequest {
  selection: D37TableSelectionResizeRange;
  resizeAxis: D37TableSelectionResizeAxis;
  resizeEdge?: D37TableSelectionResizeEdge | null;
  startDimensionTwips: number;
  deltaTwips: number;
  minDimensionTwips?: number | null;
  maxDimensionTwips?: number | null;
  tableWidthTwips?: number | null;
  tableIndentTwips?: number | null;
  tableAlignment?: "left" | "center" | "right" | null;
  pairedColumnIndex?: number | null;
  pairedColumnWidthTwips?: number | null;
  startDimensionSource?: string | null;
  rowHeightRule?: "exact" | "atLeast" | "at_least" | "auto" | "automatic" | null;
  workflowSource?: "keyboard-nudge" | null;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

D37TableSelectionResizeCommandState

Section titled “D37TableSelectionResizeCommandState”

InterfaceDeclaration · api-edit.ts

interface D37TableSelectionResizeCommandState {
  operationKind: "set-table-column-width" | "set-table-row-height";
  targetRowIndex: number | null;
  targetColumnIndex: number | null;
  startDimensionTwips: number;
  deltaTwips: number;
  requestedDimensionTwips: number;
  clampedDimensionTwips: number;
  minDimensionTwips: number;
  maxDimensionTwips: number;
  tableWidthTwips: number | null;
  tableIndentTwips: number | null;
  tableAlignment: "left" | "center" | "right" | null;
  pairedColumnIndex: number | null;
  pairedColumnWidthTwips: number | null;
  startDimensionSource: string | null;
  rowHeightRule: string | null;
  workflowSource: string | null;
}

D37TableSelectionResizeResult

Section titled “D37TableSelectionResizeResult”

InterfaceDeclaration · api-edit.ts

interface D37TableSelectionResizeResult {
  schema: "fastdoc.shell.d37-table-selection-resize.v1";
  resizeAxis: D37TableSelectionResizeAxis;
  resizeEdge: D37TableSelectionResizeEdge;
  selection: D37TableSelectionResizeRange;
  computedCommandState: D37TableSelectionResizeCommandState;
  dimensionsResult: D37TableDimensionsResult;
}

D37TableTemplateRequest

Section titled “D37TableTemplateRequest”

InterfaceDeclaration · api-edit.ts

interface D37TableTemplateRequest {
  bodyBlockIndex: number;
  templateKind?: "banded-blue" | null;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

D37TableTemplateResult

Section titled “D37TableTemplateResult”

InterfaceDeclaration · api-edit.ts

interface D37TableTemplateResult {
  schema: "fastdoc.shell.d37-table-template-format.v1";
  operationKind: "apply-table-template-banded-blue";
  applied: boolean;
  documentPath: string | null;
  outputPath: string | null;
  bodyBlockIndex: number;
  templateKind: "banded-blue";
  resultKind: string | null;
  writebackResultKind: string | null;
  rowCount: number | null;
  columnCount: number | null;
  snapshot: unknown;
}

D37TableHeaderRowMode

Section titled “D37TableHeaderRowMode”

TypeAliasDeclaration · api-edit.ts

type D37TableHeaderRowMode = "set";

D37TableHeaderRowRequest

Section titled “D37TableHeaderRowRequest”

InterfaceDeclaration · api-edit.ts

interface D37TableHeaderRowRequest {
  bodyBlockIndex: number;
  headerRowMode?: D37TableHeaderRowMode | null;
  styleOptions?: D37TableStyleOptions | null;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

D37TableHeaderRowResult

Section titled “D37TableHeaderRowResult”

InterfaceDeclaration · api-edit.ts

interface D37TableHeaderRowResult {
  schema: "fastdoc.shell.d37-table-header-row.v1";
  operationKind: "set-table-header-row";
  applied: boolean;
  documentPath: string | null;
  outputPath: string | null;
  bodyBlockIndex: number;
  headerRowMode: D37TableHeaderRowMode;
  styleOptions: D37TableStyleOptions | null;
  resultKind: string | null;
  writebackResultKind: string | null;
  rowCount: number | null;
  columnCount: number | null;
  snapshot: unknown;
}

D37TableHeaderRepeatMode

Section titled “D37TableHeaderRepeatMode”

TypeAliasDeclaration · api-edit.ts

type D37TableHeaderRepeatMode = "repeat" | "clear";

D37TableHeaderRepeatRequest

Section titled “D37TableHeaderRepeatRequest”

InterfaceDeclaration · api-edit.ts

interface D37TableHeaderRepeatRequest {
  bodyBlockIndex: number;
  repeatMode?: D37TableHeaderRepeatMode | null;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

D37TableHeaderRepeatResult

Section titled “D37TableHeaderRepeatResult”

InterfaceDeclaration · api-edit.ts

interface D37TableHeaderRepeatResult {
  schema: "fastdoc.shell.d37-table-header-repeat.v1";
  operationKind: "repeat-table-header-row" | "clear-repeat-table-header-row";
  applied: boolean;
  documentPath: string | null;
  outputPath: string | null;
  bodyBlockIndex: number;
  repeatMode: D37TableHeaderRepeatMode;
  resultKind: string | null;
  writebackResultKind: string | null;
  rowCount: number | null;
  columnCount: number | null;
  snapshot: unknown;
}

D37TableDataCommandKind

Section titled “D37TableDataCommandKind”

TypeAliasDeclaration · api-edit.ts

type D37TableDataCommandKind = "sort-table-ascending" | "convert-table-to-text";

D37TableTextSeparator

Section titled “D37TableTextSeparator”

TypeAliasDeclaration · api-edit.ts

type D37TableTextSeparator = "paragraphs" | "tabs" | "semicolons" | "other";

D37TableSortValueType

Section titled “D37TableSortValueType”

TypeAliasDeclaration · api-edit.ts

type D37TableSortValueType = "text" | "number" | "date";

D37TableSortDirection

Section titled “D37TableSortDirection”

TypeAliasDeclaration · api-edit.ts

type D37TableSortDirection = "ascending" | "descending";

D37TableSortHeaderMode

Section titled “D37TableSortHeaderMode”

TypeAliasDeclaration · api-edit.ts

type D37TableSortHeaderMode = "header" | "no-header";

D37TableSortKey

Section titled “D37TableSortKey”

InterfaceDeclaration · api-edit.ts

interface D37TableSortKey {
  columnIndex: number;
  valueType: D37TableSortValueType;
  direction: D37TableSortDirection;
}

D37TableDataCommandRequest

Section titled “D37TableDataCommandRequest”

InterfaceDeclaration · api-edit.ts

interface D37TableDataCommandRequest {
  bodyBlockIndex: number;
  command: D37TableDataCommandKind;
  keyColumnIndex?: number | null;
  sortKeys?: D37TableSortKey[];
  sortHeaderMode?: D37TableSortHeaderMode;
  sortCaseSensitive?: boolean;
  sortLanguage?: string;
  sortFieldSeparator?: Exclude<D37TableTextSeparator, "paragraphs">;
  sortCustomSeparator?: string | null;
  textSeparator?: D37TableTextSeparator;
  customSeparator?: string | null;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

D37TableDataCommandResult

Section titled “D37TableDataCommandResult”

InterfaceDeclaration · api-edit.ts

interface D37TableDataCommandResult {
  schema: "fastdoc.shell.d37-table-data-command.v1";
  operationKind: D37TableDataCommandKind;
  applied: boolean;
  documentPath: string | null;
  outputPath: string | null;
  bodyBlockIndex: number;
  keyColumnIndex: number | null;
  sortKeys: D37TableSortKey[] | null;
  sortHeaderMode: D37TableSortHeaderMode | null;
  textSeparator: D37TableTextSeparator | null;
  customSeparator: string | null;
  resultKind: string | null;
  writebackResultKind: string | null;
  sortCaseSensitive: boolean | null;
  sortLanguage: string | null;
  sortFieldSeparator: Exclude<D37TableTextSeparator, "paragraphs"> | null;
  sortCustomSeparator: string | null;
  rowCount: number | null;
  columnCount: number | null;
  spanCount: number | null;
  clipboardText: string | null;
  snapshot: unknown;
}

D37TableSelectionHeaderRepeatAction

Section titled “D37TableSelectionHeaderRepeatAction”

TypeAliasDeclaration · api-edit.ts

type D37TableSelectionHeaderRepeatAction = "repeat-selected-header-row";

D37TableSelectionHeaderRepeatRange

Section titled “D37TableSelectionHeaderRepeatRange”

InterfaceDeclaration · api-edit.ts

interface D37TableSelectionHeaderRepeatRange {
  bodyBlockIndex: number;
  rowIndex: number;
  columnIndex: number;
  rowCount: number;
  columnCount: number;
}

D37TableSelectionHeaderRepeatRequest

Section titled “D37TableSelectionHeaderRepeatRequest”

InterfaceDeclaration · api-edit.ts

interface D37TableSelectionHeaderRepeatRequest {
  selection: D37TableSelectionHeaderRepeatRange;
  action: D37TableSelectionHeaderRepeatAction;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

D37TableSelectionHeaderRepeatResult

Section titled “D37TableSelectionHeaderRepeatResult”

InterfaceDeclaration · api-edit.ts

interface D37TableSelectionHeaderRepeatResult {
  schema: "fastdoc.shell.d37-table-selection-header-repeat.v1";
  action: D37TableSelectionHeaderRepeatAction;
  selection: D37TableSelectionHeaderRepeatRange;
  computedRepeatMode: "repeat" | "clear";
  headerRepeatResult: D37TableHeaderRepeatResult;
}

D37TableSelectionHeaderRepeatCommandState

Section titled “D37TableSelectionHeaderRepeatCommandState”

InterfaceDeclaration · api-edit.ts

interface D37TableSelectionHeaderRepeatCommandState {
  schema: "fastdoc.shell.d37-table-selection-header-repeat-command-state.v1";
  operationKind: "repeat-table-header-row" | "clear-repeat-table-header-row";
  action: D37TableSelectionHeaderRepeatAction;
  canApply: boolean;
  disabledReason: string | null;
  documentPath: string | null;
  selection: D37TableSelectionHeaderRepeatRange;
  computedRepeatMode: "repeat" | "clear";
  resultKind: string | null;
  writebackResultKind: string | null;
  rowCount: number | null;
  columnCount: number | null;
  supportMarkerKinds: string[];
  snapshot: unknown;
}

D37TableSelectionClearFillRequest

Section titled “D37TableSelectionClearFillRequest”

InterfaceDeclaration · api-edit.ts

interface D37TableSelectionClearFillRequest {
  selection: D37TableSelectionCellRangeFormatRange;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

D37TableSelectionClearFillResult

Section titled “D37TableSelectionClearFillResult”

InterfaceDeclaration · api-edit.ts

interface D37TableSelectionClearFillResult {
  schema: "fastdoc.shell.d37-table-selection-clear-fill.v1";
  operationKind: "clear-table-cell-fill-range";
  applied: boolean;
  documentPath: string | null;
  outputPath: string | null;
  selection: D37TableSelectionCellRangeFormatRange;
  resultKind: string | null;
  writebackResultKind: string | null;
  rowCount: number | null;
  columnCount: number | null;
  spanCount: number | null;
  snapshot: unknown;
}

D37TableSelectionClearFillCommandState

Section titled “D37TableSelectionClearFillCommandState”

InterfaceDeclaration · api-edit.ts

interface D37TableSelectionClearFillCommandState {
  schema: "fastdoc.shell.d37-table-selection-clear-fill-command-state.v1";
  operationKind: "clear-table-cell-fill-range";
  canApply: boolean;
  disabledReason: string | null;
  documentPath: string | null;
  selection: D37TableSelectionCellRangeFormatRange;
  resultKind: string | null;
  writebackResultKind: string | null;
  rowCount: number | null;
  columnCount: number | null;
  spanCount: number | null;
  supportMarkerKinds: string[];
  snapshot: unknown;
}

D37TableSelectionClearContentsRequest

Section titled “D37TableSelectionClearContentsRequest”

InterfaceDeclaration · api-edit.ts

interface D37TableSelectionClearContentsRequest {
  selection: D37TableSelectionCellRangeFormatRange;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

D37TableSelectionClearContentsResult

Section titled “D37TableSelectionClearContentsResult”

InterfaceDeclaration · api-edit.ts

interface D37TableSelectionClearContentsResult {
  schema: "fastdoc.shell.d37-table-selection-clear-contents.v1";
  operationKind: "clear-table-cell-text-range";
  applied: boolean;
  documentPath: string | null;
  outputPath: string | null;
  selection: D37TableSelectionCellRangeFormatRange;
  resultKind: string | null;
  writebackResultKind: string | null;
  rowCount: number | null;
  columnCount: number | null;
  spanCount: number | null;
  snapshot: unknown;
}

D37TableSelectionClearContentsCommandState

Section titled “D37TableSelectionClearContentsCommandState”

InterfaceDeclaration · api-edit.ts

interface D37TableSelectionClearContentsCommandState {
  schema: "fastdoc.shell.d37-table-selection-clear-contents-command-state.v1";
  operationKind: "clear-table-cell-text-range";
  canApply: boolean;
  disabledReason: string | null;
  documentPath: string | null;
  selection: D37TableSelectionCellRangeFormatRange;
  resultKind: string | null;
  writebackResultKind: string | null;
  rowCount: number | null;
  columnCount: number | null;
  spanCount: number | null;
  supportMarkerKinds: string[];
  snapshot: unknown;
}

D37TableSelectionClearFormattingRequest

Section titled “D37TableSelectionClearFormattingRequest”

InterfaceDeclaration · api-edit.ts

interface D37TableSelectionClearFormattingRequest {
  selection: D37TableSelectionCellRangeFormatRange;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

D37TableSelectionClearFormattingResult

Section titled “D37TableSelectionClearFormattingResult”

InterfaceDeclaration · api-edit.ts

interface D37TableSelectionClearFormattingResult {
  schema: "fastdoc.shell.d37-table-selection-clear-formatting.v1";
  operationKind: "clear-table-cell-formatting-range";
  applied: boolean;
  documentPath: string | null;
  outputPath: string | null;
  selection: D37TableSelectionCellRangeFormatRange;
  fillResultKind: string | null;
  fillWritebackResultKind: string | null;
  borderResultKind: string | null;
  borderWritebackResultKind: string | null;
  rowCount: number | null;
  columnCount: number | null;
  spanCount: number | null;
  fillSnapshot: unknown;
  borderSnapshot: unknown;
}

D37TableSelectionClearFormattingCommandState

Section titled “D37TableSelectionClearFormattingCommandState”

InterfaceDeclaration · api-edit.ts

interface D37TableSelectionClearFormattingCommandState {
  schema: "fastdoc.shell.d37-table-selection-clear-formatting-command-state.v1";
  operationKind: "clear-table-cell-formatting-range";
  canApply: boolean;
  disabledReason: string | null;
  documentPath: string | null;
  selection: D37TableSelectionCellRangeFormatRange;
  resultKind: string | null;
  writebackResultKind: string | null;
  rowCount: number | null;
  columnCount: number | null;
  spanCount: number | null;
  supportMarkerKinds: string[];
  snapshot: unknown;
}

D37TableSelectionClearContentFormatRequest

Section titled “D37TableSelectionClearContentFormatRequest”

InterfaceDeclaration · api-edit.ts

interface D37TableSelectionClearContentFormatRequest {
  selection: D37TableSelectionCellRangeFormatRange;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

D37TableSelectionClearContentFormatResult

Section titled “D37TableSelectionClearContentFormatResult”

InterfaceDeclaration · api-edit.ts

interface D37TableSelectionClearContentFormatResult {
  schema: "fastdoc.shell.d37-table-selection-clear-content-format.v1";
  operationKind: "clear-table-cell-content-format-range";
  applied: boolean;
  documentPath: string | null;
  outputPath: string | null;
  selection: D37TableSelectionCellRangeFormatRange;
  resultKind: string | null;
  writebackResultKind: string | null;
  rowCount: number | null;
  columnCount: number | null;
  spanCount: number | null;
  snapshot: unknown;
}

D37TableSelectionClearContentFormatCommandState

Section titled “D37TableSelectionClearContentFormatCommandState”

InterfaceDeclaration · api-edit.ts

interface D37TableSelectionClearContentFormatCommandState {
  schema: "fastdoc.shell.d37-table-selection-clear-content-format-command-state.v1";
  operationKind: "clear-table-cell-content-format-range";
  canApply: boolean;
  disabledReason: string | null;
  documentPath: string | null;
  selection: D37TableSelectionCellRangeFormatRange;
  resultKind: string | null;
  writebackResultKind: string | null;
  rowCount: number | null;
  columnCount: number | null;
  spanCount: number | null;
  supportMarkerKinds: string[];
  snapshot: unknown;
}

D37TableStructureEditMode

Section titled “D37TableStructureEditMode”

TypeAliasDeclaration · api-edit.ts

type D37TableStructureEditMode = "delete-table" | "delete-cell" | "delete-cell-shift-up" | "split-table" | "insert-row" | "insert-rows" | "delete-row" | "delete-rows" | "insert-column" | "insert-columns" | "delete-column" | "delete-columns";

D37TableSelectionStructureEditAction

Section titled “D37TableSelectionStructureEditAction”

TypeAliasDeclaration · api-edit.ts

type D37TableSelectionStructureEditAction = "insert-row-above" | "insert-row-below" | "insert-column-left" | "insert-column-right" | "split-table" | "delete-selected-rows" | "delete-selected-columns";

D37TableStructureEditRequest

Section titled “D37TableStructureEditRequest”

InterfaceDeclaration · api-edit.ts

interface D37TableStructureEditRequest {
  bodyBlockIndex: number;
  editMode: D37TableStructureEditMode;
  rowIndex?: number | null;
  columnIndex?: number | null;
  spanCount?: number | null;
  clipboardText?: string | null;
  cellTexts?: string[] | null;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

D37TableStructureEditResult

Section titled “D37TableStructureEditResult”

InterfaceDeclaration · api-edit.ts

interface D37TableStructureEditResult {
  schema: "fastdoc.shell.d37-table-structure-edit.v1";
  operationKind: "delete-table" | "delete-table-cell" | "delete-table-cell-shift-up" | "split-table" | "insert-table-row" | "insert-table-rows" | "delete-table-row" | "delete-table-rows" | "insert-table-column" | "insert-table-columns" | "delete-table-column" | "delete-table-columns";
  applied: boolean;
  documentPath: string | null;
  outputPath: string | null;
  editMode: D37TableStructureEditMode;
  bodyBlockIndex: number;
  targetIndex: number;
  resultKind: string | null;
  writebackResultKind: string | null;
  rowCount: number | null;
  columnCount: number | null;
  spanCount: number | null;
  clipboardText: string | null;
  cellTexts: string[];
  snapshot: unknown;
}

D37TableSelectionRange

Section titled “D37TableSelectionRange”

InterfaceDeclaration · api-edit.ts

interface D37TableSelectionRange {
  bodyBlockIndex: number;
  rowIndex: number;
  columnIndex: number;
  rowCount: number;
  columnCount: number;
}

D37TableSelectionStructureEditRequest

Section titled “D37TableSelectionStructureEditRequest”

InterfaceDeclaration · api-edit.ts

interface D37TableSelectionStructureEditRequest {
  selection: D37TableSelectionRange;
  action: D37TableSelectionStructureEditAction;
  clipboardText?: string | null;
  cellTexts?: string[] | null;
  tableInputProvenance?: "mouse-internal-divider-intent" | null;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

D37TableSelectionStructureEditResult

Section titled “D37TableSelectionStructureEditResult”

InterfaceDeclaration · api-edit.ts

interface D37TableSelectionStructureEditResult {
  schema: "fastdoc.shell.d37-table-selection-structure-edit.v1";
  action: D37TableSelectionStructureEditAction;
  selection: D37TableSelectionRange;
  computedEditMode: D37TableStructureEditMode;
  computedTargetIndex: number;
  structureEditResult: D37TableStructureEditResult;
}

D37TableSelectionStructureCommandState

Section titled “D37TableSelectionStructureCommandState”

InterfaceDeclaration · api-edit.ts

interface D37TableSelectionStructureCommandState {
  schema: "fastdoc.shell.d37-table-selection-structure-command-state.v1";
  action: D37TableSelectionStructureEditAction;
  selection: D37TableSelectionRange;
  computedEditMode: D37TableStructureEditMode;
  computedTargetIndex: number;
  operationKind: D37TableStructureEditResult["operationKind"];
  canApply: boolean;
  disabledReason: string | null;
  canonicalReason: string | null;
  canonicalDetail: string | null;
  documentPath: string | null;
  resultKind: string | null;
  writebackResultKind: string | null;
  rowCount: number | null;
  columnCount: number | null;
  spanCount: number | null;
  supportMarkerKinds: string[];
  snapshot: unknown;
}

D37TableDimensionsRequest

Section titled “D37TableDimensionsRequest”

InterfaceDeclaration · api-edit.ts

interface D37TableDimensionsRequest {
  bodyBlockIndex: number;
  rowIndex?: number | null;
  rowHeightTwips?: number | null;
  rowHeightRule?: "exact" | "atLeast" | "at_least" | "auto" | "automatic" | null;
  fitRowHeightToContents?: boolean | null;
  allowRowToBreakAcrossPages?: boolean | null;
  columnIndex?: number | null;
  columnWidthTwips?: number | null;
  tableWidthTwips?: number | null;
  tableIndentTwips?: number | null;
  tableAlignment?: "left" | "center" | "right" | null;
  pairedColumnIndex?: number | null;
  pairedColumnWidthTwips?: number | null;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

D37TableDimensionsResult

Section titled “D37TableDimensionsResult”

InterfaceDeclaration · api-edit.ts

interface D37TableDimensionsResult {
  schema: "fastdoc.shell.d37-table-dimensions.v1";
  operationKind: "table-row-column-dimensions";
  applied: boolean;
  documentPath: string | null;
  outputPath: string | null;
  bodyBlockIndex: number;
  rowIndex: number | null;
  columnIndex: number | null;
  rowOperationKind: string | null;
  rowResultKind: string | null;
  rowWritebackResultKind: string | null;
  rowDimensionTwips: number | null;
  rowHeightRule: string | null;
  allowRowToBreakAcrossPages: boolean | null;
  columnOperationKind: string | null;
  columnResultKind: string | null;
  columnWritebackResultKind: string | null;
  columnDimensionTwips: number | null;
  rowCount: number | null;
  columnCount: number | null;
  rowSnapshot: unknown;
  columnSnapshot: unknown;
}

D37TableSelectionRowFitAction

Section titled “D37TableSelectionRowFitAction”

TypeAliasDeclaration · api-edit.ts

type D37TableSelectionRowFitAction = "fit-selected-table-row-to-contents";

D37TableSelectionRowFitRange

Section titled “D37TableSelectionRowFitRange”

InterfaceDeclaration · api-edit.ts

interface D37TableSelectionRowFitRange {
  bodyBlockIndex: number;
  rowIndex: number;
  columnIndex: number;
  rowCount: number;
  columnCount: number;
}

D37TableSelectionRowFitRequest

Section titled “D37TableSelectionRowFitRequest”

InterfaceDeclaration · api-edit.ts

interface D37TableSelectionRowFitRequest {
  selection: D37TableSelectionRowFitRange;
  action?: D37TableSelectionRowFitAction | null;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

D37TableSelectionRowFitResult

Section titled “D37TableSelectionRowFitResult”

InterfaceDeclaration · api-edit.ts

interface D37TableSelectionRowFitResult {
  schema: "fastdoc.shell.d37-table-selection-row-fit.v1";
  action: D37TableSelectionRowFitAction;
  selection: D37TableSelectionRowFitRange;
  computedRowIndex: number;
  rowFitResult: D37TableDimensionsResult;
}

D37TableSelectionRowFitCommandState

Section titled “D37TableSelectionRowFitCommandState”

InterfaceDeclaration · api-edit.ts

interface D37TableSelectionRowFitCommandState {
  schema: "fastdoc.shell.d37-table-selection-row-fit-command-state.v1";
  operationKind: "table-row-column-dimensions";
  action: D37TableSelectionRowFitAction;
  canApply: boolean;
  disabledReason: string | null;
  documentPath: string | null;
  selection: D37TableSelectionRowFitRange;
  computedRowIndex: number | null;
  rowOperationKind: string | null;
  rowResultKind: string | null;
  rowWritebackResultKind: string | null;
  rowDimensionTwips: number | null;
  rowHeightRule: string | null;
  rowCount: number | null;
  columnCount: number | null;
  supportMarkerKinds: string[];
  snapshot: unknown;
}

D37TableAltTextRequest

Section titled “D37TableAltTextRequest”

InterfaceDeclaration · api-edit.ts

interface D37TableAltTextRequest {
  bodyBlockIndex: number;
  title: string;
  description: string;
  reopenAfterWrite?: boolean;
  outputPath?: string | null;
}

D37TableAltTextResult

Section titled “D37TableAltTextResult”

InterfaceDeclaration · api-edit.ts

interface D37TableAltTextResult {
  schema: "fastdoc.shell.d37-table-alt-text.v1";
  operationKind: "set-table-alt-text";
  applied: boolean;
  documentPath: string | null;
  outputPath: string | null;
  bodyBlockIndex: number;
  title: string | null;
  description: string | null;
  resultKind: string | null;
  writebackResultKind: string | null;
  rowCount: number | null;
  columnCount: number | null;
  snapshot: unknown;
}

Documentation assistant

Answers are assembled from the documentation and may be inaccurate — check the sources.