Pivot tables

Cache, calculated fields and items, grouping and drill-down, layout, report filters, sorting, and value field settings. Terms are in the glossary.

Operations on this page — 11

• pivot_cache_options
• pivot_calculated_fields
• pivot_calculated_items
• pivot_data_model_olap_readonly
• pivot_field_list_authoring
• pivot_grouping_drilldown
• pivot_layout_format
• pivot_move_copy
• pivot_report_filter_pages
• pivot_sort_filter_ranking
• pivot_value_field_settings

pivot_cache_options

Pivot table cache settings: what it holds between refreshes, and for how long.

Request

Field	TypeScript type	Req.
operation	"pivot_cache_options"	yes
subsetId	string	yes
requestId	string	yes
intent	ContractPivotCacheOptionsAction	yes
viewport	ViewportWindow | null	no
requestedBackend	ComputeBackendKind | null	no

Response on success · pivot_cache_options

Field	TypeScript type	Req.
operation	"pivot_cache_options"	yes
subsetId	string	yes
requestId	string	yes
session	ContractSubsetSessionInfo	yes
delta	DeltaSummary	yes
action	string	yes
status	string	yes
didChange	boolean	yes
options	ContractPivotCacheOptionsView[]	yes
refreshedPivotNames	string[]	yes
dirtyCellCount	number	yes
activeSheet	ContractActiveSheetMeta	yes
sheetCount	number	yes
workbookSheets	ContractWorkbookSheetMeta[]	yes
geometry	ContractGeometrySubset	yes
recalcNeeded	boolean	yes
viewport	ViewportWindow	yes
previewCells	ContractPreviewCell[]	yes

Minimal JSON template

{
  "operation": "pivot_cache_options",
  "subsetId": "<subsetId>",
  "requestId": "<string>",
  "intent": "<ContractPivotCacheOptionsAction>",
  "requestedBackend": "native-desktop"
}

pivot_calculated_fields

Pivot table calculated fields: your own formulas on top of the source data.

Request

Field	TypeScript type	Req.
operation	"pivot_calculated_fields"	yes
subsetId	string	yes
intent	ContractPivotCalculatedFieldsAction	yes
viewport	ViewportWindow | null	no
requestedBackend	ComputeBackendKind | null	no

Response on success · pivot_calculated_fields

Field	TypeScript type	Req.
operation	"pivot_calculated_fields"	yes
subsetId	string	yes
session	ContractSubsetSessionInfo	yes
delta	DeltaSummary	yes
action	string	yes
status	string	yes
caches	ContractPivotCalculatedCacheView[]	yes
fields	ContractPivotCalculatedFieldView[]	yes
refreshedCacheIds	string[]	yes
dirtyCellCount	number	yes
activeSheet	ContractActiveSheetMeta	yes
geometry	ContractGeometrySubset	yes
recalcNeeded	boolean	yes
viewport	ViewportWindow	yes
previewCells	ContractPreviewCell[]	yes

Minimal JSON template

{
  "operation": "pivot_calculated_fields",
  "subsetId": "<subsetId>",
  "intent": "<ContractPivotCalculatedFieldsAction>",
  "requestedBackend": "native-desktop"
}

pivot_calculated_items

Pivot table calculated items: your own formulas inside a field.

Request

Field	TypeScript type	Req.
operation	"pivot_calculated_items"	yes
subsetId	string	yes
intent	ContractPivotCalculatedItemsAction	yes
viewport	ViewportWindow | null	no
requestedBackend	ComputeBackendKind | null	no

Response on success · pivot_calculated_items

Field	TypeScript type	Req.
operation	"pivot_calculated_items"	yes
subsetId	string	yes
session	ContractSubsetSessionInfo	yes
delta	DeltaSummary	yes
action	string	yes
status	string	yes
fields	ContractPivotCalculatedItemFieldView[]	yes
items	ContractPivotCalculatedItemView[]	yes
refreshedCacheIds	string[]	yes
dirtyCellCount	number	yes
activeSheet	ContractActiveSheetMeta	yes
geometry	ContractGeometrySubset	yes
recalcNeeded	boolean	yes
viewport	ViewportWindow	yes
previewCells	ContractPreviewCell[]	yes

