Skip to content
SumOfficeSumOfficeSumOffice
Menu
What SumOffice isProduct and deliveryAI and MCPContact us
Overview
SumSheet — what it isCapability map next to ExcelArchitecture: four layers and objectsWhat happens from open to saveStrengths and tradeoffs
Getting started
Installing SumSheetQuick start: your first project
Guides
How the API session worksRequests used in the exampleResponding to clicks and the context menuIntegrating into an applicationEmbedding kit: structure, events, menuSurface eventsDiagnosticsVerified script
Runtimes
The core in the browser through WebAssemblyA separate core process alongside your applicationSumSheet as a server-side processorPhone and tabletRuntime environments and the end-to-end scenario
Contract and boundaries
Readiness checklistFrom concept to pilotSumSheet version history
Examples
Live example: a budget spreadsheetSumSheet examplesMinimal sheetSheet with the ribbonEmbedding into a third-party pageA million rowsCrosshairRead-onlyCustom headersSheet without header stripsCustom menu itemCustom keyboard shortcutCustom languageDrop a workbook hereTwo people in one documentAssistants drive the sheetCustom eventHyperlinkFind and replaceNotesSheet outlinePage layoutAllow editing rangesWorkbook linksHeadless
Reference
SumSheet referenceSumSheet transport and message formatSumSheet session and conventionsWhat you can do with each formatSession and workbookCells and rangesSheetsPrinting and layoutFormulas and calculationFormattingData, filters, and objectsPivot tablesPower Query: M expressionsPower Query: connectorsPower Query: queries and stepsPower Query: tables from queriesPower Query: execution and progressPower Query: trust and privacyPower Query: external mashupsVBA and macrosProtection and reviewTypes: session, workbook, and sheetsTypes: cells and rangesTypes: formulas and calculationTypes: formattingTypes: data and sheet objectsTypes: pivot tablesTypes: charts and graphicsTypes: printing and page layoutTypes: Power QueryTypes: VBA and macrosTypes: protection and reviewTypes: general and utility

Types: pivot tables

Compute Contract type definitions — cache, fields, layout, grouping, and value settings. Names: 125.

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 — 125

ContractPivotCacheOptionsAction

Section titled “ContractPivotCacheOptionsAction”
type ContractPivotCacheOptionsAction =
  | { action: "list"; cacheId?: string
  | null; pivotTableName?: string
  | null }
  | { action: "apply";
    cacheId: string;
    pivotTableName: string;
    settings: ContractPivotCacheOptionsSettings;
  expectedCacheGeneration?: number
  | null; expectedCohortPivotNames?: string[]; }
  | { action: "refresh_current"; cacheId: string; expectedCacheGeneration?: number
  | null; }
  | { action: "start_refresh_current"; cacheId: string; expectedCacheGeneration?: number
  | null; }
  | { action: "start_refresh_all" }
  | { action: "refresh_status"; generation?: number
  | null; advance?: boolean }
  | { action: "cancel_refresh"; generation: number }
  | { action: "connection_properties"; cacheId: string; pivotTableName: string }
  | { action: "change_source";
    cacheId: string;
    pivotTableName: string;
    source: ContractPivotCacheSource;
  expectedCacheGeneration?: number
  | null; expectedCohortPivotNames?: string[]; }
  | { action: "create_consolidation";
    pivotTableName: string;
    destinationSheetPath: string;
    destinationAnchor: string;
    ranges: ContractPivotConsolidationRangeInput[];
    pageFieldMode: ContractPivotConsolidationPageFieldMode;
    pageFieldNames?: string[];
  }
  | { action: "apply_consolidation";
    cacheId: string;
    pivotTableName: string;
    ranges: ContractPivotConsolidationRangeInput[];
    pageFieldMode: ContractPivotConsolidationPageFieldMode;
    pageFieldNames?: string[];
  expectedCacheGeneration?: number
  | null; }
  | { action: "refresh_consolidation"; cacheId: string; expectedCacheGeneration?: number
  | null; }
  | { action: "refresh_all" }
  | { action: "cancel" }
  | { action: "undo" }
  | { action: "redo" };

ContractPivotCacheOptionsSettings

Section titled “ContractPivotCacheOptionsSettings”
interface ContractPivotCacheOptionsSettings {
  refreshDataOnOpen: boolean;
  saveSourceData: boolean;
  enableShowDetails: boolean;
  preserveFormatting?: boolean | null;
  autofitColumnsOnUpdate?: boolean | null;
  showItemsWithNoDataOnRows?: boolean | null;
  showItemsWithNoDataOnColumns?: boolean | null;
  showEmptyCells?: boolean | null;
  emptyDisplayValue?: string | null;
  showErrorValues?: boolean | null;
  errorDisplayValue?: string | null;
  classicLayout?: boolean | null;
  mergeAndCenterLabels?: boolean | null;
  printExpandCollapseButtons?: boolean | null;
  repeatItemLabels?: boolean | null;
  altTextTitle?: string | null;
  altTextDescription?: string | null;
  retainDeletedItems: ContractPivotDeletedItemsRetention;
  retainedItemLimit?: number | null;
}

ContractPivotCacheOptionsView

Section titled “ContractPivotCacheOptionsView”
interface ContractPivotCacheOptionsView {
  cacheId: string;
  cacheGeneration: number;
  pivotTableName: string;
  pivotTablePath: string;
  sheetPath: string;
  cohortPivotNames: string[];
  retainedDeletedItemCount: number;
  refreshStatus: string;
  refresh: ContractPivotRefreshStatusView;
  connection: ContractPivotConnectionPropertiesView;
  settings: ContractPivotCacheOptionsSettings;
  hasRowFields: boolean;
  hasColumnFields: boolean;
  stale: boolean;
  readOnly: boolean;
  protected: boolean;
  sourceAvailable: boolean;
  source: ContractPivotCacheSource;
  multipleConsolidation?: ContractPivotMultipleConsolidationView | null;
  unsupportedReason?: string | null;
}

ContractPivotCacheSource

Section titled “ContractPivotCacheSource”
type ContractPivotCacheSource =
  | { kind: "table"; tableName: string }
  | { kind: "range"; sheetName: string; reference: string }
  | { kind: "multiple_ranges";
    ranges: ContractPivotConsolidationRangeInput[];
    pageFieldMode: ContractPivotConsolidationPageFieldMode;
    pageFieldNames?: string[];
  };

ContractPivotCalculatedCacheView

Section titled “ContractPivotCalculatedCacheView”
interface ContractPivotCalculatedCacheView {
  cacheId: string;
  cacheIdentity: string;
  pivotTableNames: string[];
  sourceFields: ContractPivotCalculatedSourceFieldView[];
  refreshGeneration: number;
  refreshedRowCount: number;
  stale: boolean;
  readOnly: boolean;
  protected: boolean;
}

ContractPivotCalculatedFieldView

Section titled “ContractPivotCalculatedFieldView”
interface ContractPivotCalculatedFieldView {
  id: string;
  cacheId: string;
  name: string;
  formula: string;
  summaryFunction: ContractPivotCalculatedSummaryFunction;
  dependencies: string[];
  creationOrdinal: number;
  refreshGeneration: number;
  lastValue?: number | null;
  lastError?: string | null;
  rowErrorCount: number;
}

ContractPivotCalculatedFieldsAction

