Types: data and sheet objects

Definitions of the names from the “TypeScript type” column on the operation pages.

Other dictionary topics: session, workbook, and sheets · cells and ranges · formulas and calculation · formatting · data and sheet objects · pivot tables · charts and graphics · printing and page layout · Power Query · VBA and macros · protection and review · general and utility.

Types on this page — 77

• ContractAdvancedFilterAction
• ContractAdvancedFilterProjectedCell
• ContractAnalyzeInsightCard
• ContractAnalyzeInsightKind
• ContractAnalyzeInsightsInsertion
• ContractAnalyzeInsightsPlan
• ContractAutoFilterDateGroupMetadata
• ContractConsolidateFunction
• ContractConsolidationMutation
• ContractCustomViewFilterSnapshot
• ContractCustomViewFilterTargetKind
• ContractCustomViewOutlineAxis
• ContractDataAnalysisGrouping
• ContractDataValidationContinuation
• ContractDataValidationDecision
• ContractDataValidationMetadata
• ContractDataValidationRawInput
• ContractDataValidationRule
• ContractDataValidationRuleIntent
• ContractDataValidationVerdict
• ContractDataValidationVerdictKind
• ContractDelimitedImportDestination
• ContractDelimitedImportDestinationKind
• ContractDelimitedTextQualifier
• ContractExternalRangeEntry
• ContractExternalRangeIdentity
• ContractExternalRangeProperties
• ContractExternalReferenceTrustMetadata
• ContractOutlineAxis
• ContractOutlineSubtotalAction
• ContractOutlineSubtotalState
• ContractRangeFilterAction
• ContractRangeFilterDateGroup
• ContractRangeFilterNumberOp
• ContractRangeFilterPredicate
• ContractRangeFilterRelativePeriod
• ContractRangeFilterTextOp
• ContractRichTextRun
• ContractSlicerItem
• ContractSlicerPayload
• ContractSlicerStatus
• ContractSlicerTimelineAction
• ContractSlicerTimelineControlKind
• ContractSlicerTimelineControlView
• ContractSlicerTimelineLevel
• ContractSlicerTimelineSortOrder
• ContractSlicerTimelineSource
• ContractSlicerTimelineTargetView
• ContractSubtotalAggregate
• ContractSubtotalOptions
• ContractTableFilterMetadata
• ContractTableHyperlinkAction
• ContractTableLifecycleAction
• ContractTableMetadataEntry
• ContractTableMetadataProjection
• ContractTableModelMutation
• ContractTableSortMetadata
• ContractTextHorizontalAlign
• ContractTextParagraph
• ContractTextPayload
• ContractTextPayloadStatus
• ContractTextRun
• ContractTextVerticalAlign
• ContractTrustCenterExternalPolicy
• ContractWorksheetAutoFilterMetadata
• ContractXlsxDataValidationClearRulePatch
• ContractXlsxDataValidationListRulePatch
• ContractXlsxDataValidationMessageRulePatch
• ContractXlsxDataValidationRulePatch
• ContractXlsxRichTextRunPatch
• ContractXlsxTextBoxObjectPatch
• MWireTableSchema
• ProductTableRangeLoadToOutcome
• ProductTableRangeRefreshOutcome
• TableRangeOutputPlacement
• TableRangeSelector
• TableRangeSourceIdentity

ContractAdvancedFilterAction

type ContractAdvancedFilterAction = "filter_in_place" | "copy_to_range";

ContractAdvancedFilterProjectedCell

interface ContractAdvancedFilterProjectedCell {
  row: number;
  col: number;
  value: string;
  valueKind?: string | null;
}

ContractAnalyzeInsightCard

interface ContractAnalyzeInsightCard {
  stableId: string;
  kind: ContractAnalyzeInsightKind;
  titleCode: string;
  summary: string;
  score: number;
  insertion: ContractAnalyzeInsightsInsertion;
  chartType?: string | null;
  insertable: boolean;
}

ContractAnalyzeInsightKind

type ContractAnalyzeInsightKind = | "summary" | "trend" | "outliers" | "grouping" | "correlation" | "suitable_chart";

ContractAnalyzeInsightsInsertion

type ContractAnalyzeInsightsInsertion = "table" | "chart" | "pivot_table";