Minimal JSON template

{
  "operation": "pivot_calculated_items",
  "subsetId": "<subsetId>",
  "intent": "<ContractPivotCalculatedItemsAction>",
  "requestedBackend": "native-desktop"
}

pivot_data_model_olap_readonly

Reading a pivot table built on the data model or an OLAP source. Read-only: the core doesn’t change these pivot tables.

Request

Field	TypeScript type	Req.
operation	"pivot_data_model_olap_readonly"	yes
subsetId	string	yes
requestId	string	yes
intent	ContractPivotDataModelOlapReadonlyAction	yes
requestedBackend	ComputeBackendKind | null	no

Response on success · pivot_data_model_olap_readonly

Field	TypeScript type	Req.
operation	"pivot_data_model_olap_readonly"	yes
subsetId	string	yes
requestId	string	yes
session	ContractSubsetSessionInfo	yes
delta	DeltaSummary	yes
action	string	yes
status	"ok" | “blocked”	yes
didChange	false	yes
blockedReasonCode	string | null	yes
selectedEntityStableId	string | null	yes
inventory	ContractPivotDataModelOlapInventory	yes

Minimal JSON template

{
  "operation": "pivot_data_model_olap_readonly",
  "subsetId": "<subsetId>",
  "requestId": "<string>",
  "intent": "<ContractPivotDataModelOlapReadonlyAction>",
  "requestedBackend": "native-desktop"
}

pivot_field_list_authoring

The pivot table field list: what’s in the rows, columns, values, and filters.

Request

Field	TypeScript type	Req.
operation	"pivot_field_list_authoring"	yes
subsetId	string	yes
requestId	string	yes
intent	ContractPivotFieldListAuthoringAction	yes
viewport	ViewportWindow | null	no
requestedBackend	ComputeBackendKind | null	no

Response on success · pivot_field_list_authoring

Field	TypeScript type	Req.
operation	"pivot_field_list_authoring"	yes
subsetId	string	yes
requestId	string	yes
session	ContractSubsetSessionInfo	yes
delta	DeltaSummary	yes
action	string	yes
status	string	yes
didChange	boolean	yes
draftChanged	boolean	yes
layouts	ContractPivotFieldListView[]	yes
dirtyCellCount	number	yes
activeSheet	ContractActiveSheetMeta	yes
sheetCount	number	yes
workbookSheets	ContractWorkbookSheetMeta[]	yes
geometry	ContractGeometrySubset	yes
recalcNeeded	boolean	yes
viewport	ViewportWindow	yes
previewCells	ContractPreviewCell[]	yes

Minimal JSON template

{
  "operation": "pivot_field_list_authoring",
  "subsetId": "<subsetId>",
  "requestId": "<string>",
  "intent": "<ContractPivotFieldListAuthoringAction>",
  "requestedBackend": "native-desktop"
}

pivot_grouping_drilldown

Grouping in a pivot table, and drilling down to the source rows.

Request

Field	TypeScript type	Req.
operation	"pivot_grouping_drilldown"	yes
subsetId	string	yes
requestId	string	yes
intent	ContractPivotGroupingDrilldownAction	yes
viewport	ViewportWindow | null	no
requestedBackend	ComputeBackendKind | null	no

Response on success · pivot_grouping_drilldown