Section titled “ContractPivotCalculatedFieldsAction”
type ContractPivotCalculatedFieldsAction =
  | { action: "list"; cacheId?: string
  | null; pivotTableName?: string }
  | { action: "register_pending";
    cacheId: string;
    sourceSheet: string;
    sourceRef: string;
    sourceFields: string[];
    pivotTableName: string;
    pivotTableSheetPath: string;
    outputRef: string;
    rowFields: string[];
    columnFields: string[];
  }
  | { action: "create";
    cacheId: string;
    pivotTableName?: string;
    name: string;
    formula: string;
    summaryFunction: ContractPivotCalculatedSummaryFunction;
  }
  | { action: "edit";
    cacheId: string;
    pivotTableName?: string;
    fieldId: string;
    name: string;
    formula: string;
    summaryFunction: ContractPivotCalculatedSummaryFunction;
  }
  | { action: "delete"; cacheId: string; fieldId: string }
  | { action: "reorder";
    cacheId: string;
    fieldId: string;
    direction: ContractPivotCalculationMoveDirection;
    expectedRefreshGeneration: number;
  }
  | { action: "refresh_current"; cacheId: string }
  | { action: "refresh_all" }
  | { action: "rename_source_field"; cacheId: string; fieldOrdinal: number; name: string; }
  | { action: "rename_pivot_table"; cacheId: string; oldName: string; newName: string; }
  | { action: "undo" }
  | { action: "redo" };

ContractPivotCalculatedItemAxis

Section titled “ContractPivotCalculatedItemAxis”
type ContractPivotCalculatedItemAxis = "row" | "column";

ContractPivotCalculatedItemFieldView

Section titled “ContractPivotCalculatedItemFieldView”
interface ContractPivotCalculatedItemFieldView {
  cacheId: string;
  fieldOrdinal: number;
  fieldName: string;
  axes: ContractPivotCalculatedItemAxis[];
  memberNames: string[];
  stale: boolean;
  readOnly: boolean;
  protected: boolean;
}

ContractPivotCalculatedItemView

Section titled “ContractPivotCalculatedItemView”
interface ContractPivotCalculatedItemView {
  id: string;
  cacheId: string;
  fieldOrdinal: number;
  fieldName: string;
  axis: ContractPivotCalculatedItemAxis;
  name: string;
  formula: string;
  dependencies: string[];
  creationOrdinal: number;
  refreshGeneration: number;
  lastCountValue?: number | null;
  lastError?: string | null;
  pivotTableNames: string[];
}

ContractPivotCalculatedItemsAction

Section titled “ContractPivotCalculatedItemsAction”
type ContractPivotCalculatedItemsAction =
  | { action: "list"; cacheId?: string
  | null; fieldOrdinal?: number
  | null; pivotTableName?: string
  | null; }
  | { action: "create";
    cacheId: string;
    fieldOrdinal: number;
    axis: ContractPivotCalculatedItemAxis;
  pivotTableName?: string
  | null; name: string; formula: string; }
  | { action: "edit"; cacheId: string; itemId: string; name: string; formula: string; }
  | { action: "delete"; cacheId: string; itemId: string }
  | { action: "reorder";
    cacheId: string;
    itemId: string;
    direction: ContractPivotCalculationMoveDirection;
    expectedRefreshGeneration: number;
  }
  | { action: "refresh_current"; cacheId: string }
  | { action: "refresh_all" }
  | { action: "rename_source_field"; cacheId: string; fieldOrdinal: number; name: string; }
  | { action: "rename_pivot_table"; cacheId: string; oldName: string; newName: string; }
  | { action: "undo" }
  | { action: "redo" };

ContractPivotCalculatedSourceFieldView

Section titled “ContractPivotCalculatedSourceFieldView”
interface ContractPivotCalculatedSourceFieldView {
  ordinal: number;
  name: string;
  scalarKind: string;
  referenceText: string;
}

ContractPivotCalculatedSummaryFunction

Section titled “ContractPivotCalculatedSummaryFunction”
type ContractPivotCalculatedSummaryFunction = "sum" | "count" | "average";

ContractPivotCalculationMoveDirection

Section titled “ContractPivotCalculationMoveDirection”
type ContractPivotCalculationMoveDirection = "up" | "down";

ContractPivotConditionalArea

Section titled “ContractPivotConditionalArea”
type ContractPivotConditionalArea = "data" | "subtotal" | "rowGrandTotal" | "columnGrandTotal" | "grandTotal";

ContractPivotConditionalCellIdentity

Section titled “ContractPivotConditionalCellIdentity”
interface ContractPivotConditionalCellIdentity {
  dataFieldIndex?: number | null;
  rowItems: ContractPivotConditionalItemIdentity[];
  columnItems: ContractPivotConditionalItemIdentity[];
  area: ContractPivotConditionalArea;
}

ContractPivotConditionalItemIdentity

Section titled “ContractPivotConditionalItemIdentity”
interface ContractPivotConditionalItemIdentity {
  fieldOrdinal: number;
  itemId: string;
}

ContractPivotConditionalRuleScope

Section titled “ContractPivotConditionalRuleScope”
interface ContractPivotConditionalRuleScope {
  cacheId: string;
  pivotTableName: string;
  expectedGeneration: number;
  scope: ContractPivotConditionalScope;
}

ContractPivotConditionalScope

Section titled “ContractPivotConditionalScope”
type ContractPivotConditionalScope =
  | { type: "selectedCells"; cells: ContractPivotConditionalCellIdentity[] }
  | { type: "valueField"; dataFieldIndex: number }
  | { type: "fieldCombination"; dataFieldIndex?: number
  | null; rowItems: ContractPivotConditionalItemIdentity[]; columnItems: ContractPivotConditionalItemIdentity[]; includeSubtotals: boolean; includeGrandTotals: boolean; }
  | { type: "area"; area: ContractPivotConditionalArea };

ContractPivotConnectionPropertiesView

Section titled “ContractPivotConnectionPropertiesView”
interface ContractPivotConnectionPropertiesView {
  identity: string;
  sourceKind: string;
  properties: ContractPivotConnectionPropertyView[];
}

ContractPivotConnectionPropertyView

Section titled “ContractPivotConnectionPropertyView”
interface ContractPivotConnectionPropertyView {
  key: string;
  value: string;
  applicable: boolean;
  editable: boolean;
  disabledReasonCode?: string | null;
  disabledReasonDetail?: string | null;
}

ContractPivotConsolidationPageFieldMode

Section titled “ContractPivotConsolidationPageFieldMode”
type ContractPivotConsolidationPageFieldMode = "automatic" | "manual";

ContractPivotConsolidationRangeInput

Section titled “ContractPivotConsolidationRangeInput”
interface ContractPivotConsolidationRangeInput {
  stableId?: string | null;
  sheetName: string;
  reference: string;
  pageItems?: string[];
}

ContractPivotConsolidationRangeView

Section titled “ContractPivotConsolidationRangeView”
interface ContractPivotConsolidationRangeView {
  stableId: string;
  sheetName: string;
  sheetPath: string;
  reference: string;
  pageItems: string[];
  valueCount: number;
}

ContractPivotCopyCacheOwnership

Section titled “ContractPivotCopyCacheOwnership”
type ContractPivotCopyCacheOwnership = "share_source_cache" | "independent_cache";