ContractAnalyzeInsightsPlan

interface ContractAnalyzeInsightsPlan {
  generation: number;
  sourceRange: CellRange;
  dateSystem: "1900" | "1904" | string;
  hasHeaders: boolean;
  visibleRowCount: number;
  hiddenRowCount: number;
  numericCount: number;
  textCount: number;
  dateCount: number;
  blankCount: number;
  formulaCount: number;
  errorCount: number;
  deterministicHash: string;
  suggestedInsertion: ContractAnalyzeInsightsInsertion;
  insights: ContractAnalyzeInsightCard[];
  warnings: string[];
}

ContractAutoFilterDateGroupMetadata

interface ContractAutoFilterDateGroupMetadata {
  year?: number | null;
  month?: number | null;
  day?: number | null;
  hour?: number | null;
  minute?: number | null;
  second?: number | null;
  dateTimeGrouping: string;
}

ContractConsolidateFunction

type ContractConsolidateFunction =
  | "sum"
  | "count"
  | "average"
  | "max"
  | "min"
  | "product"
  | "countNumbers"
  | "stdDev"
  | "stdDevp"
  | "var"
  | "varp";

ContractConsolidationMutation

interface ContractConsolidationMutation {
  operation: "apply_cell_edits";
  subsetId: string;
  session: ContractSubsetSessionInfo;
  supportedSubset: string;
  formulaTrustSnapshot?: ContractFormulaTrustSnapshot | null;
  delta: DeltaSummary;
  editedKeys: string[];
  changedKeys: string[];
  dirtyCellCount: number;
  sheetProtected: boolean;
  conditionalFormattingRules?: ContractConditionalRule[];
  currentSourceSaveReadiness?: ContractCurrentSourceSaveReadiness | null;
  activeSheet: ContractActiveSheetMeta;
  geometry: ContractGeometrySubset;
  recalcNeeded: boolean;
  viewport: ViewportWindow;
  previewCells: ContractPreviewCell[];
  tableMetadata?: ContractTableMetadataProjection | null;
  workbookTableMetadata?: ContractTableMetadataProjection | null;
  workbookHistory: ContractWorkbookHistoryProjection;
}

ContractCustomViewFilterSnapshot

interface ContractCustomViewFilterSnapshot {
  sheetKey: string;
  targetKind: ContractCustomViewFilterTargetKind;
  targetId: string;
  stateXml?: string;
}

ContractCustomViewFilterTargetKind

type ContractCustomViewFilterTargetKind = "worksheet" | "table";

ContractCustomViewOutlineAxis

type ContractCustomViewOutlineAxis = "row" | "column";

ContractDataAnalysisGrouping

type ContractDataAnalysisGrouping = "columns" | "rows";

ContractDataValidationContinuation

interface ContractDataValidationContinuation {
  token: string;
  decision: ContractDataValidationDecision;
}

ContractDataValidationDecision

type ContractDataValidationDecision = "retry" | "cancel" | "yes" | "no" | "ok";

ContractDataValidationMetadata

interface ContractDataValidationMetadata {
  rules: ContractDataValidationRule[];
}

ContractDataValidationRawInput

interface ContractDataValidationRawInput {
  sheetKey: string;
  row: number;
  col: number;
  input: string;

  locale?: string | null;

  candidateEdit?: CellInputEdit | null;
}

ContractDataValidationRule

interface ContractDataValidationRule {
  activeSheetPath: string;
  sqref: string;
  type:
    | "none"
    | "whole"
    | "decimal"
    | "date"
    | "time"
    | "textLength"
    | "custom"
    | "list";
  formula1?: string | null;
  formula2?: string | null;
  operator?: string | null;
  allowBlank?: boolean | null;
  inCellDropdown?: boolean | null;
  showInputMessage?: boolean | null;
  showErrorMessage?: boolean | null;
  promptTitle?: string | null;
  prompt?: string | null;
  errorTitle?: string | null;
  error?: string | null;
  errorStyle?: string | null;
}

ContractDataValidationRuleIntent