Field	TypeScript type	Req.
operation	"pivot_grouping_drilldown"	yes
subsetId	string	yes
requestId	string	yes
session	ContractSubsetSessionInfo	yes
delta	DeltaSummary	yes
action	string	yes
status	string	yes
didChange	boolean	yes
caches	ContractPivotGroupingCacheView[]	yes
items	ContractPivotGroupingItemView[]	yes
groups	ContractPivotGroupView[]	yes
expandedItems	ContractPivotExpandedItemView[]	yes
hierarchyNodes	ContractPivotHierarchyNodeView[]	yes
refreshedPivotNames	string[]	yes
detailContext	ContractPivotDetailContextView | null	no
getPivotData	ContractPivotGetPivotDataView | null	no
detailSheetLineage	ContractPivotDetailLineageView | null	no
dirtyCellCount	number	yes
activeSheet	ContractActiveSheetMeta	yes
sheetCount	number	yes
workbookSheets	ContractWorkbookSheetMeta[]	yes
geometry	ContractGeometrySubset	yes
recalcNeeded	boolean	yes
viewport	ViewportWindow	yes
previewCells	ContractPreviewCell[]	yes

Minimal JSON template

{
  "operation": "pivot_grouping_drilldown",
  "subsetId": "<subsetId>",
  "requestId": "<string>",
  "intent": "<ContractPivotGroupingDrilldownAction>",
  "requestedBackend": "native-desktop"
}

pivot_layout_format

Pivot table appearance: layout, subtotals, repeated labels, formatting.

Request

Field	TypeScript type	Req.
operation	"pivot_layout_format"	yes
subsetId	string	yes
requestId	string	yes
intent	ContractPivotLayoutFormatAction	yes
viewport	ViewportWindow | null	no
requestedBackend	ComputeBackendKind | null	no

Response on success · pivot_layout_format

Field	TypeScript type	Req.
operation	"pivot_layout_format"	yes
subsetId	string	yes
requestId	string	yes
session	ContractSubsetSessionInfo	yes
delta	DeltaSummary	yes
action	string	yes
status	string	yes
didChange	boolean	yes
layouts	ContractPivotLayoutFormatView[]	yes
refreshedPivotNames	string[]	yes
dirtyCellCount	number	yes
activeSheet	ContractActiveSheetMeta	yes
sheetCount	number	yes
workbookSheets	ContractWorkbookSheetMeta[]	yes
geometry	ContractGeometrySubset	yes
recalcNeeded	boolean	yes
viewport	ViewportWindow	yes
previewCells	ContractPreviewCell[]	yes

Minimal JSON template

{
  "operation": "pivot_layout_format",
  "subsetId": "<subsetId>",
  "requestId": "<string>",
  "intent": "<ContractPivotLayoutFormatAction>",
  "requestedBackend": "native-desktop"
}

pivot_move_copy

Moving and copying a pivot table.

Request

Field	TypeScript type	Req.
operation	"pivot_move_copy"	yes
subsetId	string	yes
requestId	string	yes
intent	ContractPivotMoveCopyAction	yes
viewport	ViewportWindow | null	no
requestedBackend	ComputeBackendKind | null	no

Response on success · pivot_move_copy

Field	TypeScript type	Req.
operation	"pivot_move_copy"	yes
subsetId	string	yes
requestId	string	yes
session	ContractSubsetSessionInfo	yes
delta	DeltaSummary	yes
action	string	yes
status	string	yes
didChange	boolean	yes
pivots	ContractPivotMoveCopyView[]	yes
destinationSheets	ContractPivotMoveCopySheetView[]	yes
activeSheet	ContractActiveSheetMeta	yes
sheetCount	number	yes
workbookSheets	ContractWorkbookSheetMeta[]	yes
geometry	ContractGeometrySubset	yes
recalcNeeded	boolean	yes
viewport	ViewportWindow	yes
previewCells	ContractPreviewCell[]	yes

Minimal JSON template

{
  "operation": "pivot_move_copy",
  "subsetId": "<subsetId>",
  "requestId": "<string>",
  "intent": "<ContractPivotMoveCopyAction>",
  "requestedBackend": "native-desktop"
}

pivot_report_filter_pages

Expanding a report filter into separate sheets — one sheet per value.

Request

Field	TypeScript type	Req.
operation	"pivot_report_filter_pages"	yes
subsetId	string	yes
requestId	string	yes
intent	ContractPivotReportFilterPagesAction	yes
viewport	ViewportWindow | null	no
requestedBackend	ComputeBackendKind | null	no