ContractPivotDataModelOlapInventory

Section titled “ContractPivotDataModelOlapInventory”
interface ContractPivotDataModelOlapInventory {
  connections: ContractPivotReadonlyConnection[];
  pivotTables: ContractPivotReadonlyTable[];
  cacheDefinitions: ContractPivotReadonlyCache[];
  modelParts: ContractPivotReadonlyOpaquePart[];
  slicerParts: ContractPivotReadonlyOpaquePart[];
  unknownParts: ContractPivotReadonlyOpaquePart[];
  signatureParts: ContractPivotReadonlyOpaquePart[];
  relationships: ContractPivotReadonlyRelationship[];
  unknownExtensionUris: string[];
  entityCount: number;
}

ContractPivotDataModelOlapReadonlyAction

Section titled “ContractPivotDataModelOlapReadonlyAction”
type ContractPivotDataModelOlapReadonlyAction =
  | { action: "inspect"; pivotTablePath?: string
  | null }
  | { action: "filter"; pivotTablePath: string }
  | { action: "edit"; pivotTablePath: string }
  | { action: "refresh"; pivotTablePath: string }
  | { action: "drillthrough"; pivotTablePath: string }
  | { action: "select"; entityStableId: string }
  | { action: "navigate"; entityStableId: string }
  | { action: "mutate"; entityStableId?: string
  | null; mutation: ContractPivotReadonlyMutationKind; };

ContractPivotDateGroupPeriod

Section titled “ContractPivotDateGroupPeriod”
type ContractPivotDateGroupPeriod = "years" | "quarters" | "months" | "days";

ContractPivotDeletedItemsRetention

Section titled “ContractPivotDeletedItemsRetention”
type ContractPivotDeletedItemsRetention = "automatic" | "none" | "maximum";

ContractPivotDetailCellRef

Section titled “ContractPivotDetailCellRef”
interface ContractPivotDetailCellRef {
  sheetPath: string;
  row: number;
  col: number;
}

ContractPivotDetailContextView

Section titled “ContractPivotDetailContextView”
interface ContractPivotDetailContextView {
  cacheIdentity: string;
  cacheGeneration: number;
  showDetailsEnabled: boolean;
  rowItems: ContractPivotGroupingItemKey[];
  columnItems: ContractPivotGroupingItemKey[];
  filterItems: ContractPivotGroupingItemKey[];
}

ContractPivotDetailLineageView

Section titled “ContractPivotDetailLineageView”
interface ContractPivotDetailLineageView {
  id: string;
  pivotTableName: string;
  cacheId: string;
  cacheGeneration: number;
  sourceSheet: string;
  sourceRef: string;
  detailSheetName: string;
  detailSheetPath: string;
  selectedRowCount: number;
  rowItems: ContractPivotGroupingItemKey[];
  columnItems: ContractPivotGroupingItemKey[];
  filterItems: ContractPivotGroupingItemKey[];
}

ContractPivotExpandedItemView

Section titled “ContractPivotExpandedItemView”
interface ContractPivotExpandedItemView {
  cacheId: string;
  pivotTableName: string;
  fieldOrdinal: number;
  itemId: string;
  expanded: boolean;
}

ContractPivotFieldAggregation

Section titled “ContractPivotFieldAggregation”
type ContractPivotFieldAggregation = | "sum" | "count" | "average" | "max" | "min" | "product" | "count_numbers" | "std_dev" | "variance";

ContractPivotFieldArea

Section titled “ContractPivotFieldArea”
type ContractPivotFieldArea = "filters" | "columns" | "rows" | "values";

ContractPivotFieldListAuthoringAction

Section titled “ContractPivotFieldListAuthoringAction”
type ContractPivotFieldListAuthoringAction =
  | { action: "list"; cacheId?: string
  | null; pivotTableName?: string
  | null }
  | { action: "mutate";
    cacheId: string;
    pivotTableName: string;
    expectedPivotTablePath: string;
    expectedCacheIdentity: string;
    expectedCacheGeneration: number;
    expectedLayoutRevision: number;
    deferLayoutUpdate: boolean;
    mutations: ContractPivotFieldMutation[];
  }
  | { action: "apply_deferred";
    cacheId: string;
    pivotTableName: string;
    expectedPivotTablePath: string;
    expectedCacheIdentity: string;
    expectedCacheGeneration: number;
    expectedLayoutRevision: number;
  }
  | { action: "cancel_deferred";
    cacheId: string;
    pivotTableName: string;
    expectedPivotTablePath: string;
    expectedCacheIdentity: string;
    expectedCacheGeneration: number;
    expectedLayoutRevision: number;
  }
  | { action: "undo" }
  | { action: "redo" };

ContractPivotFieldListFieldView

Section titled “ContractPivotFieldListFieldView”
interface ContractPivotFieldListFieldView {
  ordinal: number;
  name: string;
  scalarKind: string;
  calculated: boolean;
  hasCalculatedItems: boolean;
}

ContractPivotFieldListView

Section titled “ContractPivotFieldListView”
interface ContractPivotFieldListView {
  cacheId: string;
  cacheIdentity: string;
  cacheGeneration: number;
  pivotTableName: string;
  pivotTablePath: string;
  sheetPath: string;
  layoutRevision: number;
  fields: ContractPivotFieldListFieldView[];
  sourceRecords: string[][];
  sourceRecordsTruncated: boolean;
  filters: number[];
  columns: number[];
  rows: number[];
  values: ContractPivotValueFieldView[];
  valueCells: ContractPivotValueCellView[];
  deferred: boolean;
  stale: boolean;
  readOnly: boolean;
  protected: boolean;
  unsupportedReason?: string | null;
}

ContractPivotFieldMutation

Section titled “ContractPivotFieldMutation”
type ContractPivotFieldMutation =
  | { kind: "add"; fieldOrdinal: number; targetArea: ContractPivotFieldArea; targetIndex?: number
  | null; aggregation?: ContractPivotFieldAggregation
  | null; }
  | { kind: "remove"; area: ContractPivotFieldArea; fieldOrdinal?: number
  | null; occurrenceId?: string
  | null; }
  | { kind: "move"; fromArea: ContractPivotFieldArea; toArea: ContractPivotFieldArea; fieldOrdinal?: number
  | null; occurrenceId?: string
  | null; targetIndex: number; }
  | { kind: "reorder"; area: ContractPivotFieldArea; fieldOrdinal?: number
  | null; occurrenceId?: string
  | null; targetIndex: number; }
  | { kind: "duplicate_value"; occurrenceId: string; targetIndex?: number
  | null; }
  | { kind: "set_aggregation"; occurrenceId: string; aggregation: ContractPivotFieldAggregation; };

ContractPivotFilter

Section titled “ContractPivotFilter”
type ContractPivotFilter =
  | { family: "label"; operator: ContractPivotFilterOperator; first: string; second?: string
  | null; }
  | { family: "value"; operator: ContractPivotFilterOperator; first: number; second?: number
  | null; dataFieldIndex: number; }
  | { family: "date"; operator: ContractPivotFilterOperator; first: number; second?: number
  | null; }
  | { family: "top";
    mode: ContractPivotTopMode;
    unit: ContractPivotTopUnit;
    amount: number;
    dataFieldIndex: number;
  };