interface ContractDataValidationRuleIntent {
  sqref: string;
  type:
    | "none"
    | "whole"
    | "decimal"
    | "date"
    | "time"
    | "textLength"
    | "custom"
    | "list";
  operator?:
    | "between"
    | "notBetween"
    | "equal"
    | "notEqual"
    | "greaterThan"
    | "lessThan"
    | "greaterThanOrEqual"
    | "lessThanOrEqual"
    | null;
  formula1?: string | null;
  formula2?: string | null;
  allowBlank?: boolean | null;
  inCellDropdown?: boolean | null;
  showInputMessage?: boolean | null;
  promptTitle?: string | null;
  prompt?: string | null;
  showErrorMessage?: boolean | null;
  errorStyle?: "stop" | "warning" | "information" | null;
  errorTitle?: string | null;
  error?: string | null;
}

ContractDataValidationVerdict

interface ContractDataValidationVerdict {
  sheetKey: string;
  row: number;
  col: number;
  kind: ContractDataValidationVerdictKind;
  code: string;
  rule?: ContractDataValidationRule | null;
  errorStyle?: "stop" | "warning" | "information" | null;
  errorTitle?: string | null;
  error?: string | null;
}

ContractDataValidationVerdictKind

type ContractDataValidationVerdictKind = "accepted" | "rejected" | "decision-required";

ContractDelimitedImportDestination

interface ContractDelimitedImportDestination {
  kind: ContractDelimitedImportDestinationKind;
  sheetKey?: string | null;
  sheetName?: string | null;
}

ContractDelimitedImportDestinationKind

type ContractDelimitedImportDestinationKind = "existing-worksheet" | "new-worksheet";

ContractDelimitedTextQualifier

type ContractDelimitedTextQualifier = (typeof CONTRACT_DELIMITED_TEXT_QUALIFIER_IDS)[number];

ContractExternalRangeEntry

interface ContractExternalRangeEntry {
  identity: ContractExternalRangeIdentity;
  properties: ContractExternalRangeProperties;

  readOnlyFields?: string[];
}

ContractExternalRangeIdentity

interface ContractExternalRangeIdentity {
  name: string;

  queryTablePart: string;

  connectionId: string;
}

ContractExternalRangeProperties

interface ContractExternalRangeProperties {
  name: string;

  saveData: boolean;
  savePassword: boolean;
  refreshOnFileOpen: boolean;
  textFilePromptOnRefresh: boolean;
  rowNumbers: boolean;
  fieldNames: boolean;
  tablesOnlyFromHtml: boolean;
  adjustColumnWidth: boolean;
  refreshStyle:
    | "insert-delete-cells"
    | "insert-entire-rows"
    | "overwrite-existing-cells";
  fillAdjacentFormulas: boolean;
  hasAutoformat: boolean;
  enableRefresh: boolean;
  backgroundQuery: boolean;
}

ContractExternalReferenceTrustMetadata

interface ContractExternalReferenceTrustMetadata {
  label: string;
  workbookName?: string | null;
  targetSheetName?: string | null;
  targetAddress?: string | null;
  resolutionState: string;
  reason?: string | null;
  cachedDisplayValue?: string | null;
}

ContractOutlineAxis

type ContractOutlineAxis = "row" | "column";

ContractOutlineSubtotalAction

type ContractOutlineSubtotalAction =
  | "read_state"
  | "group"
  | "ungroup"
  | "collapse"
  | "expand"
  | "show_level"
  | "auto_outline"
  | "clear_outline"
  | "subtotal"
  | "remove_all";

ContractOutlineSubtotalState

interface ContractOutlineSubtotalState {
  rowLevels: ContractOutlineTrackState[];
  columnLevels: ContractOutlineTrackState[];
  maxRowLevel: number;
  maxColumnLevel: number;
  summaryBelow: boolean;
  subtotalFormulaKeys: string[];
}

ContractRangeFilterAction

type ContractRangeFilterAction = "apply" | "clear_column" | "clear_all" | "reapply";

ContractRangeFilterDateGroup

interface ContractRangeFilterDateGroup {
  dateTimeGrouping: "year" | "month" | "day" | "hour" | "minute" | "second";
  year?: number | null;
  month?: number | null;
  day?: number | null;
  hour?: number | null;
  minute?: number | null;
  second?: number | null;
}

ContractRangeFilterNumberOp

type ContractRangeFilterNumberOp = "eq" | "ne" | "gt" | "ge" | "lt" | "le" | "between";