Response on success · pivot_report_filter_pages

Field	TypeScript type	Req.
operation	"pivot_report_filter_pages"	yes
subsetId	string	yes
requestId	string	yes
session	ContractSubsetSessionInfo	yes
delta	DeltaSummary	yes
action	string	yes
status	string	yes
didChange	boolean	yes
reports	ContractPivotReportFilterView[]	yes
generatedPages	ContractPivotReportFilterPageView[]	yes
refreshedPivotNames	string[]	yes
dirtyCellCount	number	yes
activeSheet	ContractActiveSheetMeta	yes
sheetCount	number	yes
workbookSheets	ContractWorkbookSheetMeta[]	yes
geometry	ContractGeometrySubset	yes
recalcNeeded	boolean	yes
viewport	ViewportWindow	yes
previewCells	ContractPreviewCell[]	yes

Minimal JSON template

{
  "operation": "pivot_report_filter_pages",
  "subsetId": "<subsetId>",
  "requestId": "<string>",
  "intent": "<ContractPivotReportFilterPagesAction>",
  "requestedBackend": "native-desktop"
}

pivot_sort_filter_ranking

Sorting, filtering, and ranking in a pivot table.

Request

Field	TypeScript type	Req.
operation	"pivot_sort_filter_ranking"	yes
subsetId	string	yes
requestId	string	yes
intent	ContractPivotSortFilterAction	yes
viewport	ViewportWindow | null	no
requestedBackend	ComputeBackendKind | null	no

Response on success · pivot_sort_filter_ranking

Field	TypeScript type	Req.
operation	"pivot_sort_filter_ranking"	yes
subsetId	string	yes
requestId	string	yes
session	ContractSubsetSessionInfo	yes
delta	DeltaSummary	yes
action	string	yes
status	string	yes
didChange	boolean	yes
fields	ContractPivotSortFilterView[]	yes
refreshedPivotNames	string[]	yes
dirtyCellCount	number	yes
activeSheet	ContractActiveSheetMeta	yes
sheetCount	number	yes
workbookSheets	ContractWorkbookSheetMeta[]	yes
geometry	ContractGeometrySubset	yes
recalcNeeded	boolean	yes
viewport	ViewportWindow	yes
previewCells	ContractPreviewCell[]	yes

Minimal JSON template

{
  "operation": "pivot_sort_filter_ranking",
  "subsetId": "<subsetId>",
  "requestId": "<string>",
  "intent": "<ContractPivotSortFilterAction>",
  "requestedBackend": "native-desktop"
}

pivot_value_field_settings

Value field settings: which summary to compute, and how to display it.

Request

Field	TypeScript type	Req.
operation	"pivot_value_field_settings"	yes
subsetId	string	yes
requestId	string	yes
intent	ContractPivotValueFieldSettingsAction	yes
viewport	ViewportWindow | null	no
requestedBackend	ComputeBackendKind | null	no

Response on success · pivot_value_field_settings

Field	TypeScript type	Req.
operation	"pivot_value_field_settings"	yes
subsetId	string	yes
requestId	string	yes
session	ContractSubsetSessionInfo	yes
delta	DeltaSummary	yes
action	string	yes
status	string	yes
didChange	boolean	yes
valueFields	ContractPivotValueFieldSettingsView[]	yes
refreshedPivotNames	string[]	yes
dirtyCellCount	number	yes
activeSheet	ContractActiveSheetMeta	yes
sheetCount	number	yes
workbookSheets	ContractWorkbookSheetMeta[]	yes
geometry	ContractGeometrySubset	yes
recalcNeeded	boolean	yes
viewport	ViewportWindow	yes
previewCells	ContractPreviewCell[]	yes

Minimal JSON template

{
  "operation": "pivot_value_field_settings",
  "subsetId": "<subsetId>",
  "requestId": "<string>",
  "intent": "<ContractPivotValueFieldSettingsAction>",
  "requestedBackend": "native-desktop"
}