ContractPivotFilterConnectionView

Section titled “ContractPivotFilterConnectionView”
interface ContractPivotFilterConnectionView {
  controlId: string;
  caption: string;
  name: string;
  sheetName: string;
  kind: ContractSlicerTimelineControlKind;
  connected: boolean;
}

ContractPivotFilterOperator

Section titled “ContractPivotFilterOperator”
type ContractPivotFilterOperator = "equals" | "contains" | "begins_with" | "between";

ContractPivotGetPivotDataView

Section titled “ContractPivotGetPivotDataView”
interface ContractPivotGetPivotDataView {
  formula: string;
  cacheIdentity: string;
  cacheGeneration: number;
  pivotTableName: string;
  pivotTablePath: string;
  sheetPath: string;
  dataFieldIndex: number;
  valueFieldOrdinal: number;
  valueFieldCaption: string;
  rowItems: ContractPivotGroupingItemKey[];
  columnItems: ContractPivotGroupingItemKey[];
  filterItems: ContractPivotGroupingItemKey[];
  area:
    | "data"
    | "subtotal"
    | "row_grand_total"
    | "column_grand_total"
    | "grand_total";
}

ContractPivotGroupView

Section titled “ContractPivotGroupView”
interface ContractPivotGroupView {
  id: string;
  cacheId: string;
  fieldOrdinal: number;
  kind: string;
  caption: string;
  itemIds: string[];
  start?: number | null;
  end?: number | null;
  by?: number | null;
  datePeriods: ContractPivotDateGroupPeriod[];
  datePeriod?: ContractPivotDateGroupPeriod | null;
  dayInterval?: number | null;
}

ContractPivotGroupingCacheView

Section titled “ContractPivotGroupingCacheView”
interface ContractPivotGroupingCacheView {
  cacheId: string;
  cacheIdentity: string;
  generation: number;
  pivotTableNames: string[];
  refreshedRowCount: number;
  stale: boolean;
  readOnly: boolean;
  protected: boolean;
  unsupportedReason?: string | null;
}

ContractPivotGroupingDrilldownAction

Section titled “ContractPivotGroupingDrilldownAction”
type ContractPivotGroupingDrilldownAction =
  | { action: "list"; cacheId?: string
  | null; pivotTableName?: string
  | null; detailCell?: ContractPivotDetailCellRef
  | null; }
  | { action: "author_get_pivot_data"; detailCell: ContractPivotDetailCellRef }
  | { action: "group_numeric";
    cacheId: string;
    fieldOrdinal: number;
    start: number;
    end: number;
    by: number;
  }
  | { action: "group_date";
    cacheId: string;
    fieldOrdinal: number;
    periods: ContractPivotDateGroupPeriod[];
  dayInterval?: number
  | null; }
  | { action: "group_manual"; cacheId: string; fieldOrdinal: number; itemIds: string[]; caption: string; }
  | { action: "ungroup"; cacheId: string; fieldOrdinal: number; groupId?: string
  | null; }
  | { action: "set_expanded";
    cacheId: string;
    pivotTableName: string;
    fieldOrdinal: number;
    itemId: string;
    expanded: boolean;
  }
  | { action: "set_hierarchy_expanded"; cacheId: string; pivotTableName: string; axis: "row"
  | "column"; itemPath: ContractPivotGroupingItemKey[]; expanded: boolean; expectedCacheIdentity: string; expectedCacheGeneration: number; expectedHierarchyRevision: number; requestGeneration: number; }
  | { action: "set_hierarchy_field_expanded"; cacheId: string; pivotTableName: string; axis: "row"
  | "column"; fieldOrdinal: number; expanded: boolean; expectedCacheIdentity: string; expectedCacheGeneration: number; expectedHierarchyRevision: number; requestGeneration: number; }
  | { action: "show_details"; cacheId: string; pivotTableName: string; expectedCacheIdentity?: string
  | null; expectedCacheGeneration?: number
  | null; rowItems?: ContractPivotGroupingItemKey[]; columnItems?: ContractPivotGroupingItemKey[]; filterItems?: ContractPivotGroupingItemKey[]; }
  | { action: "refresh_current"; cacheId: string }
  | { action: "refresh_all" }
  | { action: "undo" }
  | { action: "redo" };

ContractPivotGroupingItemKey

Section titled “ContractPivotGroupingItemKey”
interface ContractPivotGroupingItemKey {
  fieldOrdinal: number;
  itemId: string;
}

ContractPivotGroupingItemView

Section titled “ContractPivotGroupingItemView”
interface ContractPivotGroupingItemView {
  id: string;
  cacheId: string;
  fieldOrdinal: number;
  fieldName: string;
  label: string;
  scalarKind: string;
  retired: boolean;
  groupId?: string | null;
  groupIds: string[];
}

ContractPivotHierarchyNodeView

Section titled “ContractPivotHierarchyNodeView”
interface ContractPivotHierarchyNodeView {
  cacheId: string;
  pivotTableName: string;
  cacheIdentity: string;
  cacheGeneration: number;
  hierarchyRevision: number;
  pathId: string;
  axis: "row" | "column";
  level: number;
  itemPath: ContractPivotGroupingItemKey[];
  parentPath: ContractPivotGroupingItemKey[];
  fieldOrdinal: number;
  itemId: string;
  label: string;
  targetCell: ContractPivotDetailCellRef;
  hasChildren: boolean;
  expanded: boolean;
  visible: boolean;
  calculatedItem: boolean;
  nextLevelFieldOrdinal?: number | null;
}

ContractPivotLayoutFormatAction

Section titled “ContractPivotLayoutFormatAction”
type ContractPivotLayoutFormatAction =
  | { action: "list"; cacheId?: string
  | null; pivotTableName?: string
  | null }
  | { action: "apply"; cacheId: string; pivotTableName: string; options: ContractPivotLayoutFormatOptions; }
  | { action: "cancel"; cacheId: string; pivotTableName: string }
  | { action: "refresh_current"; cacheId: string }
  | { action: "refresh_all" }
  | { action: "undo" }
  | { action: "redo" };

ContractPivotLayoutFormatOptions

Section titled “ContractPivotLayoutFormatOptions”
interface ContractPivotLayoutFormatOptions {
  reportLayout: ContractPivotReportLayout;
  repeatItemLabels: boolean;
  insertBlankRows: boolean;
  pageBreakAfter: ContractPivotPageBreakAfter;
  printTitles: boolean;
  repeatHeaders: boolean;
  subtotals: ContractPivotSubtotalPosition;
  rowGrandTotals: boolean;
  columnGrandTotals: boolean;
  fieldHeaders: boolean;
  showEmpty: boolean;
  emptyCaption: string;
  showError: boolean;
  errorCaption: string;
  preserveFormatting: boolean;
  styleName: string;
}

ContractPivotLayoutFormatView

Section titled “ContractPivotLayoutFormatView”
interface ContractPivotLayoutFormatView {
  cacheId: string;
  cacheGeneration: number;
  pivotTableName: string;
  pivotTablePath: string;
  sheetPath: string;
  rowFieldOrdinals: number[];
  options: ContractPivotLayoutFormatOptions;
  printPreview: ContractPivotPrintPreviewProjection;
  stale: boolean;
  readOnly: boolean;
  protected: boolean;
  unsupportedReason?: string | null;
}