ContractRangeFilterPredicate

type ContractRangeFilterPredicate =
  | { kind: "values"; values: string[] }
  | { kind: "date_groups"; groups: ContractRangeFilterDateGroup[] }
  | { kind: "compound"; and?: boolean; predicates: ContractRangeFilterPredicate[]; }
  | { kind: "number"; op: ContractRangeFilterNumberOp; value: string; value2?: string
  | null; }
  | { kind: "top_n"; bottom?: boolean; percent?: boolean; count: number }
  | { kind: "text"; op: ContractRangeFilterTextOp; value: string }
  | { kind: "average"; below?: boolean }
  | { kind: "relative_period"; period: ContractRangeFilterRelativePeriod };

ContractRangeFilterRelativePeriod

type ContractRangeFilterRelativePeriod =
  | "tomorrow"
  | "today"
  | "yesterday"
  | "next-week"
  | "this-week"
  | "last-week"
  | "next-month"
  | "this-month"
  | "last-month"
  | "next-quarter"
  | "this-quarter"
  | "last-quarter"
  | "next-year"
  | "this-year"
  | "last-year"
  | "year-to-date"
  | "all-dates-in-the-period";

ContractRangeFilterTextOp

type ContractRangeFilterTextOp =
  | "equals"
  | "not_equals"
  | "contains"
  | "not_contains"
  | "begins_with"
  | "not_begins_with"
  | "ends_with"
  | "not_ends_with";

ContractRichTextRun

interface ContractRichTextRun {
  index: number;
  text: string;
  bold?: boolean;
  italic?: boolean;
  underline?: boolean;
  fontVerticalAlign?: ContractPreviewFontVerticalAlign | null;
}

ContractSlicerItem

interface ContractSlicerItem {
  label: string;

  selected?: boolean;

  noData?: boolean;
}

ContractSlicerPayload

interface ContractSlicerPayload {
  status: ContractSlicerStatus;
  name: string;
  caption?: string | null;
  cacheName?: string | null;
  sourceField?: string | null;
  pivotTableNames?: string[];
  columnCount?: number | null;
  rowHeightEmu?: number | null;
  style?: string | null;
  showCaption: boolean;

  items?: ContractSlicerItem[];
  itemCount: number;
  selectedCount: number;
}

ContractSlicerStatus

type ContractSlicerStatus = "live-readonly" | "missing-items";

ContractSlicerTimelineAction

type ContractSlicerTimelineAction =
  | { action: "list" }
  | { action: "create";
    kind: ContractSlicerTimelineControlKind;
    source: ContractSlicerTimelineSource;
    fieldName: string;
  name?: string
  | null; caption?: string
  | null; anchorSheet: string; connections: string[]; }
  | { action: "set_selection"; controlId: string; selectedItems: string[]; timelineStart?: string
  | null; timelineEnd?: string
  | null; }
  | { action: "clear"; controlId: string }
  | { action: "set_sort"; controlId: string; sortOrder: ContractSlicerTimelineSortOrder; }
  | { action: "set_timeline_level"; controlId: string; level: ContractSlicerTimelineLevel; }
  | { action: "set_connections"; controlId: string; connections: string[] }
  | { action: "list_filter_connections"; pivotCacheId: string; pivotTableName: string; }
  | { action: "apply_filter_connections";
    pivotCacheId: string;
    pivotTableName: string;
    connectedControlIds: string[];
  }
  | { action: "rename"; controlId: string; name: string; caption: string }
  | { action: "delete"; controlId: string }
  | { action: "start_refresh_current"; controlId: string }
  | { action: "refresh_status"; controlId: string; generation?: number
  | null; advance: boolean; }
  | { action: "cancel_refresh"; controlId: string; generation: number }
  | { action: "undo" }
  | { action: "redo" };

ContractSlicerTimelineControlKind

type ContractSlicerTimelineControlKind = "slicer" | "timeline";

ContractSlicerTimelineControlView

interface ContractSlicerTimelineControlView {
  id: string;
  cacheId: string;
  name: string;
  caption: string;
  kind: ContractSlicerTimelineControlKind;
  source: ContractSlicerTimelineSource;
  fieldName: string;
  anchorSheet: string;
  selectedItems: string[];
  availableItems: string[];
  sortOrder: ContractSlicerTimelineSortOrder;
  timelineLevel?: ContractSlicerTimelineLevel | null;
  timelineStart?: string | null;
  timelineEnd?: string | null;
  connections: string[];
  stableUid: string;
  stableCacheUid: string;
  cacheGeneration: number;
  latestRequestGeneration: number;
  matchedRowCount: number;
}

ContractSlicerTimelineLevel

type ContractSlicerTimelineLevel = "years" | "quarters" | "months" | "days";

ContractSlicerTimelineSortOrder

type ContractSlicerTimelineSortOrder = "ascending" | "descending" | "source";

ContractSlicerTimelineSource

type ContractSlicerTimelineSource =
  | { kind: "table"; tableName: string; sheetKey: string }
  | { kind: "pivot"; pivotCacheId: string; pivotTableNames: string[]; fieldValues: string[]; };

ContractSlicerTimelineTargetView

interface ContractSlicerTimelineTargetView {
  pivotCacheId: string;
  pivotTableName: string;
  cacheGeneration: number;
  matchedRowCount: number;
}

ContractSubtotalAggregate

type ContractSubtotalAggregate = "sum" | "count" | "counta" | "average" | "min" | "max" | "product";

ContractSubtotalOptions

interface ContractSubtotalOptions {
  groupByCol: number;
  targetCols: number[];
  aggregate: ContractSubtotalAggregate;
  replaceCurrent?: boolean;
  summaryBelow?: boolean;
  pageBreakBetweenGroups?: boolean;
}

ContractTableFilterMetadata

interface ContractTableFilterMetadata {
  colId: number;
  values: string[];
  operator?: string | null;
  criteria?: string | null;
  criteria2?: string | null;
  operator2?: string | null;
  criteriaJoin?: string | null;
  kind?: string | null;
  blank?: boolean | null;
  calendarType?: string | null;
  dateGroups?: ContractAutoFilterDateGroupMetadata[];
  hiddenButton?: boolean | null;
  showButton?: boolean | null;
}

ContractTableHyperlinkAction

type ContractTableHyperlinkAction =
  | { action: "table"; mutation: ContractTableModelMutation; }
  | { action: "upsert_hyperlink"; sheetKey: string; row: number; col: number; stableId?: string
  | null; target: string; location?: string
  | null; display?: string
  | null; tooltip?: string
  | null; targetMode?: string
  | null; cellText?: string
  | null; }
  | { action: "delete_hyperlink"; sheetKey: string; row: number; col: number; stableId?: string
  | null; }
  | { action: "cancel"; sheetKey: string; };

ContractTableLifecycleAction

type ContractTableLifecycleAction = | "insert" | "rename" | "style" | "filter_metadata" | "refresh" | "convert_to_range" | "delete";

ContractTableMetadataEntry

interface ContractTableMetadataEntry {
  stableId: string;
  id: string | null;
  name: string | null;
  displayName: string | null;
  ref: string;
  tablePath?: string | null;
  sheetName: string;
  sheetPath: string;
  headerRowCount: number;
  totalsRowCount: number;
  totalsRowShown: boolean;
  tableStyleName: string | null;
  showFirstColumn: boolean;
  showLastColumn: boolean;
  showRowStripes: boolean;
  showColumnStripes: boolean;
  filterButtonVisible: boolean;
  activeFilterColumnIds: number[];
  activeFilters: ContractTableFilterMetadata[];
  activeSortState?: ContractTableSortMetadata | null;
  columns: ContractTableColumnMetadata[];
}

ContractTableMetadataProjection

interface ContractTableMetadataProjection {
  scope: "active-sheet" | "workbook";
  source: "rust-authoritative-table-model";
  activeSheetPath: string;
  tableCount: number;
  tables: ContractTableMetadataEntry[];
  note: string;
}

ContractTableModelMutation

type ContractTableModelMutation =
  | { action: "table_lifecycle"; lifecycleAction: ContractTableLifecycleAction; stableId?: string
  | null; tablePath?: string
  | null; tableName?: string
  | null; table?: ContractTableMetadataEntry
  | null; edits?: CellInputEdit[]; }
  | { action: "set_total_row"; stableId?: string
  | null; tablePath?: string
  | null; tableName?: string
  | null; enabled: boolean; totals?: ContractTableTotalColumn[]; }
  | { action: "resize"; stableId?: string
  | null; tablePath?: string
  | null; tableName?: string
  | null; ref: string; }
  | { action: "set_total_formula"; stableId?: string
  | null; tablePath?: string
  | null; tableName?: string
  | null; columnName: string; formula: string; };