ContractPivotMoveCopyAction

Section titled “ContractPivotMoveCopyAction”
type ContractPivotMoveCopyAction =
  | { action: "list"; cacheId?: string
  | null; pivotTableName?: string
  | null }
  | { action: "move";
    cacheId: string;
    pivotTableName: string;
    expectedGeneration: number;
    destination: ContractPivotMoveCopyDestination;
  }
  | { action: "copy";
    cacheId: string;
    pivotTableName: string;
    expectedGeneration: number;
    destination: ContractPivotMoveCopyDestination;
    cacheOwnership: ContractPivotCopyCacheOwnership;
  }
  | { action: "cross_workbook_copy";
    cacheId: string;
    pivotTableName: string;
    targetSubsetId: string;
    destination: ContractPivotMoveCopyDestination;
  }
  | { action: "cancel" }
  | { action: "undo" }
  | { action: "redo" };

ContractPivotMoveCopyDestination

Section titled “ContractPivotMoveCopyDestination”
type ContractPivotMoveCopyDestination =
  | { kind: "existing_sheet"; sheetPath: string; anchor: string }
  | { kind: "new_sheet"; sheetName: string; anchor: string };

ContractPivotMoveCopySheetView

Section titled “ContractPivotMoveCopySheetView”
interface ContractPivotMoveCopySheetView {
  sheetName: string;
  sheetPath: string;
  loaded: boolean;
  protected: boolean;
}

ContractPivotMoveCopyView

Section titled “ContractPivotMoveCopyView”
interface ContractPivotMoveCopyView {
  cacheId: string;
  cacheGeneration: number;
  pivotTableName: string;
  pivotTablePath: string;
  sheetName: string;
  sheetPath: string;
  outputRef: string;
  cohortPivotNames: string[];
  cacheOwnership: ContractPivotCopyCacheOwnership;
  stale: boolean;
  readOnly: boolean;
  protected: boolean;
  unsupportedReason?: string | null;
}

ContractPivotMultipleConsolidationView

Section titled “ContractPivotMultipleConsolidationView”
interface ContractPivotMultipleConsolidationView {
  pageFieldMode: ContractPivotConsolidationPageFieldMode;
  pageFieldNames: string[];
  ranges: ContractPivotConsolidationRangeView[];
  recordCount: number;
}

ContractPivotPageBreakAfter

Section titled “ContractPivotPageBreakAfter”
type ContractPivotPageBreakAfter = "none" | "item" | "cohort";

ContractPivotPrintAreaState

Section titled “ContractPivotPrintAreaState”
type ContractPivotPrintAreaState = "none" | "disjoint" | "contains_pivot";

ContractPivotPrintPreviewProjection

Section titled “ContractPivotPrintPreviewProjection”
interface ContractPivotPrintPreviewProjection {
  outputRef: string;
  printAreaState: ContractPivotPrintAreaState;
  fitToPage: boolean;
  fitToWidth: number;
  fitToHeight: number;
  worksheetScalePercent: number;
  effectiveScalePercent: number;
  pagesAcross: number;
  pagesDown: number;
  pageCount: number;
  rowBreaks: ContractPageBreakLine[];
  columnBreaks: ContractPageBreakLine[];
  repeatsFieldTitles: boolean;
  repeatsItemHeaders: boolean;
}

ContractPivotRankDirection

Section titled “ContractPivotRankDirection”
type ContractPivotRankDirection = "small_to_large" | "large_to_small";

ContractPivotReadonlyCache

Section titled “ContractPivotReadonlyCache”
interface ContractPivotReadonlyCache {
  partPath: string;
  connectionId: string | null;
  sourceKind: ContractPivotReadonlySourceKind;
  recordCount: number | null;
  extensionUris: string[];
  hierarchies: ContractPivotReadonlyNamedItem[];
  measures: ContractPivotReadonlyNamedItem[];
  kpis: ContractPivotReadonlyNamedItem[];
  namedSets: ContractPivotReadonlyNamedItem[];
  cubeFields: ContractPivotReadonlyNamedItem[];
}

ContractPivotReadonlyCapability

Section titled “ContractPivotReadonlyCapability”
interface ContractPivotReadonlyCapability {
  command: string;
  state: ContractPivotReadonlyCapabilityState;
  available: boolean;
  reasonCode: string | null;
}

ContractPivotReadonlyCapabilityState

Section titled “ContractPivotReadonlyCapabilityState”
type ContractPivotReadonlyCapabilityState = "live" | "disabled" | "blocked";

ContractPivotReadonlyConnection

Section titled “ContractPivotReadonlyConnection”
interface ContractPivotReadonlyConnection {
  stableId: string;
  id: string;
  name: string;
  connectionType: number | null;
  sourceKind: ContractPivotReadonlySourceKind;
  credentialsPresent: boolean;
  capabilities: ContractPivotReadonlyCapability[];
}

ContractPivotReadonlyEntityKind

Section titled “ContractPivotReadonlyEntityKind”
type ContractPivotReadonlyEntityKind = | "measure" | "kpi" | "named_set" | "cube_field" | "hierarchy" | "calculated_member";

ContractPivotReadonlyField

Section titled “ContractPivotReadonlyField”
interface ContractPivotReadonlyField {
  stableId: string;
  name: string;
  caption: string;
  hierarchyIndex: number | null;
  capabilities: ContractPivotReadonlyCapability[];
}

ContractPivotReadonlyMutationKind

Section titled “ContractPivotReadonlyMutationKind”
type ContractPivotReadonlyMutationKind = "create" | "edit" | "rename" | "delete" | "author" | "evaluate";

ContractPivotReadonlyNamedItem

Section titled “ContractPivotReadonlyNamedItem”
interface ContractPivotReadonlyNamedItem {
  stableId: string;
  ownerPath: string;
  entityKind: ContractPivotReadonlyEntityKind;
  ordinal: number;
  name: string;
  caption: string;
  expressionPresent: boolean;
  capabilities: ContractPivotReadonlyCapability[];
}

ContractPivotReadonlyOpaquePart

Section titled “ContractPivotReadonlyOpaquePart”
interface ContractPivotReadonlyOpaquePart {
  path: string;
  byteCount: number;
  sha256: string;
}

ContractPivotReadonlyRelationship

Section titled “ContractPivotReadonlyRelationship”
interface ContractPivotReadonlyRelationship {
  sourcePath: string;
  relationshipId: string;
  relationshipType: string;
  target: string;
  external: boolean;
}

ContractPivotReadonlySourceKind

Section titled “ContractPivotReadonlySourceKind”
type ContractPivotReadonlySourceKind = "data_model" | "olap";

ContractPivotReadonlyTable

Section titled “ContractPivotReadonlyTable”
interface ContractPivotReadonlyTable {
  partPath: string;
  name: string;
  cacheId: string | null;
  sourceKind: ContractPivotReadonlySourceKind;
  hierarchies: ContractPivotReadonlyNamedItem[];
  measures: ContractPivotReadonlyNamedItem[];
  kpis: ContractPivotReadonlyNamedItem[];
  namedSets: ContractPivotReadonlyNamedItem[];
  cubeFields: ContractPivotReadonlyNamedItem[];
  calculatedMembers: ContractPivotReadonlyNamedItem[];
  fields: ContractPivotReadonlyField[];
  capabilities: ContractPivotReadonlyCapability[];
}