ContractTableSortMetadata

interface ContractTableSortMetadata {
  ref: string;
  columnRef: string;
  colId: number;
  descending: boolean;
  caseSensitive: boolean;
  columnSort: boolean;
}

ContractTextHorizontalAlign

type ContractTextHorizontalAlign = "left" | "center" | "right";

ContractTextParagraph

interface ContractTextParagraph {
  runs: ContractTextRun[];
  horizontalAlign?: ContractTextHorizontalAlign | null;
  rtl?: boolean | null;
  bullet?: string | null;
  level?: number | null;
  preservedPropertiesXml?: string | null;
}

ContractTextPayload

interface ContractTextPayload {
  status: ContractTextPayloadStatus;
  text: string;
  fontFamily?: string | null;
  paragraphs?: ContractTextParagraph[] | null;
  fontSize?: number | null;
  bold?: boolean | null;
  italic?: boolean | null;
  color?: string | null;

  colorThemeSlot?: number | null;
  colorThemeLumMod?: number | null;
  colorThemeLumOff?: number | null;
  colorThemeTint?: number | null;
  colorThemeShade?: number | null;
  fillOpacity?: number | null;
  fillType?: "solid" | "none" | string | null;
  outlineColor?: string | null;
  outlineOpacity?: number | null;
  outlineWidth?: number | null;
  outlineType?: "solid" | "none" | string | null;
  shadow?: boolean | null;
  shadowColor?: string | null;
  shadowOpacity?: number | null;
  shadowBlur?: number | null;
  shadowAngle?: number | null;
  shadowDist?: number | null;
  glowColor?: string | null;
  glowSize?: number | null;
  glowOpacity?: number | null;
  softEdges?: number | null;
  wrapText?: boolean | null;
  overflowText?: boolean | null;
  autofit?: "none" | "shrink" | "resize" | string | null;
  textDirection?:
    "horizontal" | "rotate90" | "rotate270" | "stacked" | string | null;
  textMarginLeft?: number | null;
  textMarginRight?: number | null;
  textMarginTop?: number | null;
  textMarginBottom?: number | null;
  horizontalAlign?: ContractTextHorizontalAlign | null;
  verticalAlign?: ContractTextVerticalAlign | null;
  rotationDegrees?: number | null;
  rtl?: boolean | null;
}

ContractTextPayloadStatus

type ContractTextPayloadStatus = "live-editable";

ContractTextRun

interface ContractTextRun {
  text: string;
  fontFamily?: string | null;
  fontSize?: number | null;
  bold?: boolean | null;
  italic?: boolean | null;
  color?: string | null;
  language?: string | null;
  rtl?: boolean | null;
  hyperlink?: string | null;
  hyperlinkRelationshipId?: string | null;
  preservedPropertiesXml?: string | null;
}

ContractTextVerticalAlign

type ContractTextVerticalAlign = "top" | "middle" | "bottom";

ContractTrustCenterExternalPolicy

type ContractTrustCenterExternalPolicy = "manual_only" | "block_all";

ContractWorksheetAutoFilterMetadata

interface ContractWorksheetAutoFilterMetadata {
  scope: "active-sheet";
  source: "rust-authoritative-worksheet-auto-filter-model";
  activeSheetPath: string;
  ref: string;
  activeFilterColumnIds: number[];
  activeFilters: ContractTableFilterMetadata[];

  filterMode?: boolean | null;
}

ContractXlsxDataValidationClearRulePatch

interface ContractXlsxDataValidationClearRulePatch {
  activeSheetPath: string;
  cellRef: string;
}

ContractXlsxDataValidationListRulePatch

interface ContractXlsxDataValidationListRulePatch {
  activeSheetPath: string;
  sqref: string;
  formula1: string;
  literalListValues: string[];
  sourceLabel?: string | null;
  targetLabel?: string | null;
}

ContractXlsxDataValidationMessageRulePatch

interface ContractXlsxDataValidationMessageRulePatch {
  activeSheetPath: string;
  cellRef: string;
  promptTitle?: string | null;
  prompt?: string | null;
  showInputMessage?: boolean | null;
  errorTitle?: string | null;
  error?: string | null;
  errorStyle?: string | null;
  showErrorMessage?: boolean | null;
}

ContractXlsxDataValidationRulePatch

interface ContractXlsxDataValidationRulePatch {
  activeSheetPath: string;
  sqref: string;
  type: "whole" | "date" | "textLength" | "custom" | "list";
  formula1: string;
  formula2?: string | null;
  operator?:
    | "between"
    | "notBetween"
    | "equal"
    | "notEqual"
    | "greaterThan"
    | "lessThan"
    | "greaterThanOrEqual"
    | "lessThanOrEqual"
    | null;
  allowBlank?: boolean | null;
  inCellDropdown?: boolean | null;
  showInputMessage?: boolean | null;
  showErrorMessage?: boolean | null;
}

ContractXlsxRichTextRunPatch

interface ContractXlsxRichTextRunPatch {
  activeSheetPath: string;
  cellRef: string;
  runIndex: number;
  text?: string | null;
  bold?: boolean | null;
  italic?: boolean | null;
  underline?: boolean | null;
}

ContractXlsxTextBoxObjectPatch

interface ContractXlsxTextBoxObjectPatch {
  objectId: string;
  objectName?: string | null;
  hidden?: boolean | null;
  from: ContractObjectAnchorCell;
  ext: ContractObjectExtent;
  zOrder?: number | null;
  text: string;
  paragraphs?: ContractTextParagraph[] | null;
  fontFamily?: string | null;
  fontSize?: number | null;
  bold?: boolean | null;
  italic?: boolean | null;
  underline?: boolean | null;
  color?: string | null;
  textFillType?: string | null;
  textFillOpacity?: number | null;
  textOutlineHex?: string | null;
  textOutlineType?: string | null;
  textOutlineOpacity?: number | null;
  textOutlineWidth?: number | null;
  textShadow?: boolean | null;
  textShadowColor?: string | null;
  textShadowOpacity?: number | null;
  textShadowBlur?: number | null;
  textShadowAngle?: number | null;
  textShadowDist?: number | null;
  textGlowColor?: string | null;
  textGlowSize?: number | null;
  textGlowOpacity?: number | null;
  textSoftEdges?: number | null;
  wrapText?: boolean | null;
  overflowText?: boolean | null;
  autofit?: string | null;
  textDirection?: string | null;
  textMarginLeft?: number | null;
  textMarginRight?: number | null;
  textMarginTop?: number | null;
  textMarginBottom?: number | null;
  horizontalAlign?: ContractTextHorizontalAlign | null;
  verticalAlign?: ContractTextVerticalAlign | null;
  rotationDegrees?: number | null;
  rtl?: boolean | null;

  rawAnchorXml?: string | null;
}

MWireTableSchema

interface MWireTableSchema {
  columnTypes: string[];
}

ProductTableRangeLoadToOutcome

interface ProductTableRangeLoadToOutcome {
  placed: boolean;
  loadPlan?: PowerQueryLoadPlan;

  persistedQuery?: unknown;
  blockReason?: string;
  blockDetail?: string;
}

ProductTableRangeRefreshOutcome

interface ProductTableRangeRefreshOutcome {
  generation: number;
  phase: "queued" | "running" | "ready" | "finished" | "cancelled" | "blocked";
  completed: number;
  total: number;
  deniedReason?: string;
  deniedMessage?: string;
  outcomes: ProductTableRangeRefreshQueryOutcome[];
}

TableRangeOutputPlacement

type TableRangeOutputPlacement =
  | { kind: "new-sheet"; name: string; sheetKey: string }
  | { kind: "current-anchor"; sheetKey: string }
  | { kind: "existing-range"; sheetKey: string; anchor: CellAnchor }
  | { kind: "connection-only" };

TableRangeSelector

type TableRangeSelector = { kind: "table"; tableName: string } | { kind: "range"; rangeRef: string };

TableRangeSourceIdentity

interface TableRangeSourceIdentity {
  workbookScope: string;
  sheetName: string;
  selector: TableRangeSelector;
}