ContractPivotRefreshState

Section titled “ContractPivotRefreshState”
type ContractPivotRefreshState = "idle" | "queued" | "running" | "cancelling" | "committed" | "failed";

ContractPivotRefreshStatusView

Section titled “ContractPivotRefreshStatusView”
interface ContractPivotRefreshStatusView {
  generation: number;
  state: ContractPivotRefreshState;
  target: string;
  cacheIds: string[];
  cohortPivotNames: string[];
  completedUnits: number;
  totalUnits: number;
  progressPercent: number;
  canCancel: boolean;
  lastErrorCode?: string | null;
  lastErrorDetail?: string | null;
}

ContractPivotReportFilterFieldView

Section titled “ContractPivotReportFilterFieldView”
interface ContractPivotReportFilterFieldView {
  fieldOrdinal: number;
  caption: string;
  allSelected: boolean;
  selectedItemIds: string[];
  items: ContractPivotReportFilterItemView[];
}

ContractPivotReportFilterItemView

Section titled “ContractPivotReportFilterItemView”
interface ContractPivotReportFilterItemView {
  itemId: string;
  label: string;
  scalarKind: string;
  retired: boolean;
  selected: boolean;
}

ContractPivotReportFilterPageView

Section titled “ContractPivotReportFilterPageView”
interface ContractPivotReportFilterPageView {
  sheetName: string;
  sheetPath: string;
  pivotTableName: string;
  pivotTablePath: string;
  selections: ContractPivotReportFilterSelection[];
}

ContractPivotReportFilterPagesAction

Section titled “ContractPivotReportFilterPagesAction”
type ContractPivotReportFilterPagesAction =
  | { action: "list"; cacheId?: string
  | null; pivotTableName?: string
  | null }
  | { action: "apply";
    cacheId: string;
    pivotTableName: string;
    expectedGeneration: number;
    selections: ContractPivotReportFilterSelection[];
  }
  | { action: "show_report_filter_pages";
    cacheId: string;
    pivotTableName: string;
    expectedGeneration: number;
    fieldOrdinals: number[];
  }
  | { action: "refresh_current"; cacheId: string }
  | { action: "refresh_all" }
  | { action: "cancel" }
  | { action: "undo" }
  | { action: "redo" };

ContractPivotReportFilterSelection

Section titled “ContractPivotReportFilterSelection”
interface ContractPivotReportFilterSelection {
  fieldOrdinal: number;


  selectedItemIds: string[];
}

ContractPivotReportFilterView

Section titled “ContractPivotReportFilterView”
interface ContractPivotReportFilterView {
  cacheId: string;
  cacheGeneration: number;
  pivotTableName: string;
  pivotTablePath: string;
  sheetPath: string;
  cohortPivotNames: string[];
  fields: ContractPivotReportFilterFieldView[];
  stale: boolean;
  readOnly: boolean;
  protected: boolean;
  unsupportedReason?: string | null;
}

ContractPivotReportLayout

Section titled “ContractPivotReportLayout”
type ContractPivotReportLayout = "compact" | "outline" | "tabular";

ContractPivotShowValuesAs

Section titled “ContractPivotShowValuesAs”
type ContractPivotShowValuesAs =
  | "normal"
  | "percent_grand_total"
  | "percent_row_total"
  | "percent_column_total"
  | "percent_parent_row_total"
  | "percent_parent_column_total"
  | "percent_parent_total"
  | "difference_from"
  | "percent_difference_from"
  | "running_total"
  | "percent_running_total"
  | "rank_small_to_large"
  | "rank_large_to_small"
  | "index";

ContractPivotSortFilterAction

Section titled “ContractPivotSortFilterAction”
type ContractPivotSortFilterAction =
  | { action: "list"; cacheId?: string
  | null; pivotTableName?: string
  | null; fieldOrdinal?: number
  | null; }
  | { action: "apply";
    cacheId: string;
    pivotTableName: string;
    expectedGeneration: number;
    settings: ContractPivotSortFilterSettings;
  }
  | { action: "clear";
    cacheId: string;
    pivotTableName: string;
    expectedGeneration: number;
  fieldOrdinal?: number
  | null; }
  | { action: "reapply"; cacheId: string; pivotTableName: string; expectedGeneration: number; }
  | { action: "refresh_current"; cacheId: string }
  | { action: "refresh_all" }
  | { action: "undo" }
  | { action: "redo" };

ContractPivotSortFilterItemView

Section titled “ContractPivotSortFilterItemView”
interface ContractPivotSortFilterItemView {
  itemId: string;
  label: string;
  scalarKind: string;
  retired: boolean;
  visible: boolean;
  aggregate?: number | null;
  rank?: number | null;
}

ContractPivotSortFilterSettings

Section titled “ContractPivotSortFilterSettings”
interface ContractPivotSortFilterSettings {
  fieldOrdinal: number;
  sort: ContractPivotSortMode;
  filters: ContractPivotFilter[];
  selectedItemIds?: string[] | null;
  includeNewItems: boolean;
  rankDirection: ContractPivotRankDirection;
}

ContractPivotSortFilterView

Section titled “ContractPivotSortFilterView”
interface ContractPivotSortFilterView {
  cacheId: string;
  cacheGeneration: number;
  pivotTableName: string;
  pivotTablePath: string;
  sheetPath: string;
  fieldCaption: string;
  fieldAxis: "row" | "column" | "report" | "other";
  settings: ContractPivotSortFilterSettings;
  orderedItemIds: string[];
  visibleItemIds: string[];
  items: ContractPivotSortFilterItemView[];
  stale: boolean;
  readOnly: boolean;
  protected: boolean;
  unsupportedReason?: string | null;
}

ContractPivotSortMode

Section titled “ContractPivotSortMode”
type ContractPivotSortMode =
  | { kind: "manual"; itemIds: string[] }
  | { kind: "label_ascending" }
  | { kind: "label_descending" }
  | { kind: "value_ascending"; dataFieldIndex: number }
  | { kind: "value_descending"; dataFieldIndex: number }
  | { kind: "custom_list"; values: string[] };

ContractPivotSubtotalPosition

Section titled “ContractPivotSubtotalPosition”
type ContractPivotSubtotalPosition = "off" | "top" | "bottom";

ContractPivotTopMode

Section titled “ContractPivotTopMode”
type ContractPivotTopMode = "top" | "bottom";

ContractPivotTopUnit

Section titled “ContractPivotTopUnit”
type ContractPivotTopUnit = "items" | "percent" | "sum";

ContractPivotValueBaseFieldView

Section titled “ContractPivotValueBaseFieldView”
interface ContractPivotValueBaseFieldView {
  ordinal: number;
  caption: string;
  items: ContractPivotValueBaseItemView[];
}

ContractPivotValueBaseItemView

Section titled “ContractPivotValueBaseItemView”
interface ContractPivotValueBaseItemView {
  id: string;
  index: number;
  label: string;
  retired: boolean;
}

ContractPivotValueCellView

Section titled “ContractPivotValueCellView”
interface ContractPivotValueCellView {
  occurrenceId: string;
  rowItems: string[];
  columnItems: string[];
  display: string;
}

ContractPivotValueFieldSettings

Section titled “ContractPivotValueFieldSettings”
interface ContractPivotValueFieldSettings {
  fieldOrdinal: number;
  dataFieldIndex: number;
  fieldCaption: string;
  customCaption: string;
  summaryFunction: ContractPivotValueSummaryFunction;
  showValuesAs: ContractPivotShowValuesAs;
  baseFieldOrdinal?: number | null;
  baseItemId?: string | null;
  baseItemIndex?: number | null;
  numberFormatId: number;
}

ContractPivotValueFieldSettingsAction

Section titled “ContractPivotValueFieldSettingsAction”
type ContractPivotValueFieldSettingsAction =
  | { action: "list"; cacheId?: string
  | null; pivotTableName?: string
  | null }
  | { action: "apply"; cacheId: string; pivotTableName: string; settings: ContractPivotValueFieldSettings; }
  | { action: "refresh_current"; cacheId: string }
  | { action: "refresh_all" }
  | { action: "undo" }
  | { action: "redo" };

ContractPivotValueFieldSettingsView

Section titled “ContractPivotValueFieldSettingsView”
interface ContractPivotValueFieldSettingsView {
  cacheId: string;
  cacheGeneration: number;
  pivotTableName: string;
  pivotTablePath: string;
  sheetPath: string;
  settings: ContractPivotValueFieldSettings;
  baseFields: ContractPivotValueBaseFieldView[];
  stale: boolean;
  readOnly: boolean;
  protected: boolean;
  unsupportedReason?: string | null;
}

ContractPivotValueFieldView

Section titled “ContractPivotValueFieldView”
interface ContractPivotValueFieldView {
  occurrenceId: string;
  fieldOrdinal: number;
  caption: string;
  aggregation: ContractPivotFieldAggregation;
}

ContractPivotValueSummaryFunction

Section titled “ContractPivotValueSummaryFunction”
type ContractPivotValueSummaryFunction = | "sum" | "count" | "average" | "max" | "min" | "product" | "count_numbers" | "std_dev" | "variance";

ContractXlsxPivotCalculatedFieldMaterialization

Section titled “ContractXlsxPivotCalculatedFieldMaterialization”
interface ContractXlsxPivotCalculatedFieldMaterialization {
  name: string;
  formula: string;
  summaryFunction: "sum" | "count" | "average" | "min" | "max";
}

ContractXlsxPivotCalculatedPresentationMaterialization

Section titled “ContractXlsxPivotCalculatedPresentationMaterialization”
interface ContractXlsxPivotCalculatedPresentationMaterialization {
  columnLabelsCaption: string;
  rowLabelsCaption: string;
  grandTotalCaption: string;
  columnWidths: ContractColumnWidth[];
}

ContractXlsxPivotCalculatedStateMaterialization

Section titled “ContractXlsxPivotCalculatedStateMaterialization”
interface ContractXlsxPivotCalculatedStateMaterialization {
  calculatedFields: ContractXlsxPivotCalculatedFieldMaterialization[];
  values: ContractXlsxPivotValueFieldMaterialization[];
  valueCells: ContractXlsxPivotValueCellMaterialization[];
  presentation?: ContractXlsxPivotCalculatedPresentationMaterialization | null;
}

ContractXlsxPivotTableCalculatedFieldPatch

Section titled “ContractXlsxPivotTableCalculatedFieldPatch”
interface ContractXlsxPivotTableCalculatedFieldPatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  fieldName: "RevenuePerUnit";
  formula: "'Revenue'/'Units'";
  summaryFunction: "sum";
  name?: string | null;


  runtimeOwner?: "rust" | null;
}

ContractXlsxPivotTableClearAllPatch

Section titled “ContractXlsxPivotTableClearAllPatch”
interface ContractXlsxPivotTableClearAllPatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  name?: string | null;


  runtimeOwner?: "rust" | null;
}

ContractXlsxPivotTableClearFiltersPatch

Section titled “ContractXlsxPivotTableClearFiltersPatch”
interface ContractXlsxPivotTableClearFiltersPatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  fieldName?: string | null;
  name?: string | null;


  runtimeOwner?: "rust" | null;
}

ContractXlsxPivotTableCreationPatch

Section titled “ContractXlsxPivotTableCreationPatch”
interface ContractXlsxPivotTableCreationPatch {
  activeSheetPath: string;
  ref: string;
  name?: string | null;
  sourceSheetName: string;
  sourceTableName?: string | null;
  sourceRef?: string | null;
  rowField: string;
  columnField: string;
  valueField: string;
  summaryFunction: "sum" | "count" | "average" | "min" | "max";
  layout?: "compact" | "outline" | "tabular" | null;
  subtotals?: "automatic" | "none" | "top" | "bottom" | null;
  rowGrandTotals?: boolean | null;
  columnGrandTotals?: boolean | null;
  showDrill?: boolean | null;
  showHeaders?: boolean | null;
  newName?: string | null;
  printDrill?: boolean | null;
  showDataTips?: boolean | null;
  classicLayout?: boolean | null;
  showError?: boolean | null;
  errorCaption?: string | null;
  showMissing?: boolean | null;
  missingCaption?: string | null;
  itemPrintTitles?: boolean | null;
  fieldPrintTitles?: boolean | null;
  multipleFieldFilters?: boolean | null;
  useAutoFormatting?: boolean | null;
  preserveFormatting?: boolean | null;
  mergeItem?: boolean | null;
  indent?: number | null;
  pageOverThenDown?: boolean | null;
  pageWrap?: number | null;
  customListSort?: boolean | null;
  saveData?: boolean | null;
  enableDrill?: boolean | null;
  refreshOnLoad?: boolean | null;
  missingItemsLimit?: "automatic" | "maximum" | null;
  altText?: string | null;
  altTextSummary?: string | null;
  styleName?: "PivotStyleMedium9" | null;
  showRowHeaders?: boolean | null;
  showColumnHeaders?: boolean | null;
  showRowStripes?: boolean | null;
  showColumnStripes?: boolean | null;


  shareCacheFromPivotName?: string | null;


  calculatedState?: ContractXlsxPivotCalculatedStateMaterialization | null;


  runtimeOwner?: "rust" | null;
}

ContractXlsxPivotTableDeletionPatch

Section titled “ContractXlsxPivotTableDeletionPatch”
interface ContractXlsxPivotTableDeletionPatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  name?: string | null;


  runtimeOwner?: "rust" | null;
}

ContractXlsxPivotTableFieldAdditionPatch

Section titled “ContractXlsxPivotTableFieldAdditionPatch”
interface ContractXlsxPivotTableFieldAdditionPatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  fieldName: string;
  targetArea: "columns" | "rows" | "filters";
  targetIndex?: number | null;
  name?: string | null;


  runtimeOwner?: "rust" | null;
}

ContractXlsxPivotTableFieldFilterPatch

Section titled “ContractXlsxPivotTableFieldFilterPatch”
interface ContractXlsxPivotTableFieldFilterPatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  fieldName: string;
  hiddenItems: string[];
  filterKind?: "item" | "label" | "value" | null;
  operator?:
    | "equals"
    | "notEquals"
    | "beginsWith"
    | "contains"
    | "greaterThan"
    | "greaterThanOrEqual"
    | "lessThan"
    | "lessThanOrEqual"
    | null;
  operand?: string | number | null;
  valueFieldName?: string | null;
  name?: string | null;


  runtimeOwner?: "rust" | null;
}

ContractXlsxPivotTableFieldMovePatch

Section titled “ContractXlsxPivotTableFieldMovePatch”
interface ContractXlsxPivotTableFieldMovePatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  fieldName: string;
  fromArea: "filters" | "columns" | "rows" | "values";
  toArea: "filters" | "columns" | "rows" | "values";
  targetIndex?: number | null;
  name?: string | null;


  runtimeOwner?: "rust" | null;
}

ContractXlsxPivotTableFieldRemovalPatch

Section titled “ContractXlsxPivotTableFieldRemovalPatch”
interface ContractXlsxPivotTableFieldRemovalPatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  fieldName: string;
  fromArea?: "filters" | "columns" | "rows" | "values" | null;
  name?: string | null;


  runtimeOwner?: "rust" | null;
}

ContractXlsxPivotTableFieldSettingsPatch

Section titled “ContractXlsxPivotTableFieldSettingsPatch”
interface ContractXlsxPivotTableFieldSettingsPatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  fieldName: string;
  setting: "showAllItems" | "fieldSettings";
  customName?: string | null;
  subtotals?: "automatic" | "custom" | "none" | null;
  customSubtotals?: Array<"sum" | "count" | "average" | "max" | "min"> | null;
  showAllItems?: boolean | null;
  name?: string | null;


  runtimeOwner?: "rust" | null;
}

ContractXlsxPivotTableFieldSortPatch

Section titled “ContractXlsxPivotTableFieldSortPatch”
interface ContractXlsxPivotTableFieldSortPatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  fieldName: string;
  direction: "ascending" | "descending";
  name?: string | null;


  runtimeOwner?: "rust" | null;
}

ContractXlsxPivotTableItemDetailPatch

Section titled “ContractXlsxPivotTableItemDetailPatch”
interface ContractXlsxPivotTableItemDetailPatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  fieldName: string;
  itemLabel: string;
  expanded: boolean;
  name?: string | null;


  runtimeOwner?: "rust" | null;
}

ContractXlsxPivotTableItemGroupPatch

Section titled “ContractXlsxPivotTableItemGroupPatch”
interface ContractXlsxPivotTableItemGroupPatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  fieldName: string;
  action: "group" | "ungroup";
  groupingKind?: "numeric" | "date" | null;
  startNumber?: number | null;
  endNumber?: number | null;
  interval?: number | null;
  datePeriods?: Array<"month" | "quarter" | "year"> | null;
  name?: string | null;


  runtimeOwner?: "rust" | null;
}

ContractXlsxPivotTableMovePatch

Section titled “ContractXlsxPivotTableMovePatch”
interface ContractXlsxPivotTableMovePatch {
  activeSheetPath: string;
  destinationSheetPath: string;
  pivotTablePath: string;
  ref: string;
  destinationRef: string;
  destinationSheetName?: string | null;
  createDestinationSheet?: boolean | null;
  name?: string | null;


  runtimeOwner?: "rust" | null;
}

ContractXlsxPivotTableRefreshPatch

Section titled “ContractXlsxPivotTableRefreshPatch”
interface ContractXlsxPivotTableRefreshPatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  name?: string | null;


  runtimeOwner?: "rust" | null;
}

ContractXlsxPivotTableReportLayoutPatch

Section titled “ContractXlsxPivotTableReportLayoutPatch”
interface ContractXlsxPivotTableReportLayoutPatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  layout?: "compact" | "outline" | "tabular" | null;
  subtotals?: "automatic" | "none" | "top" | "bottom" | null;
  rowGrandTotals?: boolean | null;
  columnGrandTotals?: boolean | null;
  showDrill?: boolean | null;
  showHeaders?: boolean | null;
  newName?: string | null;
  printDrill?: boolean | null;
  showDataTips?: boolean | null;
  classicLayout?: boolean | null;
  showError?: boolean | null;
  errorCaption?: string | null;
  showMissing?: boolean | null;
  missingCaption?: string | null;
  itemPrintTitles?: boolean | null;
  fieldPrintTitles?: boolean | null;
  multipleFieldFilters?: boolean | null;
  useAutoFormatting?: boolean | null;
  preserveFormatting?: boolean | null;
  mergeItem?: boolean | null;
  indent?: number | null;
  pageOverThenDown?: boolean | null;
  pageWrap?: number | null;
  customListSort?: boolean | null;
  saveData?: boolean | null;
  enableDrill?: boolean | null;
  refreshOnLoad?: boolean | null;
  missingItemsLimit?: "automatic" | "maximum" | null;
  altText?: string | null;
  altTextSummary?: string | null;
  name?: string | null;


  runtimeOwner?: "rust" | null;
}

ContractXlsxPivotTableShowValuesAsPatch

Section titled “ContractXlsxPivotTableShowValuesAsPatch”
interface ContractXlsxPivotTableShowValuesAsPatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  mode: "percentOfTotal" | "percentOfRow" | "runningTotal";
  baseFieldName?: string | null;
  name?: string | null;


  runtimeOwner?: "rust" | null;
}

ContractXlsxPivotTableSourceChangePatch

Section titled “ContractXlsxPivotTableSourceChangePatch”
interface ContractXlsxPivotTableSourceChangePatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  sourceSheetName: string;
  sourceRef: string;
  sourceTableName?: string | null;
  name?: string | null;


  runtimeOwner?: "rust" | null;
}

ContractXlsxPivotTableStylePatch

Section titled “ContractXlsxPivotTableStylePatch”
interface ContractXlsxPivotTableStylePatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  styleName?: "PivotStyleMedium9" | null;
  showRowHeaders?: boolean | null;
  showColumnHeaders?: boolean | null;
  showRowStripes?: boolean | null;
  showColumnStripes?: boolean | null;
  name?: string | null;


  runtimeOwner?: "rust" | null;
}

ContractXlsxPivotTableValueFieldAdditionPatch

Section titled “ContractXlsxPivotTableValueFieldAdditionPatch”
interface ContractXlsxPivotTableValueFieldAdditionPatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  fieldName: string;
  summaryFunction: "sum" | "count" | "average" | "min" | "max";
  targetIndex?: number | null;
  customName?: string | null;
  numberFormatCode?: string | null;
  name?: string | null;


  runtimeOwner?: "rust" | null;
}

ContractXlsxPivotTableValueSummaryPatch

Section titled “ContractXlsxPivotTableValueSummaryPatch”
interface ContractXlsxPivotTableValueSummaryPatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  summaryFunction: "sum" | "count" | "average" | "min" | "max";
  name?: string | null;
  customName?: string | null;


  runtimeOwner?: "rust" | null;
}

ContractXlsxPivotValueCellMaterialization

Section titled “ContractXlsxPivotValueCellMaterialization”
interface ContractXlsxPivotValueCellMaterialization {
  occurrenceId: string;
  rowItems: string[];
  columnItems: string[];
  numericValue?: string | null;
}

ContractXlsxPivotValueFieldMaterialization

Section titled “ContractXlsxPivotValueFieldMaterialization”
interface ContractXlsxPivotValueFieldMaterialization {
  occurrenceId: string;
  fieldName: string;
  caption: string;
  summaryFunction: "sum" | "count" | "average" | "min" | "max";
}

Documentation assistant

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