<SYSTEM>F1 reference: Compute Contract, 203 операции, транспорт и сеанс.</SYSTEM>

# Ячейки и диапазоны

> Правка ячеек, чтение деталей, сдвиги, копирование и вставка, поиск и замена, сортировка, отмена и повтор. Операций на странице: 21.

Правка ячеек, чтение деталей, сдвиги, копирование и вставка, поиск и замена, сортировка, отмена и повтор. Термины — в [глоссарии](/start/glossary/). **Операции на этой странице — 21** * [`apply_cell_edits`](#apply_cell_edits) * [`apply_cell_shift`](#apply_cell_shift) * [`clear_sheet_bounded`](#clear_sheet_bounded) * [`commit_replacements_in_workbook_subset`](#commit_replacements_in_workbook_subset) * [`compute_replacements_in_workbook_subset`](#compute_replacements_in_workbook_subset) * [`compute_selection_aggregates`](#compute_selection_aggregates) * [`convert_entity_data_type_in_place`](#convert_entity_data_type_in_place) * [`copy_range`](#copy_range) * [`fill_across_sheets`](#fill_across_sheets) * [`find_in_workbook_subset`](#find_in_workbook_subset) * [`flash_fill_pattern`](#flash_fill_pattern) * [`mark_used_range_dirty_bounded`](#mark_used_range_dirty_bounded) * [`move_clipboard_range`](#move_clipboard_range) * [`paste_range`](#paste_range) * [`preview_cell_edits`](#preview_cell_edits) * [`read_cell_details`](#read_cell_details) * [`redo_last_cell_edit`](#redo_last_cell_edit) * [`redo_last_range_edit`](#redo_last_range_edit) * [`sort_range_rows`](#sort_range_rows) * [`undo_last_cell_edit`](#undo_last_cell_edit) * [`undo_last_range_edit`](#undo_last_range_edit) ## apply\_cell\_edits [Заголовок раздела «apply\_cell\_edits»](#apply_cell_edits) Применяет cell edits. **Запрос** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | ------------------ | ---------------------------------------------------------------------------- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | operation | `"apply_cell_edits"` | да | | | `subsetId` | string | да | | | edits | [CellInputEdit](/reference/f1/types-cells/#cellinputedit)\[] | да | | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | | `expectedRevision` | number \| null | нет | Необязательная проверка от гонок. Если поле есть, оно должно совпадать с текущей ревизией истории книги; при расхождении запрос отклоняется с ошибкой `apply-cell-edits-stale-revision`, и ничего не меняется. Без поля правка применяется безусловно. | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | | **Ответ при успехе · apply\_cell\_edits** | Поле | Тип TypeScript | Обяз. | | ---------------------------- | ------------------------------------------------------------------------------------------------------------ | ----- | | operation | `"apply_cell_edits"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `editedKeys` | string\[] | да | | `changedKeys` | string\[] | да | | `dirtyCellCount` | number | да | | `sheetProtected` | boolean | да | | `conditionalFormattingRules` | [ContractConditionalRule](/reference/f1/types-format/#contractconditionalrule)\[] | нет | | `currentSourceSaveReadiness` | [ContractCurrentSourceSaveReadiness](/reference/f1/types-common/#contractcurrentsourcesavereadiness) \| null | нет | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `tableMetadata` | [ContractTableMetadataProjection](/reference/f1/types-data/#contracttablemetadataprojection) \| null | нет | | `workbookTableMetadata` | [ContractTableMetadataProjection](/reference/f1/types-data/#contracttablemetadataprojection) \| null | нет | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "apply_cell_edits",
  "subsetId": "<subsetId>",
  "edits": [],
  "requestedBackend": "native-desktop"
}
```
 ## apply\_cell\_shift [Заголовок раздела «apply\_cell\_shift»](#apply_cell_shift) Применяет cell shift. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ------------------------------------------------------------------------------------------- | ----- | | operation | `"apply_cell_shift"` | да | | `subsetId` | string | да | | `sheetKey` | string | да | | `rowStart` | number | да | | `rowEnd` | number | да | | `colStart` | number | да | | `colEnd` | number | да | | direction | [ContractXlsxCellShiftDirection](/reference/f1/types-cells/#contractxlsxcellshiftdirection) | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · apply\_cell\_shift** | Поле | Тип TypeScript | Обяз. | | ------------------------------ | ------------------------------------------------------------------------------------------------------------ | ----- | | operation | `"apply_cell_shift"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | range | [CellRange](/reference/f1/types-cells/#cellrange) | да | | direction | [ContractXlsxCellShiftDirection](/reference/f1/types-cells/#contractxlsxcellshiftdirection) | да | | `changedRows` | number\[] | да | | `changedColumns` | number\[] | да | | `shiftedCellCount` | number | да | | `removedCellCount` | number | да | | `cellShiftClaim` | `"live_verified"` | да | | `shiftScope` | `"active_visible_value_cells_current_sheet"` | да | | `formulaReferenceRewriteClaim` | `"no"` | да | | `mergeReferenceRewriteClaim` | `"no"` | да | | `dirtyCellCount` | number | да | | `currentSourceSaveReadiness` | [ContractCurrentSourceSaveReadiness](/reference/f1/types-common/#contractcurrentsourcesavereadiness) \| null | нет | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "apply_cell_shift",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "rowStart": 0,
  "rowEnd": 0,
  "colStart": 0,
  "colEnd": 0,
  "direction": "<ContractXlsxCellShiftDirection>",
  "requestedBackend": "native-desktop"
}
```
 ## clear\_sheet\_bounded [Заголовок раздела «clear\_sheet\_bounded»](#clear_sheet_bounded) Очищает sheet bounded. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"clear_sheet_bounded"` | да | | `subsetId` | string | да | | `sheetKey` | string | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · clear\_sheet\_bounded** | Поле | Тип TypeScript | Обяз. | | ---------------------- | --------------------------------------------------------------------------------------------------- | ----- | | operation | `"clear_sheet_bounded"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `clearedSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) \| null | нет | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `sheetClearClaim` | `"live_verified"` | да | | `clearScope` | `"active_worksheet_cells_only_preserve_sheet_metadata"` | да | | `formattingClearClaim` | `"no"` | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "clear_sheet_bounded",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "requestedBackend": "native-desktop"
}
```
 ## commit\_replacements\_in\_workbook\_subset [Заголовок раздела «commit\_replacements\_in\_workbook\_subset»](#commit_replacements_in_workbook_subset) Фиксирует replacements in workbook subset. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ----------------------------------------------------------------------------- | ----- | | operation | `"commit_replacements_in_workbook_subset"` | да | | `subsetId` | string | да | | query | string | да | | replacement | string | да | | `matchCase` | boolean | нет | | `matchEntireCell` | boolean | нет | | `lookIn` | [ContractFindLookIn](/reference/f1/types-cells/#contractfindlookin) | да | | scope | [ContractFindScope](/reference/f1/types-cells/#contractfindscope) | да | | `searchOrder` | [ContractFindSearchOrder](/reference/f1/types-cells/#contractfindsearchorder) | нет | | `expectedRevision` | number | да | | locale | string | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · commit\_replacements\_in\_workbook\_subset** | Поле | Тип TypeScript | Обяз. | | ------------------ | --------------------------------------------------------------------------------------------------- | ----- | | operation | `"commit_replacements_in_workbook_subset"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | scope | [ContractFindScope](/reference/f1/types-cells/#contractfindscope) | да | | `lookIn` | [ContractFindLookIn](/reference/f1/types-cells/#contractfindlookin) | да | | `searchOrder` | [ContractFindSearchOrder](/reference/f1/types-cells/#contractfindsearchorder) | да | | `plannedEditCount` | number | да | | `appliedEditCount` | number | да | | `changedKeys` | string\[] | да | | dirty | boolean | да | | `recalcNeeded` | boolean | да | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "commit_replacements_in_workbook_subset",
  "subsetId": "<subsetId>",
  "query": "<string>",
  "replacement": "<string>",
  "lookIn": "<ContractFindLookIn>",
  "scope": "<ContractFindScope>",
  "expectedRevision": 0,
  "requestedBackend": "native-desktop"
}
```
 ## compute\_replacements\_in\_workbook\_subset [Заголовок раздела «compute\_replacements\_in\_workbook\_subset»](#compute_replacements_in_workbook_subset) Вычисляет replacements in workbook subset. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ----------------------------------------------------------------------------- | ----- | | operation | `"compute_replacements_in_workbook_subset"` | да | | `subsetId` | string | да | | query | string | да | | replacement | string | да | | `matchCase` | boolean | нет | | `matchEntireCell` | boolean | нет | | `lookIn` | [ContractFindLookIn](/reference/f1/types-cells/#contractfindlookin) | да | | scope | [ContractFindScope](/reference/f1/types-cells/#contractfindscope) | да | | `searchOrder` | [ContractFindSearchOrder](/reference/f1/types-cells/#contractfindsearchorder) | нет | | `resultOffset` | number | нет | | `resultLimit` | number | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · compute\_replacements\_in\_workbook\_subset** | Поле | Тип TypeScript | Обяз. | | ------------------- | ----------------------------------------------------------------------------------- | ----- | | operation | `"compute_replacements_in_workbook_subset"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | scope | [ContractFindScope](/reference/f1/types-cells/#contractfindscope) | да | | `lookIn` | [ContractFindLookIn](/reference/f1/types-cells/#contractfindlookin) | да | | `searchOrder` | [ContractFindSearchOrder](/reference/f1/types-cells/#contractfindsearchorder) | да | | `totalEditCount` | number | да | | `resultOffset` | number | да | | `returnedEditCount` | number | да | | truncated | boolean | да | | `nextResultOffset` | number | нет | | index | [ContractFindIndexStats](/reference/f1/types-cells/#contractfindindexstats) | да | | edits | [ContractReplaceEdit](/reference/f1/types-common/#contractreplaceedit)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "compute_replacements_in_workbook_subset",
  "subsetId": "<subsetId>",
  "query": "<string>",
  "replacement": "<string>",
  "lookIn": "<ContractFindLookIn>",
  "scope": "<ContractFindScope>",
  "requestedBackend": "native-desktop"
}
```
 ## compute\_selection\_aggregates [Заголовок раздела «compute\_selection\_aggregates»](#compute_selection_aggregates) Вычисляет selection aggregates. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------- | ---------------------------------------------------------------------------- | ----- | | operation | `"compute_selection_aggregates"` | да | | `subsetId` | string | да | | ranges | [CellRange](/reference/f1/types-cells/#cellrange)\[] | да | | `aggregateMode` | `"visible_rows"` \| “all\_rows” | нет | | `requestGeneration` | number | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · compute\_selection\_aggregates** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | ---------------------------- | ----------------------------------------------------------------------------------- | ----- | ----------------------------------------------------------------------------------------------- | | operation | `"compute_selection_aggregates"` | да | | | `subsetId` | string | да | | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | | `aggregateMode` | `"visible_rows"` \| “all\_rows” | да | | | `requestGeneration` | number | нет | | | `workbookRevision` | number | да | | | `calculationGeneration` | number | да | | | `cacheStatus` | `"hit"` \| “miss” | да | | | `cacheEntryCount` | number | да | | | `scannedCellCount` | number | да | | | `nonEmptyCount` | number | да | Сколько в выделении непустых ячеек — считаются и текст, и числа. То же, что даёт функция СЧЁТЗ. | | `numericCount` | number | да | Сколько ячеек участвует в числовых итогах ниже. | | `errorCount` | number | да | | | `formulaCount` | number | да | | | `numericAggregatesAvailable` | boolean | да | | | sum | number | да | | | average | number | да | | | min | number | да | | | max | number | да | | **Минимальный JSON-шаблон** 
```json
{
  "operation": "compute_selection_aggregates",
  "subsetId": "<subsetId>",
  "ranges": [],
  "requestedBackend": "native-desktop"
}
```
 ## convert\_entity\_data\_type\_in\_place [Заголовок раздела «convert\_entity\_data\_type\_in\_place»](#convert_entity_data_type_in_place) Преобразует entity data type in place. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ------------------------------------------------------------------------------------ | ----- | | operation | `"convert_entity_data_type_in_place"` | да | | `subsetId` | string | да | | kind | [ContractEntityDataTypeKind](/reference/f1/types-common/#contractentitydatatypekind) | да | | range | [CellRange](/reference/f1/types-cells/#cellrange) | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · convert\_entity\_data\_type\_in\_place** | Поле | Тип TypeScript | Обяз. | | --------------- | ------------------------------------------------------------------------------------------------------ | ----- | | operation | `"convert_entity_data_type_in_place"` | да | | `subsetId` | string | да | | kind | [ContractEntityDataTypeKind](/reference/f1/types-common/#contractentitydatatypekind) | да | | range | [CellRange](/reference/f1/types-cells/#cellrange) | да | | `originalTexts` | string\[] | да | | disposition | [ContractEntityConversionDisposition](/reference/f1/types-common/#contractentityconversiondisposition) | да | | `didMutate` | boolean | да | | `entityCells` | [ContractEntityCellMetadata](/reference/f1/types-cells/#contractentitycellmetadata)\[] | да | | refusal | [ContractEntityConversionRefusal](/reference/f1/types-common/#contractentityconversionrefusal) \| null | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "convert_entity_data_type_in_place",
  "subsetId": "<subsetId>",
  "kind": "<ContractEntityDataTypeKind>",
  "range": "<CellRange>",
  "requestedBackend": "native-desktop"
}
```
 ## copy\_range [Заголовок раздела «copy\_range»](#copy_range) Копирует range. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"copy_range"` | да | | `subsetId` | string | да | | range | [CellRange](/reference/f1/types-cells/#cellrange) | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · copy\_range** | Поле | Тип TypeScript | Обяз. | | ---------------------------------- | ----------------------------------------------------------------------------------- | ----- | | operation | `"copy_range"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `clipboardId` | string | да | | range | [CellRange](/reference/f1/types-cells/#cellrange) | да | | `rowCount` | number | да | | `colCount` | number | да | | `cellCount` | number | да | | `mimeTypes` | string\[] | да | | `mergedRanges` | [CellRange](/reference/f1/types-cells/#cellrange)\[] | нет | | `sourceSelectionExpandedForMerges` | boolean | нет | | `clipboardHtml` | string \| null | нет | | `canonicalEdits` | [CellInputEdit](/reference/f1/types-cells/#cellinputedit)\[] | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "copy_range",
  "subsetId": "<subsetId>",
  "range": "<CellRange>",
  "requestedBackend": "native-desktop"
}
```
 ## fill\_across\_sheets [Заголовок раздела «fill\_across\_sheets»](#fill_across_sheets) В опубликованный выпуск пока не вошла Операция описана контрактом, но ядро последнего выпуска её не принимает: на такой запрос придёт отказ с перечнем известных ему операций. Что входит в выпуск, а что пока только в контракт — в [обзоре справочника](/reference/f1/overview/). **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ----------------------------------------------------------------------------------------- | ----- | | operation | “fill\_across\_sheets” | да | | `subsetId` | string | да | | `sourceRange` | [CellRange](/reference/f1/types-cells/#cellrange) | да | | `targetSheetKeys` | string\[] | да | | mode | [ContractFillAcrossSheetsMode](/reference/f1/types-session/#contractfillacrosssheetsmode) | да | | `expectedRevision` | number \| null | нет | | `readOnly` | boolean | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | **Ответ при успехе · fill\_across\_sheets** | Поле | Тип TypeScript | Обяз. | | ----------------- | --------------------------------------------------------------------------------------------------- | ----- | | operation | “fill\_across\_sheets” | да | | `subsetId` | string | да | | mode | [ContractFillAcrossSheetsMode](/reference/f1/types-session/#contractfillacrosssheetsmode) | да | | `sourceRange` | [CellRange](/reference/f1/types-cells/#cellrange) | да | | `targetSheetKeys` | string\[] | да | | `mutationCount` | number | да | | `changedKeys` | string\[] | да | | dirty | boolean | да | | `recalcNeeded` | boolean | да | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "fill_across_sheets",
  "subsetId": "<subsetId>",
  "sourceRange": "<CellRange>",
  "targetSheetKeys": "<targetSheetKeys>",
  "mode": "<ContractFillAcrossSheetsMode>"
}
```
 ## find\_in\_workbook\_subset [Заголовок раздела «find\_in\_workbook\_subset»](#find_in_workbook_subset) Ищет in workbook subset. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ----------------------------------------------------------------------------- | ----- | | operation | `"find_in_workbook_subset"` | да | | `subsetId` | string | да | | query | string | да | | `matchCase` | boolean | нет | | `matchEntireCell` | boolean | нет | | `lookIn` | [ContractFindLookIn](/reference/f1/types-cells/#contractfindlookin) | да | | scope | [ContractFindScope](/reference/f1/types-cells/#contractfindscope) | да | | `searchOrder` | [ContractFindSearchOrder](/reference/f1/types-cells/#contractfindsearchorder) | нет | | `resultOffset` | number | нет | | `resultLimit` | number | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · find\_in\_workbook\_subset** | Поле | Тип TypeScript | Обяз. | | -------------------- | ----------------------------------------------------------------------------------- | ----- | | operation | `"find_in_workbook_subset"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | scope | [ContractFindScope](/reference/f1/types-cells/#contractfindscope) | да | | `lookIn` | [ContractFindLookIn](/reference/f1/types-cells/#contractfindlookin) | да | | `searchOrder` | [ContractFindSearchOrder](/reference/f1/types-cells/#contractfindsearchorder) | да | | `totalMatchCount` | number | да | | `resultOffset` | number | да | | `returnedMatchCount` | number | да | | truncated | boolean | да | | `nextResultOffset` | number | нет | | index | [ContractFindIndexStats](/reference/f1/types-cells/#contractfindindexstats) | да | | matches | [ContractFindMatch](/reference/f1/types-cells/#contractfindmatch)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "find_in_workbook_subset",
  "subsetId": "<subsetId>",
  "query": "<string>",
  "lookIn": "<ContractFindLookIn>",
  "scope": "<ContractFindScope>",
  "requestedBackend": "native-desktop"
}
```
 ## flash\_fill\_pattern [Заголовок раздела «flash\_fill\_pattern»](#flash_fill_pattern) В опубликованный выпуск пока не вошла Операция описана контрактом, но ядро последнего выпуска её не принимает: на такой запрос придёт отказ с перечнем известных ему операций. Что входит в выпуск, а что пока только в контракт — в [обзоре справочника](/reference/f1/overview/). **Запрос** | Поле | Тип TypeScript | Обяз. | | --------------------- | ------------------------------------------------------------------------------ | ----- | | operation | “flash\_fill\_pattern” | да | | `subsetId` | string | да | | mode | [FlashFillMode](/reference/f1/types-format/#flashfillmode) | да | | generation | number | да | | examples | [FlashFillExample](/reference/f1/types-format/#flashfillexample)\[] | да | | rows | [FlashFillTargetRow](/reference/f1/types-format/#flashfilltargetrow)\[] | да | | `selectedCandidateId` | string \| null | нет | | locale | string \| null | нет | | refusal | [FlashFillRefusalContext](/reference/f1/types-format/#flashfillrefusalcontext) | нет | | `expectedRevision` | number \| null | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | **Ответ при успехе · flash\_fill\_pattern** | Поле | Тип TypeScript | Обяз. | | --------------- | -------------------------------------------------------------------- | ----- | | operation | “flash\_fill\_pattern” | да | | `subsetId` | string | да | | mode | [FlashFillMode](/reference/f1/types-format/#flashfillmode) | да | | generation | number | да | | inference | [FlashFillInference](/reference/f1/types-format/#flashfillinference) | да | | applied | boolean | да | | `mutationCount` | number | да | | projection | ComputeResponsePayload \| null | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "flash_fill_pattern",
  "subsetId": "<subsetId>",
  "mode": "<FlashFillMode>",
  "generation": 0,
  "examples": [],
  "rows": []
}
```
 ## mark\_used\_range\_dirty\_bounded [Заголовок раздела «mark\_used\_range\_dirty\_bounded»](#mark_used_range_dirty_bounded) Помечает used range dirty bounded. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"mark_used_range_dirty_bounded"` | да | | `subsetId` | string | да | | `sheetKey` | string | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · mark\_used\_range\_dirty\_bounded** | Поле | Тип TypeScript | Обяз. | | ------------------------ | --------------------------------------------------------------------------------------------------- | ----- | | operation | `"mark_used_range_dirty_bounded"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `changedSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `previousUsedRangeDirty` | boolean | да | | `usedRangeDirty` | true | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) \| null | нет | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `usedRangeDirtyClaim` | `"live_verified"` | да | | `usedRangeDirtyScope` | `"current_session_worksheet_used_range_marker"` | да | | `workbookMutationClaim` | `"no"` | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "mark_used_range_dirty_bounded",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "requestedBackend": "native-desktop"
}
```
 ## move\_clipboard\_range [Заголовок раздела «move\_clipboard\_range»](#move_clipboard_range) Перемещает clipboard range. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"move_clipboard_range"` | да | | `subsetId` | string | да | | `clipboardId` | string | да | | target | [CellRange](/reference/f1/types-cells/#cellrange) | да | | transpose | false | нет | | `pasteMode` | `"all"` | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · paste\_range** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | ---------------------------- | ------------------------------------------------------------------------------------------------------------ | ----- | ------------------------------------------------------------------------------------------------------------------ | | operation | `"paste_range"` | да | | | `subsetId` | string | да | | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | | `clipboardId` | string | да | | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | | `currentSourceSaveReadiness` | [ContractCurrentSourceSaveReadiness](/reference/f1/types-common/#contractcurrentsourcesavereadiness) \| null | нет | | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) | нет | | | `recalcNeeded` | boolean | да | | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | | `conditionalFormattingRules` | [ContractConditionalRule](/reference/f1/types-format/#contractconditionalrule)\[] | нет | | | `dataValidationMetadata` | [ContractDataValidationMetadata](/reference/f1/types-data/#contractdatavalidationmetadata) | нет | | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | Состояние истории после применения правки: владелец, глубина и ревизия. Оболочка показывает эти значения как есть. | **Минимальный JSON-шаблон** 
```json
{
  "operation": "move_clipboard_range",
  "subsetId": "<subsetId>",
  "clipboardId": "<string>",
  "target": "<CellRange>",
  "requestedBackend": "native-desktop"
}
```
 ## paste\_range [Заголовок раздела «paste\_range»](#paste_range) Вставляет range. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"paste_range"` | да | | `subsetId` | string | да | | `clipboardId` | string | да | | target | [CellRange](/reference/f1/types-cells/#cellrange) | да | | transpose | boolean | нет | | `pasteMode` | [ContractPasteMode](/reference/f1/types-common/#contractpastemode) | нет | | `expectedRevision` | number | нет | | `readOnly` | boolean | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · paste\_range** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | ---------------------------- | ------------------------------------------------------------------------------------------------------------ | ----- | ------------------------------------------------------------------------------------------------------------------ | | operation | `"paste_range"` | да | | | `subsetId` | string | да | | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | | `clipboardId` | string | да | | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | | `currentSourceSaveReadiness` | [ContractCurrentSourceSaveReadiness](/reference/f1/types-common/#contractcurrentsourcesavereadiness) \| null | нет | | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) | нет | | | `recalcNeeded` | boolean | да | | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | | `conditionalFormattingRules` | [ContractConditionalRule](/reference/f1/types-format/#contractconditionalrule)\[] | нет | | | `dataValidationMetadata` | [ContractDataValidationMetadata](/reference/f1/types-data/#contractdatavalidationmetadata) | нет | | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | Состояние истории после применения правки: владелец, глубина и ревизия. Оболочка показывает эти значения как есть. | **Минимальный JSON-шаблон** 
```json
{
  "operation": "paste_range",
  "subsetId": "<subsetId>",
  "clipboardId": "<string>",
  "target": "<CellRange>",
  "requestedBackend": "native-desktop"
}
```
 ## preview\_cell\_edits [Заголовок раздела «preview\_cell\_edits»](#preview_cell_edits) Формирует preview для cell edits. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"preview_cell_edits"` | да | | `subsetId` | string | да | | edits | [CellInputEdit](/reference/f1/types-cells/#cellinputedit)\[] | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · preview\_cell\_edits** | Поле | Тип TypeScript | Обяз. | | ---------------------------- | ------------------------------------------------------------------------------------------------------------ | ----- | | operation | `"preview_cell_edits"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `editedKeys` | string\[] | да | | `changedKeys` | string\[] | да | | `dirtyCellCount` | number | да | | `currentSourceSaveReadiness` | [ContractCurrentSourceSaveReadiness](/reference/f1/types-common/#contractcurrentsourcesavereadiness) \| null | нет | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "preview_cell_edits",
  "subsetId": "<subsetId>",
  "edits": [],
  "requestedBackend": "native-desktop"
}
```
 ## read\_cell\_details [Заголовок раздела «read\_cell\_details»](#read_cell_details) Читает cell details. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"read_cell_details"` | да | | `subsetId` | string | да | | row | number | да | | col | number | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `warmSheetForEdit` | boolean | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · read\_cell\_details** | Поле | Тип TypeScript | Обяз. | | ---------- | ----------------------------------------------------------------------------------- | ----- | | operation | `"read_cell_details"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | cell | [ContractCellDetails](/reference/f1/types-cells/#contractcelldetails) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "read_cell_details",
  "subsetId": "<subsetId>",
  "row": 0,
  "col": 0,
  "viewport": {
    "top": 0,
    "left": 0,
    "rows": 40,
    "cols": 12
  },
  "requestedBackend": "native-desktop"
}
```
 ## redo\_last\_cell\_edit [Заголовок раздела «redo\_last\_cell\_edit»](#redo_last_cell_edit) Повторяет last cell edit. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"redo_last_cell_edit"` | да | | `subsetId` | string | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · redo\_last\_cell\_edit** | Поле | Тип TypeScript | Обяз. | | ---------------------------- | ------------------------------------------------------------------------------------------------------------ | ----- | | operation | `"redo_last_cell_edit"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `redoneKey` | string | да | | `changedKeys` | string\[] | да | | `dirtyCellCount` | number | да | | `conditionalFormattingRules` | [ContractConditionalRule](/reference/f1/types-format/#contractconditionalrule)\[] | нет | | `currentSourceSaveReadiness` | [ContractCurrentSourceSaveReadiness](/reference/f1/types-common/#contractcurrentsourcesavereadiness) \| null | нет | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "redo_last_cell_edit",
  "subsetId": "<subsetId>",
  "requestedBackend": "native-desktop"
}
```
 ## redo\_last\_range\_edit [Заголовок раздела «redo\_last\_range\_edit»](#redo_last_range_edit) Повторяет last range edit. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"redo_last_range_edit"` | да | | `subsetId` | string | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · redo\_last\_range\_edit** | Поле | Тип TypeScript | Обяз. | | ----------------------------- | ------------------------------------------------------------------------------------------------------------ | ----- | | operation | `"redo_last_range_edit"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `redoneRange` | [CellRange](/reference/f1/types-cells/#cellrange) | да | | `redoneKeys` | string\[] | да | | `changedKeys` | string\[] | да | | `dirtyCellCount` | number | да | | `sheetProtected` | boolean | да | | `conditionalFormattingRules` | [ContractConditionalRule](/reference/f1/types-format/#contractconditionalrule)\[] | нет | | `currentSourceSaveReadiness` | [ContractCurrentSourceSaveReadiness](/reference/f1/types-common/#contractcurrentsourcesavereadiness) \| null | нет | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `dataValidationMetadata` | [ContractDataValidationMetadata](/reference/f1/types-data/#contractdatavalidationmetadata) | да | | `tableName` | string \| null | нет | | `tableRef` | string \| null | нет | | `tableDataBodyRef` | string \| null | нет | | `tableMetadata` | [ContractTableMetadataProjection](/reference/f1/types-data/#contracttablemetadataprojection) \| null | нет | | `workbookTableMetadata` | [ContractTableMetadataProjection](/reference/f1/types-data/#contracttablemetadataprojection) \| null | нет | | `worksheetAutoFilterMetadata` | [ContractWorksheetAutoFilterMetadata](/reference/f1/types-data/#contractworksheetautofiltermetadata) \| null | нет | | `hiddenRows` | number\[] | да | | `manualHiddenRows` | number\[] | да | | `filterHiddenRows` | number\[] | да | | `rangeFilterHistoryReplay` | boolean | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "redo_last_range_edit",
  "subsetId": "<subsetId>",
  "requestedBackend": "native-desktop"
}
```
 ## sort\_range\_rows [Заголовок раздела «sort\_range\_rows»](#sort_range_rows) Сортирует range rows. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------- | ---------------------------------------------------------------------------------------- | ----- | | operation | `"sort_range_rows"` | да | | `subsetId` | string | да | | range | [CellRange](/reference/f1/types-cells/#cellrange) | да | | levels | [SortRangeRowsLevel](/reference/f1/types-format/#sortrangerowslevel)\[] | да | | control | `"apply"` \| “prepare” \| “commit” \| “cancel” | нет | | `requestGeneration` | number \| null | нет | | `expectedRevision` | number \| null | нет | | `visibleRowsOnly` | boolean | нет | | locale | string \| null | нет | | `caseSensitive` | boolean | нет | | `numericTextMode` | [SortRangeRowsNumericTextMode](/reference/f1/types-format/#sortrangerowsnumerictextmode) | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · sort\_range\_rows** | Поле | Тип TypeScript | Обяз. | | ------------------- | ------------------------------------------------------- | ----- | | operation | `"sort_range_rows"` | да | | `subsetId` | string | да | | control | `"apply"` \| “prepare” \| “commit” \| “cancel” | да | | `requestGeneration` | number \| null | нет | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `movedRowCount` | number | да | | `sortedRowCount` | number | да | | `rowMoves` | SortRangeRowsRowMove\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "sort_range_rows",
  "subsetId": "<subsetId>",
  "range": "<CellRange>",
  "levels": [],
  "requestedBackend": "native-desktop"
}
```
 ## undo\_last\_cell\_edit [Заголовок раздела «undo\_last\_cell\_edit»](#undo_last_cell_edit) Отменяет last cell edit. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"undo_last_cell_edit"` | да | | `subsetId` | string | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · undo\_last\_cell\_edit** | Поле | Тип TypeScript | Обяз. | | ---------------------------- | ------------------------------------------------------------------------------------------------------------ | ----- | | operation | `"undo_last_cell_edit"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `restoredKey` | string | да | | `changedKeys` | string\[] | да | | `dirtyCellCount` | number | да | | `conditionalFormattingRules` | [ContractConditionalRule](/reference/f1/types-format/#contractconditionalrule)\[] | нет | | `currentSourceSaveReadiness` | [ContractCurrentSourceSaveReadiness](/reference/f1/types-common/#contractcurrentsourcesavereadiness) \| null | нет | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "undo_last_cell_edit",
  "subsetId": "<subsetId>",
  "requestedBackend": "native-desktop"
}
```
 ## undo\_last\_range\_edit [Заголовок раздела «undo\_last\_range\_edit»](#undo_last_range_edit) Отменяет last range edit. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"undo_last_range_edit"` | да | | `subsetId` | string | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · undo\_last\_range\_edit** | Поле | Тип TypeScript | Обяз. | | ----------------------------- | ------------------------------------------------------------------------------------------------------------ | ----- | | operation | `"undo_last_range_edit"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `restoredRange` | [CellRange](/reference/f1/types-cells/#cellrange) | да | | `restoredKeys` | string\[] | да | | `changedKeys` | string\[] | да | | `dirtyCellCount` | number | да | | `sheetProtected` | boolean | да | | `conditionalFormattingRules` | [ContractConditionalRule](/reference/f1/types-format/#contractconditionalrule)\[] | нет | | `currentSourceSaveReadiness` | [ContractCurrentSourceSaveReadiness](/reference/f1/types-common/#contractcurrentsourcesavereadiness) \| null | нет | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `dataValidationMetadata` | [ContractDataValidationMetadata](/reference/f1/types-data/#contractdatavalidationmetadata) | да | | `tableName` | string \| null | нет | | `tableRef` | string \| null | нет | | `tableDataBodyRef` | string \| null | нет | | `tableMetadata` | [ContractTableMetadataProjection](/reference/f1/types-data/#contracttablemetadataprojection) \| null | нет | | `workbookTableMetadata` | [ContractTableMetadataProjection](/reference/f1/types-data/#contracttablemetadataprojection) \| null | нет | | `worksheetAutoFilterMetadata` | [ContractWorksheetAutoFilterMetadata](/reference/f1/types-data/#contractworksheetautofiltermetadata) \| null | нет | | `hiddenRows` | number\[] | да | | `manualHiddenRows` | number\[] | да | | `filterHiddenRows` | number\[] | да | | `rangeFilterHistoryReplay` | boolean | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "undo_last_range_edit",
  "subsetId": "<subsetId>",
  "requestedBackend": "native-desktop"
}
```

# Сеанс и соглашения F1

> Идентификатор сеанса, нулевые индексы, ограниченные запросы, защита от гонки, ответы с именем другой операции и поля, которые приходят почти всегда.

Имена полей в F1 записываются слитно, со строчной первой буквы: `subsetId`, `sheetKey`, `expectedRevision`, `requestId`. Это отличается от A4, где слова разделены подчёркиванием — `document_id`, `paragraph_index`. Если вы встраиваете оба продукта, поле из одного в другом не найдётся. Размеры листа приходят в единицах Excel, и они разные. Ширина колонки — в символьных единицах: одна единица равна ширине цифры в шрифте по умолчанию, и колонка обычной ширины — это `8.43`, а не восемь пикселей. Высота строки — в пунктах, то есть в семьдесят вторых долях дюйма: обычная строка — `15`. Пикселей в контракте нет ни там, ни там. У самих операций стиля два, и это не опечатка: почти все записаны через подчёркивание — `apply_cell_edits`, `save_workbook_subset`, — а девятнадцать через дефис. Это семнадцать операций Power Query с приставкой `pq-` и две операции внешних диапазонов, `external-range-properties-apply` и `external-range-properties-inventory`. Имя операции передаётся буква в букву: приводить его к одному виду нельзя — ядро такой операции не знает. Строки и столбцы считаются с нуля: первая строка — `0`. Так же считаются границы видимой области. Диапазон описывается полями `sheetKey`, `rowStart`, `rowEnd`, `colStart`, `colEnd`. Открытие книги — операциями `open_workbook_subset` или `open_workbook_subset_from_bytes` — возвращает `subsetId`. Все последующие операции над этой книгой передают его обратно: по нему ядро узнаёт, о каком открытом сеансе речь. Поле `expectedRevision` — защита от гонки. Если оно передано и книга с тех пор изменилась, запрос отклоняется **до** правки, а не применяется поверх чужой. Поле необязательное: без него правка идёт безусловно. Запросы видимой области и диапазона должны оставаться ограниченными: контракт не обещает развернуть книгу в память целиком, и запрос «отдай всё» рассчитывать не на что. Успешный ответ может прийти с именем **другой** операции — той, к которой запрос свёлся внутри ядра: * `open_workbook_subset_from_bytes` отвечает как `open_workbook_subset`; * `move_clipboard_range` отвечает как `paste_range`; * `paste_conditional_formatting_rules` отвечает как `apply_conditional_formatting_rules`. Обработчик, который сверяет имя операции в ответе с отправленным, эти три случая не узнает. Связывать запрос с ответом нужно по идентификатору, а не по имени. ## Поля, которые приходят почти всегда [Заголовок раздела «Поля, которые приходят почти всегда»](#поля-которые-приходят-почти-всегда) | Поле | Что означает | | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | `previewCells` | Ячейки запрошенного участка: адрес, показанное значение, вид значения и исходная формула, если она есть. Это то, что рисуют на экране. | | `recalcNeeded` | `true`, если в книге остались формулы, ждущие пересчёта. Значения в `previewCells` при этом уже показаны — но могут быть не окончательными. | | `supportedSubset` | Строкой описано, какое подмножество формул ядро понимает в этом сеансе. Полезно показывать в диагностике, а не разбирать в коде. | | `dirtyCellCount` | Сколько ячеек изменено с открытия книги. По нему удобно показывать признак несохранённого. | | `layoutMetrics` | Раскладка листа: высоты строк, ширины столбцов, скрытые строки и столбцы, объединения. Приходит не в каждом ответе — только там, где нужна для отрисовки. |

# Данные, фильтры и объекты

> Фильтры, промежуточные итоги, очистка данных, таблицы, импорт текста, проверка данных, срезы и элементы управления. Операций на странице: 23.

Фильтры, промежуточные итоги, очистка данных, таблицы, импорт текста, проверка данных, срезы и элементы управления. Термины — в [глоссарии](/start/glossary/). **Операции на этой странице — 23** * [`advanced_filter_plan`](#advanced_filter_plan) * [`apply_outline_subtotal`](#apply_outline_subtotal) * [`apply_range_filter`](#apply_range_filter) * [`commit_delimited_text_import`](#commit_delimited_text_import) * [`data_cleanup`](#data_cleanup) * [`drawing_object_action`](#drawing_object_action) * [`drawing_object_history_replay`](#drawing_object_history_replay) * [`evaluate_data_validation_input`](#evaluate_data_validation_input) * [`external-range-properties-apply`](#external-range-properties-apply) * [`external-range-properties-inventory`](#external-range-properties-inventory) * [`finalize_object_selection_pane_package`](#finalize_object_selection_pane_package) * [`form_controls`](#form_controls) * [`mutate_table_hyperlink_artifacts`](#mutate_table_hyperlink_artifacts) * [`mutate_table_model`](#mutate_table_model) * [`open_document_object_creation`](#open_document_object_creation) * [`read_data_validation_rules`](#read_data_validation_rules) * [`set_data_validation_rules`](#set_data_validation_rules) * [`set_range_filter_enabled`](#set_range_filter_enabled) * [`slicer_timeline`](#slicer_timeline) * [`sort_filter_index_update`](#sort_filter_index_update) * [`sparkline_actions`](#sparkline_actions) * [`sparkline_history_replay`](#sparkline_history_replay) * [`update_table_model`](#update_table_model) ## advanced\_filter\_plan [Заголовок раздела «advanced\_filter\_plan»](#advanced_filter_plan) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------- | -------------------------------------------------------------------------------------- | ----- | | operation | `"advanced_filter_plan"` | да | | `subsetId` | string | да | | action | [ContractAdvancedFilterAction](/reference/f1/types-data/#contractadvancedfilteraction) | да | | `listRange` | [CellRange](/reference/f1/types-cells/#cellrange) | да | | `criteriaRange` | [CellRange](/reference/f1/types-cells/#cellrange) \| null | нет | | `copyToRange` | [CellRange](/reference/f1/types-cells/#cellrange) \| null | нет | | `uniqueRecordsOnly` | boolean | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · advanced\_filter\_plan** | Поле | Тип TypeScript | Обяз. | | --------------------- | ------------------------------------------------------------------------------------------------------- | ----- | | operation | `"advanced_filter_plan"` | да | | `matchedRows` | number\[] | да | | `hiddenRows` | number\[] | да | | `projectionCells` | [ContractAdvancedFilterProjectedCell](/reference/f1/types-data/#contractadvancedfilterprojectedcell)\[] | да | | `outputRange` | [CellRange](/reference/f1/types-cells/#cellrange) \| null | нет | | `sourceRowCount` | number | да | | `resultRowCount` | number | да | | `criteriaRowCount` | number | да | | `uniqueRecordsOnly` | boolean | да | | `formulaCriteriaUsed` | boolean | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "advanced_filter_plan",
  "subsetId": "<subsetId>",
  "action": "<ContractAdvancedFilterAction>",
  "listRange": "<CellRange>",
  "requestedBackend": "native-desktop"
}
```
 ## apply\_outline\_subtotal [Заголовок раздела «apply\_outline\_subtotal»](#apply_outline_subtotal) Применяет outline subtotal. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------------------- | ----- | | operation | `"apply_outline_subtotal"` | да | | `subsetId` | string | да | | range | [CellRange](/reference/f1/types-cells/#cellrange) | да | | action | [ContractOutlineSubtotalAction](/reference/f1/types-data/#contractoutlinesubtotalaction) | да | | axis | [ContractOutlineAxis](/reference/f1/types-data/#contractoutlineaxis) \| null | нет | | level | number \| null | нет | | subtotal | [ContractSubtotalOptions](/reference/f1/types-data/#contractsubtotaloptions) \| null | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · apply\_outline\_subtotal** | Поле | Тип TypeScript | Обяз. | | ----------------- | ---------------------------------------------------------------------------------------- | ----- | | operation | `"apply_outline_subtotal"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | action | [ContractOutlineSubtotalAction](/reference/f1/types-data/#contractoutlinesubtotalaction) | да | | `didChange` | boolean | да | | `outlineState` | [ContractOutlineSubtotalState](/reference/f1/types-data/#contractoutlinesubtotalstate) | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "apply_outline_subtotal",
  "subsetId": "<subsetId>",
  "range": "<CellRange>",
  "action": "<ContractOutlineSubtotalAction>",
  "requestedBackend": "native-desktop"
}
```
 ## apply\_range\_filter [Заголовок раздела «apply\_range\_filter»](#apply_range_filter) Применяет range filter. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ------------------------------------------------------------------------------------------------------- | ----- | | operation | `"apply_range_filter"` | да | | `subsetId` | string | да | | range | [CellRange](/reference/f1/types-cells/#cellrange) | да | | action | [ContractRangeFilterAction](/reference/f1/types-data/#contractrangefilteraction) | нет | | `targetColumn` | number \| null | нет | | criteria | [ContractRangeFilterColumnCriteria](/reference/f1/types-format/#contractrangefiltercolumncriteria)\[] | нет | | `headerPolicy` | [ContractRemoveDuplicatesHeaderPolicy](/reference/f1/types-print/#contractremoveduplicatesheaderpolicy) | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · apply\_range\_filter** | Поле | Тип TypeScript | Обяз. | | ------------------ | ----------------------------------------------------------------------------------------------------- | ----- | | operation | `"apply_range_filter"` | да | | `subsetId` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | action | [ContractRangeFilterAction](/reference/f1/types-data/#contractrangefilteraction) | да | | criteria | [ContractRangeFilterColumnCriteria](/reference/f1/types-format/#contractrangefiltercolumncriteria)\[] | да | | `hiddenRows` | number\[] | да | | `manualHiddenRows` | number\[] | да | | `filterHiddenRows` | number\[] | да | | `hiddenRowCount` | number | да | | `visibleRowCount` | number | да | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `recalcNeeded` | boolean | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "apply_range_filter",
  "subsetId": "<subsetId>",
  "range": "<CellRange>",
  "requestedBackend": "native-desktop"
}
```
 ## commit\_delimited\_text\_import [Заголовок раздела «commit\_delimited\_text\_import»](#commit_delimited_text_import) В опубликованный выпуск пока не вошла Операция описана контрактом, но ядро последнего выпуска её не принимает: на такой запрос придёт отказ с перечнем известных ему операций. Что входит в выпуск, а что пока только в контракт — в [обзоре справочника](/reference/f1/overview/). Фиксирует delimited text import. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | -------------------------------------------------------------------------------------------------- | ----- | | operation | `"commit_delimited_text_import"` | да | | `subsetId` | string | да | | edits | [CellInputEdit](/reference/f1/types-cells/#cellinputedit)\[] | да | | destination | [ContractDelimitedImportDestination](/reference/f1/types-data/#contractdelimitedimportdestination) | да | | `expectedRevision` | number \| null | нет | | `readOnly` | boolean | нет | | cancelled | boolean | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · commit\_delimited\_text\_import** | Поле | Тип TypeScript | Обяз. | | ------------------ | --------------------------------------------------------------------------------------------------- | ----- | | operation | `"commit_delimited_text_import"` | да | | `subsetId` | string | да | | `createdSheet` | boolean | да | | `sheetKey` | string | да | | `appliedEditCount` | number | да | | `mutationCount` | number | да | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | projection | ComputeResponsePayload | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "commit_delimited_text_import",
  "subsetId": "<subsetId>",
  "edits": [],
  "destination": "<ContractDelimitedImportDestination>",
  "requestedBackend": "native-desktop"
}
```
 ## data\_cleanup [Заголовок раздела «data\_cleanup»](#data_cleanup) **Запрос** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | ---------------------------- | ---------------------------------------------------------------------------------- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | operation | `"data_cleanup"` | да | | | `subsetId` | string | да | | | action | [ContractDataCleanupAction](/reference/f1/types-common/#contractdatacleanupaction) | да | | | intent | [ContractDataCleanupIntent](/reference/f1/types-common/#contractdatacleanupintent) | да | | | `consecutiveDelimitersAsOne` | boolean | нет | Считать несколько разделителей подряд одним — при разборе текста по столбцам. | | locale | string \| null | нет | Язык и региональные правила, по которым ядро распознаёт тип значения в общем формате — например, запятая как десятичный разделитель для `ru-RU`. | | `expectedRevision` | number \| null | нет | Central workbook revision observed by Preview; Apply refuses a mismatch before mutation. | | `previewToken` | string \| null | нет | | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | | **Ответ при успехе · data\_cleanup** | Поле | Тип TypeScript | Обяз. | | ------------------- | --------------------------------------------------------------------------------------------------- | ----- | | operation | `"data_cleanup"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | kind | `"text_to_columns"` \| “remove\_duplicates” \| “remove\_duplicates\_copy” | да | | `previewToken` | string | да | | applied | boolean | да | | `sourceRange` | [CellRange](/reference/f1/types-cells/#cellrange) | да | | `outputRange` | [CellRange](/reference/f1/types-cells/#cellrange) | да | | `duplicateCount` | number | да | | `remainingCount` | number | да | | `headerRowCount` | number | да | | `resultRowCount` | number | да | | `resultColCount` | number | да | | `copyOutput` | boolean | да | | `duplicateRowSpans` | [ContractDataCleanupRowSpan](/reference/f1/types-format/#contractdatacleanuprowspan)\[] | да | | audit | [ContractDataCleanupAudit](/reference/f1/types-formulas/#contractdatacleanupaudit) | да | | `tableName` | string \| null | нет | | `tableRef` | string \| null | нет | | `tableDataBodyRef` | string \| null | нет | | `previewRows` | [ContractDataCleanupPreviewRow](/reference/f1/types-format/#contractdatacleanuppreviewrow)\[] | да | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `changedKeys` | string\[] | да | | `dirtyCellCount` | number | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "data_cleanup",
  "subsetId": "<subsetId>",
  "action": "<ContractDataCleanupAction>",
  "intent": "<ContractDataCleanupIntent>",
  "requestedBackend": "native-desktop"
}
```
 ## drawing\_object\_action [Заголовок раздела «drawing\_object\_action»](#drawing_object_action) В опубликованный выпуск пока не вошла Операция описана контрактом, но ядро последнего выпуска её не принимает: на такой запрос придёт отказ с перечнем известных ему операций. Что входит в выпуск, а что пока только в контракт — в [обзоре справочника](/reference/f1/overview/). **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | -------------------------------------------------------------------------------------- | ----- | | operation | “drawing\_object\_action” | да | | `subsetId` | string | да | | action | [ContractDrawingObjectAction](/reference/f1/types-charts/#contractdrawingobjectaction) | да | | `expectedRevision` | number | да | | `readOnly` | boolean | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | **Ответ при успехе · drawing\_object\_action** | Поле | Тип TypeScript | Обяз. | | ------------------------ | ------------------------------------------------------------------------------------------------------------ | ----- | | operation | “drawing\_object\_action” | да | | `subsetId` | string | да | | `changedStableIds` | string\[] | да | | `regroupGroupId` | string \| null | нет | | `regroupMemberStableIds` | string\[] | да | | dirty | boolean | да | | `authoritativeRevision` | number | да | | `historyOwner` | “drawing\_objects” | да | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `surfaceObjects` | [ContractSheetObject](/reference/f1/types-session/#contractsheetobject)\[] | да | | `objectInventory` | [ContractWorkbookObjectInventoryEntry](/reference/f1/types-session/#contractworkbookobjectinventoryentry)\[] | да | | `inkProjection` | [ContractReviewInkProjectionItem](/reference/f1/types-protection/#contractreviewinkprojectionitem)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "drawing_object_action",
  "subsetId": "<subsetId>",
  "action": "<ContractDrawingObjectAction>",
  "expectedRevision": 0
}
```
 ## drawing\_object\_history\_replay [Заголовок раздела «drawing\_object\_history\_replay»](#drawing_object_history_replay) В опубликованный выпуск пока не вошла Операция описана контрактом, но ядро последнего выпуска её не принимает: на такой запрос придёт отказ с перечнем известных ему операций. Что входит в выпуск, а что пока только в контракт — в [обзоре справочника](/reference/f1/overview/). **Ответ при успехе · drawing\_object\_history\_replay** | Поле | Тип TypeScript | Обяз. | | ----------------- | ------------------------------------------------------------------------------------------------------------ | ----- | | operation | “drawing\_object\_history\_replay” | да | | `subsetId` | string | да | | direction | [ContractWorkbookHistoryDirection](/reference/f1/types-session/#contractworkbookhistorydirection) | да | | dirty | boolean | да | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `surfaceObjects` | [ContractSheetObject](/reference/f1/types-session/#contractsheetobject)\[] | да | | `objectInventory` | [ContractWorkbookObjectInventoryEntry](/reference/f1/types-session/#contractworkbookobjectinventoryentry)\[] | да | | `inkProjection` | [ContractReviewInkProjectionItem](/reference/f1/types-protection/#contractreviewinkprojectionitem)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) | нет | ## evaluate\_data\_validation\_input [Заголовок раздела «evaluate\_data\_validation\_input»](#evaluate_data_validation_input) Вычисляет/оценивает data validation input. **Запрос** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | ------------------- | ---------------------------------------------------------------------------------------------------------- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | operation | `"evaluate_data_validation_input"` | да | | | `subsetId` | string | да | | | inputs | [ContractDataValidationRawInput](/reference/f1/types-data/#contractdatavalidationrawinput)\[] | да | | | `companionEdits` | [CellInputEdit](/reference/f1/types-cells/#cellinputedit)\[] | нет | | | `programmaticEdits` | [CellInputEdit](/reference/f1/types-cells/#cellinputedit)\[] | нет | Rust expands fill-series/drag-fill before judging every destination. | | commit | boolean | нет | | | `expectedRevision` | number \| null | нет | Необязательная проверка от гонок при `commit: true`. При расхождении приходит отказ `apply-cell-edits-stale-revision` до того, как изменятся ячейки, история или ревизия. Проверочный вызов с `commit: false` правкой не становится. | | continuation | [ContractDataValidationContinuation](/reference/f1/types-data/#contractdatavalidationcontinuation) \| null | нет | | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | | **Ответ при успехе · evaluate\_data\_validation\_input** | Поле | Тип TypeScript | Обяз. | | ------------------- | ------------------------------------------------------------------------------------------------ | ----- | | operation | `"evaluate_data_validation_input"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | verdict | [ContractDataValidationVerdictKind](/reference/f1/types-data/#contractdatavalidationverdictkind) | да | | verdicts | [ContractDataValidationVerdict](/reference/f1/types-data/#contractdatavalidationverdict)\[] | да | | `continuationToken` | string \| null | нет | | `allowedDecisions` | [ContractDataValidationDecision](/reference/f1/types-data/#contractdatavalidationdecision)\[] | нет | | committed | ComputeResponsePayload \| null | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "evaluate_data_validation_input",
  "subsetId": "<subsetId>",
  "inputs": [],
  "requestedBackend": "native-desktop"
}
```
 ## external-range-properties-apply [Заголовок раздела «external-range-properties-apply»](#external-range-properties-apply) В опубликованный выпуск пока не вошла Операция описана контрактом, но ядро последнего выпуска её не принимает: на такой запрос придёт отказ с перечнем известных ему операций. Что входит в выпуск, а что пока только в контракт — в [обзоре справочника](/reference/f1/overview/). **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | -------------------------------------------------------------------------------------------- | ----- | | operation | “external-range-properties-apply” | да | | `subsetId` | string | да | | `expectedRevision` | number | нет | | identity | [ContractExternalRangeIdentity](/reference/f1/types-data/#contractexternalrangeidentity) | да | | properties | [ContractExternalRangeProperties](/reference/f1/types-data/#contractexternalrangeproperties) | да | **Ответ при успехе · external-range-properties-apply** | Поле | Тип TypeScript | Обяз. | | ----------------- | --------------------------------------------------------------------------------------------------- | ----- | | operation | “external-range-properties-apply” | да | | applied | boolean | да | | reason | string | нет | | detail | string | нет | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | нет | | ranges | [ContractExternalRangeEntry](/reference/f1/types-data/#contractexternalrangeentry)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "external-range-properties-apply",
  "subsetId": "<subsetId>",
  "identity": "<ContractExternalRangeIdentity>",
  "properties": "<ContractExternalRangeProperties>"
}
```
 ## external-range-properties-inventory [Заголовок раздела «external-range-properties-inventory»](#external-range-properties-inventory) В опубликованный выпуск пока не вошла Операция описана контрактом, но ядро последнего выпуска её не принимает: на такой запрос придёт отказ с перечнем известных ему операций. Что входит в выпуск, а что пока только в контракт — в [обзоре справочника](/reference/f1/overview/). **Запрос** | Поле | Тип TypeScript | Обяз. | | ---------- | ------------------------------------- | ----- | | operation | “external-range-properties-inventory” | да | | `subsetId` | string | да | **Ответ при успехе · external-range-properties-inventory** | Поле | Тип TypeScript | Обяз. | | --------- | ------------------------------------------------------------------------------------- | ----- | | operation | “external-range-properties-inventory” | да | | ranges | [ContractExternalRangeEntry](/reference/f1/types-data/#contractexternalrangeentry)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "external-range-properties-inventory",
  "subsetId": "<subsetId>"
}
```
 ## finalize\_object\_selection\_pane\_package [Заголовок раздела «finalize\_object\_selection\_pane\_package»](#finalize_object_selection_pane_package) Завершает object selection pane package. **Запрос** | Поле | Тип TypeScript | Обяз. | | ----------------------------- | --------------------------------------------------------------------------------------------------------------------- | ----- | | operation | `"finalize_object_selection_pane_package"` | да | | `subsetId` | string | да | | `sourcePackageBytesBase64` | string | да | | `candidatePackageBytesBase64` | string | да | | `objectProtectionMutations` | [ContractSheetObjectMutationIntent](/reference/f1/types-session/#contractsheetobjectmutationintent)\[] | да | | commands | [ContractObjectSelectionPanePackageCommand](/reference/f1/types-common/#contractobjectselectionpanepackagecommand)\[] | да | | `drawingTextEdits` | [ContractDrawingTextEditSemantics](/reference/f1/types-charts/#contractdrawingtexteditsemantics)\[] | да | | `adoptCurrentSource` | boolean | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · finalize\_object\_selection\_pane\_package** | Поле | Тип TypeScript | Обяз. | | --------------------------- | ------------------------------------------ | ----- | | operation | `"finalize_object_selection_pane_package"` | да | | `packageBytesBase64` | string | да | | `byteCount` | number | да | | `mutationCount` | number | да | | `authoritativeRevision` | number | да | | `validatedDrawingTextCount` | number | да | | `adoptedCurrentSource` | boolean | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "finalize_object_selection_pane_package",
  "subsetId": "<subsetId>",
  "sourcePackageBytesBase64": "<base64>",
  "candidatePackageBytesBase64": "<base64>",
  "objectProtectionMutations": [],
  "commands": [],
  "drawingTextEdits": [],
  "adoptCurrentSource": false,
  "requestedBackend": "native-desktop"
}
```
 ## form\_controls [Заголовок раздела «form\_controls»](#form_controls) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ------------------------------------------------------------------------------------ | ----- | | operation | `"form_controls"` | да | | `subsetId` | string | да | | intent | [ContractFormControlsAction](/reference/f1/types-common/#contractformcontrolsaction) | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · form\_controls** | Поле | Тип TypeScript | Обяз. | | ----------------- | ------------------------------------------------------------------------------------------------------------ | ----- | | operation | `"form_controls"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | action | string | да | | status | string | да | | controls | [ContractFormControlView](/reference/f1/types-common/#contractformcontrolview)\[] | да | | `objectInventory` | [ContractWorkbookObjectInventoryEntry](/reference/f1/types-session/#contractworkbookobjectinventoryentry)\[] | да | | `linkedCellWrite` | [ContractFormControlLinkedCellWrite](/reference/f1/types-cells/#contractformcontrollinkedcellwrite) \| null | нет | | `changedKeys` | string\[] | да | | `dirtyCellCount` | number | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "form_controls",
  "subsetId": "<subsetId>",
  "intent": "<ContractFormControlsAction>",
  "requestedBackend": "native-desktop"
}
```
 ## mutate\_table\_hyperlink\_artifacts [Заголовок раздела «mutate\_table\_hyperlink\_artifacts»](#mutate_table_hyperlink_artifacts) В опубликованный выпуск пока не вошла Операция описана контрактом, но ядро последнего выпуска её не принимает: на такой запрос придёт отказ с перечнем известных ему операций. Что входит в выпуск, а что пока только в контракт — в [обзоре справочника](/reference/f1/overview/). **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | -------------------------------------------------------------------------------------- | ----- | | operation | “mutate\_table\_hyperlink\_artifacts” | да | | `subsetId` | string | да | | action | [ContractTableHyperlinkAction](/reference/f1/types-data/#contracttablehyperlinkaction) | да | | `expectedRevision` | number | да | | `readOnly` | boolean | нет | | protected | boolean | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | **Ответ при успехе · mutate\_table\_hyperlink\_artifacts** | Поле | Тип TypeScript | Обяз. | | --------------------------- | ------------------------------------------------------------------------------------------------------ | ----- | | operation | “mutate\_table\_hyperlink\_artifacts” | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | action | string | да | | `tableMetadata` | [ContractTableMetadataProjection](/reference/f1/types-data/#contracttablemetadataprojection) | да | | `workbookTableMetadata` | [ContractTableMetadataProjection](/reference/f1/types-data/#contracttablemetadataprojection) | да | | `hyperlinkMetadata` | [ContractHyperlinkMetadataProjection](/reference/f1/types-common/#contracthyperlinkmetadataprojection) | да | | `workbookHyperlinkMetadata` | [ContractHyperlinkMetadataProjection](/reference/f1/types-common/#contracthyperlinkmetadataprojection) | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "mutate_table_hyperlink_artifacts",
  "subsetId": "<subsetId>",
  "action": "<ContractTableHyperlinkAction>",
  "expectedRevision": 0
}
```
 ## mutate\_table\_model [Заголовок раздела «mutate\_table\_model»](#mutate_table_model) Изменяет table model. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------------- | ----- | | operation | `"mutate_table_model"` | да | | `subsetId` | string | да | | mutation | [ContractTableModelMutation](/reference/f1/types-data/#contracttablemodelmutation) | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · mutate\_table\_model** | Поле | Тип TypeScript | Обяз. | | ----------------------- | --------------------------------------------------------------------------------------------------- | ----- | | operation | `"mutate_table_model"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | action | string | да | | `tableMetadata` | [ContractTableMetadataProjection](/reference/f1/types-data/#contracttablemetadataprojection) | да | | `workbookTableMetadata` | [ContractTableMetadataProjection](/reference/f1/types-data/#contracttablemetadataprojection) | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "mutate_table_model",
  "subsetId": "<subsetId>",
  "mutation": "<ContractTableModelMutation>",
  "requestedBackend": "native-desktop"
}
```
 ## open\_document\_object\_creation [Заголовок раздела «open\_document\_object\_creation»](#open_document_object_creation) Открывает document object creation. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------------------------------- | ----- | | operation | `"open_document_object_creation"` | да | | `subsetId` | string | да | | `sheetPath` | string | да | | creation | [ContractOpenDocumentObjectCreation](/reference/f1/types-common/#contractopendocumentobjectcreation) | да | | `readOnly` | boolean | нет | | `expectedRevision` | number \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · open\_document\_object\_creation** | Поле | Тип TypeScript | Обяз. | | ----------------------- | ------------------------------------------------------------------------------------------ | ----- | | operation | `"open_document_object_creation"` | да | | `subsetId` | string | да | | `createdObject` | [ContractCreatedDocumentObject](/reference/f1/types-common/#contractcreateddocumentobject) | да | | `byteCount` | number | да | | dirty | boolean | да | | `undoDepth` | number | да | | `redoDepth` | number | да | | `authoritativeRevision` | number | да | | `historyOwner` | `"drawing_objects"` | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "open_document_object_creation",
  "subsetId": "<subsetId>",
  "sheetPath": "<sheetPath>",
  "creation": "<ContractOpenDocumentObjectCreation>",
  "requestedBackend": "native-desktop"
}
```
 ## read\_data\_validation\_rules [Заголовок раздела «read\_data\_validation\_rules»](#read_data_validation_rules) Читает data validation rules. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"read_data_validation_rules"` | да | | `subsetId` | string | да | | `sheetKey` | string | да | | range | [CellRange](/reference/f1/types-cells/#cellrange) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · read\_data\_validation\_rules** | Поле | Тип TypeScript | Обяз. | | ------------------------ | ------------------------------------------------------------------------------------------ | ----- | | operation | `"read_data_validation_rules"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `sheetKey` | string | да | | `dataValidationMetadata` | [ContractDataValidationMetadata](/reference/f1/types-data/#contractdatavalidationmetadata) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "read_data_validation_rules",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "requestedBackend": "native-desktop"
}
```
 ## set\_data\_validation\_rules [Заголовок раздела «set\_data\_validation\_rules»](#set_data_validation_rules) Устанавливает data validation rules. **Запрос** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | ------------------ | ------------------------------------------------------------------------------------------------- | ----- | ------------------------------------------------------------------------------ | | operation | `"set_data_validation_rules"` | да | | | `subsetId` | string | да | | | `sheetKey` | string | да | | | rules | [ContractDataValidationRuleIntent](/reference/f1/types-data/#contractdatavalidationruleintent)\[] | да | | | `sourceLocale` | string \| null | нет | Request-local locale used by Rust to validate list Source syntax. | | `expectedRevision` | number \| null | нет | Refuses stale rule authoring before XML, dirty, history, or revision mutation. | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | | **Ответ при успехе · set\_data\_validation\_rules** | Поле | Тип TypeScript | Обяз. | | ------------------------ | --------------------------------------------------------------------------------------------------- | ----- | | operation | `"set_data_validation_rules"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `sheetKey` | string | да | | `appliedRuleCount` | number | да | | `dataValidationMetadata` | [ContractDataValidationMetadata](/reference/f1/types-data/#contractdatavalidationmetadata) | да | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "set_data_validation_rules",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "rules": [],
  "requestedBackend": "native-desktop"
}
```
 ## set\_range\_filter\_enabled [Заголовок раздела «set\_range\_filter\_enabled»](#set_range_filter_enabled) Устанавливает range filter enabled. **Запрос** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | ------------------ | ---------------------------------------------------------------------------- | ----- | ----------------------------------------------------------------------------------------------------- | | operation | `"set_range_filter_enabled"` | да | То же, что кнопка «Данные ▸ Фильтр»: включает или снимает автофильтр для выбранной таблицы или листа. | | `subsetId` | string | да | | | range | [CellRange](/reference/f1/types-cells/#cellrange) | да | | | enabled | boolean | да | | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | | **Ответ при успехе · set\_range\_filter\_enabled** | Поле | Тип TypeScript | Обяз. | | ----------------------- | --------------------------------------------------------------------------------------------------- | ----- | | operation | `"set_range_filter_enabled"` | да | | `subsetId` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `autoFilterRef` | string | нет | | `unhiddenRowCount` | number | да | | `targetKind` | `"range"` \| “table” | да | | `tableMetadata` | [ContractTableMetadataProjection](/reference/f1/types-data/#contracttablemetadataprojection) | да | | `workbookTableMetadata` | [ContractTableMetadataProjection](/reference/f1/types-data/#contracttablemetadataprojection) | да | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `recalcNeeded` | boolean | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "set_range_filter_enabled",
  "subsetId": "<subsetId>",
  "range": "<CellRange>",
  "enabled": false,
  "requestedBackend": "native-desktop"
}
```
 ## slicer\_timeline [Заголовок раздела «slicer\_timeline»](#slicer_timeline) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------------- | -------------------------------------------------------------------------------------- | ----- | | operation | `"slicer_timeline"` | да | | `subsetId` | string | да | | intent | [ContractSlicerTimelineAction](/reference/f1/types-data/#contractslicertimelineaction) | да | | `expectedCacheGeneration` | number \| null | нет | | `requestGeneration` | number \| null | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · slicer\_timeline** | Поле | Тип TypeScript | Обяз. | | ------------------- | ---------------------------------------------------------------------------------------------------- | ----- | | operation | `"slicer_timeline"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | action | string | да | | status | string | да | | controls | [ContractSlicerTimelineControlView](/reference/f1/types-data/#contractslicertimelinecontrolview)\[] | да | | `changedRows` | number\[] | да | | `hiddenRows` | number\[] | да | | `refreshTargets` | string\[] | да | | `connectedTargets` | [ContractSlicerTimelineTargetView](/reference/f1/types-data/#contractslicertimelinetargetview)\[] | да | | `filterConnections` | [ContractPivotFilterConnectionView](/reference/f1/types-pivot/#contractpivotfilterconnectionview)\[] | да | | `refreshStatus` | [ContractPivotRefreshStatusView](/reference/f1/types-pivot/#contractpivotrefreshstatusview) \| null | нет | | `dirtyCellCount` | number | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "slicer_timeline",
  "subsetId": "<subsetId>",
  "intent": "<ContractSlicerTimelineAction>",
  "requestedBackend": "native-desktop"
}
```
 ## sort\_filter\_index\_update [Заголовок раздела «sort\_filter\_index\_update»](#sort_filter_index_update) Сортирует filter index update. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"sort_filter_index_update"` | да | | `subsetId` | string | да | | range | [CellRange](/reference/f1/types-cells/#cellrange) | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · sort\_filter\_index\_update** | Поле | Тип TypeScript | Обяз. | | -------------- | ------------------------------------------------------- | ----- | | operation | `"sort_filter_index_update"` | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `indexVersion` | number | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "sort_filter_index_update",
  "subsetId": "<subsetId>",
  "range": "<CellRange>",
  "requestedBackend": "native-desktop"
}
```
 ## sparkline\_actions [Заголовок раздела «sparkline\_actions»](#sparkline_actions) В опубликованный выпуск пока не вошла Операция описана контрактом, но ядро последнего выпуска её не принимает: на такой запрос придёт отказ с перечнем известных ему операций. Что входит в выпуск, а что пока только в контракт — в [обзоре справочника](/reference/f1/overview/). **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------------- | ----- | | operation | “sparkline\_actions” | да | | `subsetId` | string | да | | mode | [ContractSparklinePlanMode](/reference/f1/types-charts/#contractsparklineplanmode) | да | | action | [ContractSparklineAction](/reference/f1/types-charts/#contractsparklineaction) | да | | `expectedRevision` | number | да | | `readOnly` | boolean | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | **Ответ при успехе · sparkline\_actions** | Поле | Тип TypeScript | Обяз. | | ----------------------- | --------------------------------------------------------------------------------------------------- | ----- | | operation | “sparkline\_actions” | да | | `subsetId` | string | да | | mode | [ContractSparklinePlanMode](/reference/f1/types-charts/#contractsparklineplanmode) | да | | applied | boolean | да | | dirty | boolean | да | | `authoritativeRevision` | number | да | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | projection | [ContractSparklineProjectionEntry](/reference/f1/types-charts/#contractsparklineprojectionentry)\[] | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "sparkline_actions",
  "subsetId": "<subsetId>",
  "mode": "<ContractSparklinePlanMode>",
  "action": "<ContractSparklineAction>",
  "expectedRevision": 0
}
```
 ## sparkline\_history\_replay [Заголовок раздела «sparkline\_history\_replay»](#sparkline_history_replay) В опубликованный выпуск пока не вошла Операция описана контрактом, но ядро последнего выпуска её не принимает: на такой запрос придёт отказ с перечнем известных ему операций. Что входит в выпуск, а что пока только в контракт — в [обзоре справочника](/reference/f1/overview/). **Ответ при успехе · sparkline\_history\_replay** | Поле | Тип TypeScript | Обяз. | | ----------------- | --------------------------------------------------------------------------------------------------- | ----- | | operation | “sparkline\_history\_replay” | да | | `subsetId` | string | да | | direction | [ContractWorkbookHistoryDirection](/reference/f1/types-session/#contractworkbookhistorydirection) | да | | dirty | boolean | да | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | projection | [ContractSparklineProjectionEntry](/reference/f1/types-charts/#contractsparklineprojectionentry)\[] | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) | нет | ## update\_table\_model [Заголовок раздела «update\_table\_model»](#update_table_model) Обновляет table model. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------------- | ----- | | operation | `"update_table_model"` | да | | `subsetId` | string | да | | table | [ContractTableMetadataEntry](/reference/f1/types-data/#contracttablemetadataentry) | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · update\_table\_model** | Поле | Тип TypeScript | Обяз. | | ----------------------- | -------------------------------------------------------------------------------------------- | ----- | | operation | `"update_table_model"` | да | | `subsetId` | string | да | | `stableId` | string | да | | `tableCount` | number | да | | `tableMetadata` | [ContractTableMetadataProjection](/reference/f1/types-data/#contracttablemetadataprojection) | да | | `workbookTableMetadata` | [ContractTableMetadataProjection](/reference/f1/types-data/#contracttablemetadataprojection) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "update_table_model",
  "subsetId": "<subsetId>",
  "table": "<ContractTableMetadataEntry>",
  "requestedBackend": "native-desktop"
}
```

# Форматирование

> Ширина колонок и высота строк, объединение ячеек, темы и шрифты, условное форматирование. Операций на странице: 10.

Ширина колонок и высота строк, объединение ячеек, темы и шрифты, условное форматирование. Термины — в [глоссарии](/start/glossary/). **Операции на этой странице — 10** * [`apply_column_width`](#apply_column_width) * [`apply_conditional_formatting_rules`](#apply_conditional_formatting_rules) * [`apply_merge_cells`](#apply_merge_cells) * [`apply_row_height`](#apply_row_height) * [`apply_theme_fonts_patch`](#apply_theme_fonts_patch) * [`apply_workbook_theme`](#apply_workbook_theme) * [`manage_cell_styles`](#manage_cell_styles) * [`manage_conditional_formatting_rules`](#manage_conditional_formatting_rules) * [`manage_table_styles`](#manage_table_styles) * [`paste_conditional_formatting_rules`](#paste_conditional_formatting_rules) ## apply\_column\_width [Заголовок раздела «apply\_column\_width»](#apply_column_width) Применяет column width. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"apply_column_width"` | да | | `subsetId` | string | да | | `sheetKey` | string | да | | col | number \| null | нет | | width | number \| null | нет | | columns | [ContractColumnWidth](/reference/f1/types-format/#contractcolumnwidth)\[] | нет | | `defaultWidth` | number \| null | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · apply\_column\_width** | Поле | Тип TypeScript | Обяз. | | ---------------------------- | ------------------------------------------------------------------------------------------------------------ | ----- | | operation | `"apply_column_width"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `changedColumns` | number\[] | да | | `dirtyCellCount` | number | да | | `currentSourceSaveReadiness` | [ContractCurrentSourceSaveReadiness](/reference/f1/types-common/#contractcurrentsourcesavereadiness) \| null | нет | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "apply_column_width",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "requestedBackend": "native-desktop"
}
```
 ## apply\_conditional\_formatting\_rules [Заголовок раздела «apply\_conditional\_formatting\_rules»](#apply_conditional_formatting_rules) Применяет conditional formatting rules. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | --------------------------------------------------------------------------------- | ----- | | operation | `"apply_conditional_formatting_rules"` | да | | `subsetId` | string | да | | `sheetKey` | string | да | | rules | [ContractConditionalRule](/reference/f1/types-format/#contractconditionalrule)\[] | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · apply\_conditional\_formatting\_rules** | Поле | Тип TypeScript | Обяз. | | ------------------------------------ | ----------------------------------------------------------------------------------- | ----- | | operation | `"apply_conditional_formatting_rules"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | rules | [ContractConditionalRule](/reference/f1/types-format/#contractconditionalrule)\[] | да | | `preservedUnsupportedRuleBlockCount` | number | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "apply_conditional_formatting_rules",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "rules": [],
  "requestedBackend": "native-desktop"
}
```
 ## apply\_merge\_cells [Заголовок раздела «apply\_merge\_cells»](#apply_merge_cells) Применяет merge cells. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ------------------------------------------------------------------------------------ | ----- | | operation | `"apply_merge_cells"` | да | | `subsetId` | string | да | | `sheetKey` | string | да | | range | [CellRange](/reference/f1/types-cells/#cellrange) | да | | merge | boolean | да | | mode | [ContractMergeCellsMode](/reference/f1/types-format/#contractmergecellsmode) \| null | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · apply\_merge\_cells** | Поле | Тип TypeScript | Обяз. | | ---------------------------- | ------------------------------------------------------------------------------------------------------------ | ----- | | operation | `"apply_merge_cells"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | merge | boolean | да | | mode | [ContractMergeCellsMode](/reference/f1/types-format/#contractmergecellsmode) | да | | `mergeRef` | string \| null | нет | | `mergeRefs` | string\[] | да | | `changedMerges` | string\[] | да | | `removedMerges` | string\[] | да | | `dirtyCellCount` | number | да | | `currentSourceSaveReadiness` | [ContractCurrentSourceSaveReadiness](/reference/f1/types-common/#contractcurrentsourcesavereadiness) \| null | нет | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "apply_merge_cells",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "range": "<CellRange>",
  "merge": false,
  "requestedBackend": "native-desktop"
}
```
 ## apply\_row\_height [Заголовок раздела «apply\_row\_height»](#apply_row_height) Применяет row height. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"apply_row_height"` | да | | `subsetId` | string | да | | `sheetKey` | string | да | | row | number \| null | нет | | height | number \| null | нет | | rows | [ContractRowHeight](/reference/f1/types-format/#contractrowheight)\[] | нет | | `defaultHeight` | number \| null | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · apply\_row\_height** | Поле | Тип TypeScript | Обяз. | | ---------------------------- | ------------------------------------------------------------------------------------------------------------ | ----- | | operation | `"apply_row_height"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `changedRows` | number\[] | да | | `dirtyCellCount` | number | да | | `currentSourceSaveReadiness` | [ContractCurrentSourceSaveReadiness](/reference/f1/types-common/#contractcurrentsourcesavereadiness) \| null | нет | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "apply_row_height",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "requestedBackend": "native-desktop"
}
```
 ## apply\_theme\_fonts\_patch [Заголовок раздела «apply\_theme\_fonts\_patch»](#apply_theme_fonts_patch) Применяет theme fonts patch. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------------------- | ----- | | operation | `"apply_theme_fonts_patch"` | да | | `subsetId` | string | да | | patch | [ContractApplyThemeFontsPatch](/reference/f1/types-format/#contractapplythemefontspatch) | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · apply\_theme\_fonts\_patch** | Поле | Тип TypeScript | Обяз. | | ---------- | --------------------------- | ----- | | operation | `"apply_theme_fonts_patch"` | да | | `subsetId` | string | да | | major | string | да | | minor | string | да | | applied | boolean | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "apply_theme_fonts_patch",
  "subsetId": "<subsetId>",
  "patch": "<ContractApplyThemeFontsPatch>",
  "requestedBackend": "native-desktop"
}
```
 ## apply\_workbook\_theme [Заголовок раздела «apply\_workbook\_theme»](#apply_workbook_theme) Применяет workbook theme. **Запрос** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | ------------------ | --------------------------------------------------------------------------------------------------------- | ----- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | operation | `"apply_workbook_theme"` | да | | | `subsetId` | string | да | | | `presetId` | string | да | Идентификатор темы из каталога тем — цвета вместе со шрифтами. Если задано `colorsOnly`, идентификатор берётся из каталога цветовых наборов, то есть из того же списка, что и «Разметка страницы → Цвета». | | `colorsOnly` | boolean | нет | Применить только цветовой набор темы, не трогая шрифты. Без поля или при `false` тема применяется целиком — и цвета, и шрифты. | | `customColors` | [ContractWorkbookThemeColorScheme](/reference/f1/types-session/#contractworkbookthemecolorscheme) \| null | нет | | | `previewOnly` | boolean | нет | Разобрать книгу заново и показать результат в отдельном сеансе, ничего не изменяя. | | `expectedRevision` | number \| null | нет | Обязательно при сохранении; при просмотре без изменений не учитывается. | | `readOnly` | boolean | нет | | | protected | boolean | нет | | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | | **Ответ при успехе · apply\_workbook\_theme** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | ------------------- | ----------------------------------------------------------------------------------------------------------- | ----- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | operation | `"apply_workbook_theme"` | да | Ответ повторяет по составу основные поля `open_workbook_subset` и `apply_cell_edits`, поэтому оболочка перерисовывает книгу тем же способом, что и после обычной правки, — отдельной обработки не требуется. | | `subsetId` | string | да | | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | | `appliedPresetId` | string | да | | | `createdThemePart` | boolean | да | | | `previewOnly` | boolean | нет | | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | | `recalcNeeded` | boolean | да | | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) | нет | | | `themeColorPalette` | string\[] | нет | Палитра темы книги из двенадцати цветов — та же по составу и смыслу, что в `open_workbook_subset`, но уже после применения темы. По ней элементы, следующие за темой (например, стили таблиц), перекрашиваются сразу, без сохранения и повторного открытия. | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) \| null | нет | | **Минимальный JSON-шаблон** 
```json
{
  "operation": "apply_workbook_theme",
  "subsetId": "<subsetId>",
  "presetId": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## manage\_cell\_styles [Заголовок раздела «manage\_cell\_styles»](#manage_cell_styles) В опубликованный выпуск пока не вошла Операция описана контрактом, но ядро последнего выпуска её не принимает: на такой запрос придёт отказ с перечнем известных ему операций. Что входит в выпуск, а что пока только в контракт — в [обзоре справочника](/reference/f1/overview/). **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------------------------- | ----- | | operation | “manage\_cell\_styles” | да | | `subsetId` | string | да | | action | [ContractCellStylesManagerAction](/reference/f1/types-format/#contractcellstylesmanageraction) | да | | `expectedRevision` | number \| null | нет | | `readOnly` | boolean | нет | | protected | boolean | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | **Ответ при успехе · manage\_cell\_styles** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------------------------------- | ----- | | operation | “manage\_cell\_styles” | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | action | “inspect” \| “commit” \| “applyStyle” \| “mergeFromWorkbook” | да | | styles | [ContractCellStyleDefinition](/reference/f1/types-format/#contractcellstyledefinition)\[] | да | | authority | [ContractCellStylesManagerAuthority](/reference/f1/types-format/#contractcellstylesmanagerauthority) | да | | `didChange` | boolean | да | | `changedCellCount` | number | да | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "manage_cell_styles",
  "subsetId": "<subsetId>",
  "action": "<ContractCellStylesManagerAction>"
}
```
 ## manage\_conditional\_formatting\_rules [Заголовок раздела «manage\_conditional\_formatting\_rules»](#manage_conditional_formatting_rules) В опубликованный выпуск пока не вошла Операция описана контрактом, но ядро последнего выпуска её не принимает: на такой запрос придёт отказ с перечнем известных ему операций. Что входит в выпуск, а что пока только в контракт — в [обзоре справочника](/reference/f1/overview/). Управляет conditional formatting rules. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | -------------------------------------------------------------------------------------------------------------------- | ----- | | operation | `"manage_conditional_formatting_rules"` | да | | `subsetId` | string | да | | `sheetKey` | string | да | | action | [ContractConditionalFormattingManagerAction](/reference/f1/types-format/#contractconditionalformattingmanageraction) | да | | `expectedRevision` | number \| null | нет | | `readOnly` | boolean | нет | | protected | boolean | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · manage\_conditional\_formatting\_rules** | Поле | Тип TypeScript | Обяз. | | ----------------- | -------------------------------------------------------------------------------------------------------------------------- | ----- | | operation | `"manage_conditional_formatting_rules"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | action | `"inspect"` \| “apply” | да | | rules | [ContractConditionalRule](/reference/f1/types-format/#contractconditionalrule)\[] | да | | `opaqueRules` | [ContractConditionalFormattingOpaqueRule](/reference/f1/types-format/#contractconditionalformattingopaquerule)\[] | да | | authority | [ContractConditionalFormattingManagerAuthority](/reference/f1/types-format/#contractconditionalformattingmanagerauthority) | да | | `didChange` | boolean | да | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "manage_conditional_formatting_rules",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "action": "<ContractConditionalFormattingManagerAction>",
  "requestedBackend": "native-desktop"
}
```
 ## manage\_table\_styles [Заголовок раздела «manage\_table\_styles»](#manage_table_styles) В опубликованный выпуск пока не вошла Операция описана контрактом, но ядро последнего выпуска её не принимает: на такой запрос придёт отказ с перечнем известных ему операций. Что входит в выпуск, а что пока только в контракт — в [обзоре справочника](/reference/f1/overview/). **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ------------------------------------------------------------------------------------------------ | ----- | | operation | “manage\_table\_styles” | да | | `subsetId` | string | да | | action | [ContractTableStylesManagerAction](/reference/f1/types-format/#contracttablestylesmanageraction) | да | | `expectedRevision` | number \| null | нет | | `readOnly` | boolean | нет | | protected | boolean | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | **Ответ при успехе · manage\_table\_styles** | Поле | Тип TypeScript | Обяз. | | ------------------- | ------------------------------------------------------------------------------------------------------ | ----- | | operation | “manage\_table\_styles” | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | action | “inspect” \| “commit” \| “applyStyle” | да | | styles | [ContractTableStyleDefinition](/reference/f1/types-format/#contracttablestyledefinition)\[] | да | | tables | [ContractTableMetadataProjection](/reference/f1/types-data/#contracttablemetadataprojection) | да | | authority | [ContractTableStylesManagerAuthority](/reference/f1/types-format/#contracttablestylesmanagerauthority) | да | | `didChange` | boolean | да | | `changedTableCount` | number | да | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "manage_table_styles",
  "subsetId": "<subsetId>",
  "action": "<ContractTableStylesManagerAction>"
}
```
 ## paste\_conditional\_formatting\_rules [Заголовок раздела «paste\_conditional\_formatting\_rules»](#paste_conditional_formatting_rules) Вставляет conditional formatting rules. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"paste_conditional_formatting_rules"` | да | | `subsetId` | string | да | | `clipboardId` | string | да | | target | [CellRange](/reference/f1/types-cells/#cellrange) | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · apply\_conditional\_formatting\_rules** | Поле | Тип TypeScript | Обяз. | | ------------------------------------ | ----------------------------------------------------------------------------------- | ----- | | operation | `"apply_conditional_formatting_rules"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | rules | [ContractConditionalRule](/reference/f1/types-format/#contractconditionalrule)\[] | да | | `preservedUnsupportedRuleBlockCount` | number | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "paste_conditional_formatting_rules",
  "subsetId": "<subsetId>",
  "clipboardId": "<string>",
  "target": "<CellRange>",
  "requestedBackend": "native-desktop"
}
```

# Что можно с каждым форматом

> Матрица форматов: где открытие и правка полные, где частичные, куда сохраняется файл и какие ограничения записаны в контракт.

Таблица собрана из реестра форматов в ядре: это не обещание на словах, а то, что ядро отвечает о себе само. Здесь видно, чем формат отличается от формата ещё до пилота. **Полностью** — работает без оговорок. **Частично** — работает в объявленных границах, остальное отклоняется с причиной. **Только выгрузкой** — сохранить можно, но в другой файл: исходный формат обратно не пишется. **FODS** — плоский ODS: тот же OpenDocument, но одним файлом XML вместо zip-пакета. У документов ему соответствует XODT. | Формат | Открыть | Править | Сохранить | Как сохраняет | Что записано в контракт | | ------------------ | --------- | --------- | ---------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | | XLSX | полностью | полностью | в тот же файл | родной формат туда и обратно | макросы не исполняются, VBA не истолковывается, общей среды языка M нет, полного совпадения Power Query нет | | XLSM | полностью | частично | в тот же файл | родной формат, непонятое переносится как есть | макросы не исполняются, VBA не истолковывается, общей среды языка M нет, полного совпадения Power Query нет | | XLSB | полностью | частично | в тот же файл | родной формат туда и обратно | — | | XLTX | полностью | частично | только выгрузкой | родной формат туда и обратно | макросы не исполняются, VBA не истолковывается, общей среды языка M нет, полного совпадения Power Query нет | | XLTM | полностью | частично | только выгрузкой | родной формат, непонятое переносится как есть | макросы не исполняются, VBA не истолковывается, общей среды языка M нет, полного совпадения Power Query нет | | XLS | полностью | частично | только выгрузкой | выгрузка в канонический вид | макросы не исполняются, VBA не истолковывается, сохранения в тот же формат нет, стили совпадают не полностью | | ODS | полностью | частично | в тот же файл | родной формат туда и обратно | стили совпадают не полностью | | FODS | полностью | частично | в тот же файл | родной формат туда и обратно | стили совпадают не полностью | | SpreadsheetML 2003 | полностью | частично | только выгрузкой | выгрузка в канонический вид | сохранения в тот же формат нет | | CSV | частично | частично | в тот же файл | родной формат туда и обратно | формат держит один лист | | TSV | частично | частично | в тот же файл | родной формат туда и обратно | формат держит один лист | | TXT | частично | частично | в тот же файл | родной формат туда и обратно | формат держит один лист | | HTML | частично | частично | нельзя | — | формат держит один лист |

# Формулы и вычисления

> Пересчёт, режимы вычисления, трассировка зависимостей, аудит формул, именованные диапазоны и анализ «что если». Операций на странице: 16.

Пересчёт, режимы вычисления, трассировка зависимостей, аудит формул, именованные диапазоны и анализ «что если». Термины — в [глоссарии](/start/glossary/). **Операции на этой странице — 16** * [`build_lookup_indices`](#build_lookup_indices) * [`calculate`](#calculate) * [`consolidate_plan`](#consolidate_plan) * [`data_analysis_toolpak`](#data_analysis_toolpak) * [`defined_name_values`](#defined_name_values) * [`defined_names_lifecycle`](#defined_names_lifecycle) * [`delete_defined_name_bounded`](#delete_defined_name_bounded) * [`evaluate_formula_trace`](#evaluate_formula_trace) * [`formula_audit_watch`](#formula_audit_watch) * [`formula_builder_catalog`](#formula_builder_catalog) * [`recalc_frontier`](#recalc_frontier) * [`recalculate_used_range_bounded`](#recalculate_used_range_bounded) * [`set_calculation_options`](#set_calculation_options) * [`trace_formula_dependencies`](#trace_formula_dependencies) * [`upsert_defined_name_bounded`](#upsert_defined_name_bounded) * [`what_if_analysis`](#what_if_analysis) ## build\_lookup\_indices [Заголовок раздела «build\_lookup\_indices»](#build_lookup_indices) Строит lookup indices. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"build_lookup_indices"` | да | | `subsetId` | string | да | | ranges | [CellRange](/reference/f1/types-cells/#cellrange)\[] | да | | mode | [LookupIndexMode](/reference/f1/types-common/#lookupindexmode) | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · build\_lookup\_indices** | Поле | Тип TypeScript | Обяз. | | ----------------- | ----------------------------------------------------------------------------------- | ----- | | operation | `"build_lookup_indices"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | mode | [LookupIndexMode](/reference/f1/types-common/#lookupindexmode) | да | | `duplicatePolicy` | string | да | | `indexHandles` | [LookupIndexHandleInfo](/reference/f1/types-common/#lookupindexhandleinfo)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "build_lookup_indices",
  "subsetId": "<subsetId>",
  "ranges": [],
  "mode": "<LookupIndexMode>",
  "requestedBackend": "native-desktop"
}
```
 ## calculate [Заголовок раздела «calculate»](#calculate) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------------- | ----- | | operation | `"calculate"` | да | | `subsetId` | string | да | | scope | [ContractCalculationScope](/reference/f1/types-formulas/#contractcalculationscope) | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · calculate** | Поле | Тип TypeScript | Обяз. | | ------------------------------- | -------------------------------------------------------------------------------------------------- | ----- | | operation | `"calculate"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | scope | [ContractCalculationScope](/reference/f1/types-formulas/#contractcalculationscope) | да | | `formulaTrustSnapshot` | [ContractFormulaTrustSnapshot](/reference/f1/types-formulas/#contractformulatrustsnapshot) \| null | нет | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `changedKeys` | string\[] | да | | `dirtyCellCount` | number | да | | `completionState` | `"settled"` \| “incomplete” | да | | `supportedFormulaCount` | number | да | | `settledSupportedFormulaCount` | number | да | | `supportedDirtyCellCount` | number | да | | `supportedUnpublishedCellCount` | number | да | | `boundaryFormulaCount` | number | да | | `startedStatus` | [ContractCalculationStatus](/reference/f1/types-formulas/#contractcalculationstatus) | да | | `resultStatus` | [ContractCalculationStatus](/reference/f1/types-formulas/#contractcalculationstatus) | да | | `workbookGeneration` | number | да | | `loadedSheetCountBefore` | number | да | | `loadedSheetCountAfter` | number | да | | `dependencyBoundarySheetCount` | number | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "calculate",
  "subsetId": "<subsetId>",
  "scope": "<ContractCalculationScope>",
  "requestedBackend": "native-desktop"
}
```
 ## consolidate\_plan [Заголовок раздела «consolidate\_plan»](#consolidate_plan) **Запрос** | Поле | Тип TypeScript | Обяз. | | --------------------- | ------------------------------------------------------------------------------------ | ----- | | operation | `"consolidate_plan"` | да | | `subsetId` | string | да | | `sourceRanges` | [CellRange](/reference/f1/types-cells/#cellrange)\[] | да | | destination | [CellRange](/reference/f1/types-cells/#cellrange) | да | | function | [ContractConsolidateFunction](/reference/f1/types-data/#contractconsolidatefunction) | нет | | `useTopRowLabels` | boolean | нет | | `useLeftColumnLabels` | boolean | нет | | `createLinks` | boolean | нет | | `expectedRevision` | number | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · consolidate\_plan** | Поле | Тип TypeScript | Обяз. | | --------------------- | ---------------------------------------------------------------------------------------- | ----- | | operation | `"consolidate_plan"` | да | | `outputRange` | [CellRange](/reference/f1/types-cells/#cellrange) | да | | `sourceValueCount` | number | да | | `outputCellCount` | number | да | | function | [ContractConsolidateFunction](/reference/f1/types-data/#contractconsolidatefunction) | да | | `useTopRowLabels` | boolean | да | | `useLeftColumnLabels` | boolean | да | | `createLinks` | false | да | | mutation | [ContractConsolidationMutation](/reference/f1/types-data/#contractconsolidationmutation) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "consolidate_plan",
  "subsetId": "<subsetId>",
  "sourceRanges": [],
  "destination": "<CellRange>",
  "requestedBackend": "native-desktop"
}
```
 ## data\_analysis\_toolpak [Заголовок раздела «data\_analysis\_toolpak»](#data_analysis_toolpak) **Запрос** | Поле | Тип TypeScript | Обяз. | | ---------------------------- | ------------------------------------------------------------------------------------ | ----- | | operation | `"data_analysis_toolpak"` | да | | `subsetId` | string | да | | intent | [ContractDataAnalysisAction](/reference/f1/types-common/#contractdataanalysisaction) | да | | `expectedWorkbookGeneration` | number \| null | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · data\_analysis\_toolpak** | Поле | Тип TypeScript | Обяз. | | -------------------- | --------------------------------------------------------------------------------------------------- | ----- | | operation | `"data_analysis_toolpak"` | да | | `subsetId` | string | да | | `targetSubsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | action | `"run"` \| “undo” \| “redo” \| “cancel” | да | | status | string | да | | tool | [ContractDataAnalysisTool](/reference/f1/types-common/#contractdataanalysistool)\[`"tool"`] \| null | нет | | applied | boolean | да | | `createdSheet` | boolean | да | | `createdWorkbook` | boolean | да | | `workbookGeneration` | number | да | | `outputRange` | [CellRange](/reference/f1/types-cells/#cellrange) \| null | нет | | `chartPlan` | [ContractDataAnalysisChartPlan](/reference/f1/types-charts/#contractdataanalysischartplan) \| null | нет | | `changedKeys` | string\[] | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "data_analysis_toolpak",
  "subsetId": "<subsetId>",
  "intent": "<ContractDataAnalysisAction>",
  "requestedBackend": "native-desktop"
}
```
 ## defined\_name\_values [Заголовок раздела «defined\_name\_values»](#defined_name_values) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"defined_name_values"` | да | | `subsetId` | string | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · defined\_name\_values** | Поле | Тип TypeScript | Обяз. | | ---------- | ------------------------------------------------------------------------------------- | ----- | | operation | `"defined_name_values"` | да | | `subsetId` | string | да | | values | [ContractDefinedNameValue](/reference/f1/types-formulas/#contractdefinednamevalue)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "defined_name_values",
  "subsetId": "<subsetId>",
  "requestedBackend": "native-desktop"
}
```
 ## defined\_names\_lifecycle [Заголовок раздела «defined\_names\_lifecycle»](#defined_names_lifecycle) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | -------------------------------------------------------------------------------------- | ----- | | operation | `"defined_names_lifecycle"` | да | | `subsetId` | string | да | | intent | [ContractDefinedNamesIntent](/reference/f1/types-formulas/#contractdefinednamesintent) | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · defined\_names\_lifecycle** | Поле | Тип TypeScript | Обяз. | | ---------------- | --------------------------------------------------------------------------------------- | ----- | | operation | `"defined_names_lifecycle"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | result | [ContractDefinedNamesResult](/reference/f1/types-formulas/#contractdefinednamesresult) | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "defined_names_lifecycle",
  "subsetId": "<subsetId>",
  "intent": "<ContractDefinedNamesIntent>",
  "requestedBackend": "native-desktop"
}
```
 ## delete\_defined\_name\_bounded [Заголовок раздела «delete\_defined\_name\_bounded»](#delete_defined_name_bounded) Удаляет defined name bounded. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"delete_defined_name_bounded"` | да | | `subsetId` | string | да | | name | string | да | | scope | `"workbook"` \| “sheet” | да | | `scopeSheetKey` | string \| null | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · delete\_defined\_name\_bounded** | Поле | Тип TypeScript | Обяз. | | ------------------------ | --------------------------------------------------------------------------------------- | ----- | | operation | `"delete_defined_name_bounded"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `deletedName` | string | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) | нет | | `definedNameDeleteClaim` | string | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "delete_defined_name_bounded",
  "subsetId": "<subsetId>",
  "name": "<string>",
  "scope": "workbook",
  "requestedBackend": "native-desktop"
}
```
 ## evaluate\_formula\_trace [Заголовок раздела «evaluate\_formula\_trace»](#evaluate_formula_trace) Вычисляет/оценивает formula trace. **Запрос** | Поле | Тип TypeScript | Обяз. | | ---------------------------- | ------------------------------------------------------------------------------------------------ | ----- | | operation | `"evaluate_formula_trace"` | да | | `subsetId` | string | да | | action | [ContractFormulaEvaluationAction](/reference/f1/types-formulas/#contractformulaevaluationaction) | да | | `anchorKey` | string | нет | | `traceId` | string | нет | | `expectedWorkbookGeneration` | number | нет | | `activeSheetKey` | string | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · evaluate\_formula\_trace** | Поле | Тип TypeScript | Обяз. | | --------------------------- | ---------------------------------------------------------------------------------------------------------------- | ----- | | operation | `"evaluate_formula_trace"` | да | | `subsetId` | string | да | | `traceId` | string \| null | да | | `requestWorkbookGeneration` | number \| null | да | | `workbookGeneration` | number | да | | `deterministicTraceHash` | string | да | | `anchorKey` | string | да | | `resolvedAnchorKey` | string | да | | `formulaSource` | string \| null | да | | `currentStep` | [ContractFormulaEvaluationStep](/reference/f1/types-formulas/#contractformulaevaluationstep) \| null | да | | `stepIndex` | number | да | | `stepCount` | number | да | | stack | [ContractFormulaEvaluationStackFrame](/reference/f1/types-formulas/#contractformulaevaluationstackframe)\[] | да | | value | [ContractFormulaEvaluationValue](/reference/f1/types-formulas/#contractformulaevaluationvalue) | да | | trust | [ContractFormulaEvaluationTrust](/reference/f1/types-formulas/#contractformulaevaluationtrust) | да | | `referenceTargetKey` | string \| null | да | | diagnostic | [ContractFormulaEvaluationDiagnostic](/reference/f1/types-formulas/#contractformulaevaluationdiagnostic) \| null | да | | outcome | [ContractFormulaEvaluationOutcome](/reference/f1/types-formulas/#contractformulaevaluationoutcome) | да | | actions | [ContractFormulaEvaluationActions](/reference/f1/types-formulas/#contractformulaevaluationactions) | да | | persistence | [ContractFormulaAuditingStatePersistence](/reference/f1/types-formulas/#contractformulaauditingstatepersistence) | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "evaluate_formula_trace",
  "subsetId": "<subsetId>",
  "action": "<ContractFormulaEvaluationAction>",
  "activeSheetKey": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## formula\_audit\_watch [Заголовок раздела «formula\_audit\_watch»](#formula_audit_watch) **Запрос** | Поле | Тип TypeScript | Обяз. | | ---------------------------- | ------------------------------------------------------------------------------------------------ | ----- | | operation | `"formula_audit_watch"` | да | | `subsetId` | string | да | | action | [ContractFormulaAuditWatchAction](/reference/f1/types-formulas/#contractformulaauditwatchaction) | да | | `expectedWorkbookGeneration` | number | да | | `activeSheetKey` | string | да | | `targetKey` | string | нет | | `findingKind` | [ContractFormulaAuditFindingKind](/reference/f1/types-formulas/#contractformulaauditfindingkind) | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · formula\_audit\_watch** | Поле | Тип TypeScript | Обяз. | | --------------------------- | ---------------------------------------------------------------------------------------------------------------- | ----- | | operation | `"formula_audit_watch"` | да | | `subsetId` | string | да | | `requestWorkbookGeneration` | number | да | | `workbookGeneration` | number | да | | `deterministicSnapshotHash` | string | да | | `calculationMode` | [ContractWorkbookCalculationMode](/reference/f1/types-session/#contractworkbookcalculationmode) | да | | outcome | [ContractFormulaAuditOutcome](/reference/f1/types-formulas/#contractformulaauditoutcome) | да | | `didChange` | boolean | да | | findings | [ContractFormulaAuditFinding](/reference/f1/types-formulas/#contractformulaauditfinding)\[] | да | | watches | [ContractFormulaAuditWatchRow](/reference/f1/types-formulas/#contractformulaauditwatchrow)\[] | да | | counts | [ContractFormulaAuditCounts](/reference/f1/types-formulas/#contractformulaauditcounts) | да | | actions | [ContractFormulaAuditActions](/reference/f1/types-formulas/#contractformulaauditactions) | да | | persistence | [ContractFormulaAuditingStatePersistence](/reference/f1/types-formulas/#contractformulaauditingstatepersistence) | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "formula_audit_watch",
  "subsetId": "<subsetId>",
  "action": "<ContractFormulaAuditWatchAction>",
  "expectedWorkbookGeneration": 0,
  "activeSheetKey": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## formula\_builder\_catalog [Заголовок раздела «formula\_builder\_catalog»](#formula_builder_catalog) В опубликованный выпуск пока не вошла Операция описана контрактом, но ядро последнего выпуска её не принимает: на такой запрос придёт отказ с перечнем известных ему операций. Что входит в выпуск, а что пока только в контракт — в [обзоре справочника](/reference/f1/overview/). **Запрос** | Поле | Тип TypeScript | Обяз. | | --------- | --------------------------- | ----- | | operation | “formula\_builder\_catalog” | да | | locale | string | да | **Ответ при успехе · formula\_builder\_catalog** | Поле | Тип TypeScript | Обяз. | | --------- | -------------------------------------------------------------------------------------------- | ----- | | operation | “formula\_builder\_catalog” | да | | catalog | [ContractFormulaBuilderCatalog](/reference/f1/types-formulas/#contractformulabuildercatalog) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "formula_builder_catalog",
  "locale": "<locale>"
}
```
 ## recalc\_frontier [Заголовок раздела «recalc\_frontier»](#recalc_frontier) Пересчитывает frontier. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"recalc_frontier"` | да | | `subsetId` | string | да | | `frontierKeys` | string\[] | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · recalc\_frontier** | Поле | Тип TypeScript | Обяз. | | ----------------- | ----------------------------------------------------------------------------------- | ----- | | operation | `"recalc_frontier"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `changedKeys` | string\[] | да | | `dirtyCellCount` | number | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "recalc_frontier",
  "subsetId": "<subsetId>",
  "frontierKeys": [],
  "requestedBackend": "native-desktop"
}
```
 ## recalculate\_used\_range\_bounded [Заголовок раздела «recalculate\_used\_range\_bounded»](#recalculate_used_range_bounded) Пересчитывает used range bounded. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"recalculate_used_range_bounded"` | да | | `subsetId` | string | да | | `sheetKey` | string | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · recalculate\_used\_range\_bounded** | Поле | Тип TypeScript | Обяз. | | --------------------------- | --------------------------------------------------------------------------------------------------- | ----- | | operation | `"recalculate_used_range_bounded"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `changedSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `previousUsedRange` | string | да | | `usedRange` | string | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) \| null | нет | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `usedRangeRecalculateClaim` | `"live_verified"` | да | | `usedRangeRecalculateScope` | `"same_workbook_worksheet_dimension_from_present_cells_and_metadata"` | да | | `usedRangeDirtyCleared` | true | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "recalculate_used_range_bounded",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "requestedBackend": "native-desktop"
}
```
 ## set\_calculation\_options [Заголовок раздела «set\_calculation\_options»](#set_calculation_options) Устанавливает calculation options. **Запрос** | Поле | Тип TypeScript | Обяз. | | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ----- | | operation | `"set_calculation_options"` | да | | `subsetId` | string | да | | `calculationMode` | Exclude< [ContractWorkbookCalculationMode](/reference/f1/types-session/#contractworkbookcalculationmode), `"unknown"` > \| null | нет | | `recalculateBeforeSave` | boolean \| null | нет | | `iterativeCalculationEnabled` | boolean \| null | нет | | `maximumIterations` | number \| null | нет | | `maximumChange` | number \| null | нет | | `historyAction` | [ContractCalculationOptionsHistoryAction](/reference/f1/types-formulas/#contractcalculationoptionshistoryaction) | нет | | `expectedWorkbookGeneration` | number \| null | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · set\_calculation\_options** | Поле | Тип TypeScript | Обяз. | | --------------------------- | ---------------------------------------------------------------------------------------------------------------- | ----- | | operation | `"set_calculation_options"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `previousCalculationMode` | [ContractWorkbookCalculationMode](/reference/f1/types-session/#contractworkbookcalculationmode) | да | | `calculationMode` | [ContractWorkbookCalculationMode](/reference/f1/types-session/#contractworkbookcalculationmode) | да | | `previousIterativeSettings` | [ContractIterativeCalculationSettings](/reference/f1/types-formulas/#contractiterativecalculationsettings) | да | | `iterativeSettings` | [ContractIterativeCalculationSettings](/reference/f1/types-formulas/#contractiterativecalculationsettings) | да | | `recalculateBeforeSave` | boolean \| null | нет | | `historyAction` | [ContractCalculationOptionsHistoryAction](/reference/f1/types-formulas/#contractcalculationoptionshistoryaction) | да | | `workbookGeneration` | number | да | | `undoAvailable` | boolean | да | | `redoAvailable` | boolean | да | | `optionsChanged` | boolean | да | | `formulaTrustSnapshot` | [ContractFormulaTrustSnapshot](/reference/f1/types-formulas/#contractformulatrustsnapshot) \| null | нет | | `calculationPerformed` | boolean | да | | `changedKeys` | string\[] | да | | `dirtyCellCount` | number | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "set_calculation_options",
  "subsetId": "<subsetId>",
  "requestedBackend": "native-desktop"
}
```
 ## trace\_formula\_dependencies [Заголовок раздела «trace\_formula\_dependencies»](#trace_formula_dependencies) Трассирует formula dependencies. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"trace_formula_dependencies"` | да | | `subsetId` | string | да | | `anchorKey` | string | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · trace\_formula\_dependencies** | Поле | Тип TypeScript | Обяз. | | ---------------------------- | ---------------------------------------------------------------------------------------------------------------- | ----- | | operation | `"trace_formula_dependencies"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | `anchorKey` | string | да | | `anchorFormula` | string \| null | да | | `anchorStatus` | [FormulaSubsetStatus](/reference/f1/types-session/#formulasubsetstatus) | да | | `directPrecedentKeys` | string\[] | да | | `directDependentKeys` | string\[] | да | | `unsupportedReferences` | string\[] | да | | `graphVersion` | number | нет | | `graphHash` | string | нет | | `maxDepth` | number | нет | | edges | [ContractFormulaTraceEdge](/reference/f1/types-formulas/#contractformulatraceedge)\[] | нет | | `precedentTruncated` | boolean | нет | | `dependentTruncated` | boolean | нет | | `cycleGroups` | string\[]\[] | нет | | `missingOrDeletedReferences` | string\[] | нет | | persistence | [ContractFormulaAuditingStatePersistence](/reference/f1/types-formulas/#contractformulaauditingstatepersistence) | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "trace_formula_dependencies",
  "subsetId": "<subsetId>",
  "anchorKey": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## upsert\_defined\_name\_bounded [Заголовок раздела «upsert\_defined\_name\_bounded»](#upsert_defined_name_bounded) Создаёт или обновляет defined name bounded. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"upsert_defined_name_bounded"` | да | | `subsetId` | string | да | | name | string | да | | `refersTo` | string | да | | scope | `"workbook"` \| “sheet” | да | | `scopeSheetKey` | string \| null | нет | | `previousName` | string \| null | нет | | comment | string \| null | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · upsert\_defined\_name\_bounded** | Поле | Тип TypeScript | Обяз. | | ------------------------ | --------------------------------------------------------------------------------------- | ----- | | operation | `"upsert_defined_name_bounded"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `upsertedName` | string | да | | `refersTo` | string | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) | нет | | `definedNameUpsertClaim` | string | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "upsert_defined_name_bounded",
  "subsetId": "<subsetId>",
  "name": "<string>",
  "refersTo": "<string>",
  "scope": "workbook",
  "requestedBackend": "native-desktop"
}
```
 ## what\_if\_analysis [Заголовок раздела «what\_if\_analysis»](#what_if_analysis) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"what_if_analysis"` | да | | `subsetId` | string | да | | intent | [ContractWhatIfAction](/reference/f1/types-common/#contractwhatifaction) | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · what\_if\_analysis** | Поле | Тип TypeScript | Обяз. | | ----------------- | --------------------------------------------------------------------------------------------------- | ----- | | operation | `"what_if_analysis"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | action | string | да | | status | string | да | | `previewToken` | string \| null | нет | | applied | boolean | да | | iterations | number | да | | solution | number \| null | нет | | `resultValue` | [ContractWhatIfValue](/reference/f1/types-common/#contractwhatifvalue) \| null | нет | | `tableValues` | [ContractWhatIfValue](/reference/f1/types-common/#contractwhatifvalue)\[]\[] | да | | scenarios | [ContractWhatIfScenarioView](/reference/f1/types-formulas/#contractwhatifscenarioview)\[] | да | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `changedKeys` | string\[] | да | | `dirtyCellCount` | number | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "what_if_analysis",
  "subsetId": "<subsetId>",
  "intent": "<ContractWhatIfAction>",
  "requestedBackend": "native-desktop"
}
```

# Справочник F1

> Compute Contract: транспорт, соглашения сеанса и 203 операции табличного процессора, сгруппированных по доменам.

Справочник F1 описывает работу с таблицами XLSX. Для документов DOCX есть [справочник A4](/reference/a4/overview/). Compute Contract — единственная типизированная граница между интерфейсом, автоматизацией, адаптерами к вашему приложению и ядром F1 на Rust. Через неё проходят все 203 операции, где бы ядро ни выполнялось: в настольном приложении, в браузере через WebAssembly или службой на сервере. ## Разделы операций [Заголовок раздела «Разделы операций»](#разделы-операций) | Раздел | Операций | О чём | | ----------------------------------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------- | | [Сеанс и книга](/reference/f1/session/) | 17 | Открытие подмножества книги, сохранение, окно просмотра, восстановление, свойства, сравнение и слияние ревизий. | | [Ячейки и диапазоны](/reference/f1/cells/) | 21 | Правка ячеек, чтение деталей, сдвиги, копирование и вставка, поиск и замена, сортировка, отмена и повтор. | | [Листы](/reference/f1/sheets/) | 17 | Жизненный цикл листов, копирование между книгами, видимость, защита и закрепление областей. | | [Печать и разметка](/reference/f1/printing/) | 7 | Параметры страницы, разрывы, фон листа и печать листов с диаграммами. | | [Формулы и вычисления](/reference/f1/formulas/) | 16 | Пересчёт, режимы вычисления, трассировка зависимостей, аудит формул, именованные диапазоны и анализ «что если». | | [Форматирование](/reference/f1/format/) | 10 | Ширина колонок и высота строк, объединение ячеек, темы и шрифты, условное форматирование. | | [Данные, фильтры и объекты](/reference/f1/data/) | 23 | Фильтры, промежуточные итоги, очистка данных, таблицы, импорт текста, проверка данных, срезы и элементы управления. | | [Сводные таблицы](/reference/f1/pivot/) | 11 | Кэш, вычисляемые поля и элементы, группировка и детализация, макет, фильтры отчёта, сортировка и параметры полей значений. | | [Power Query: выражения M](/reference/f1/pq-expressions/) | 9 | Вычисление и разбор M-выражений, в том числе с внешними источниками. | | [Power Query: коннекторы](/reference/f1/pq-connectors/) | 13 | Подключение к Postgres, SQL Server, OData и веб-источникам: проверка связи, предпросмотр, навигация по объектам. | | [Power Query: запросы и шаги](/reference/f1/pq-queries/) | 13 | Жизненный цикл запросов, применённые шаги, параметры и навигация по папкам. | | [Power Query: таблицы из запросов](/reference/f1/pq-tables/) | 8 | Загрузка результата запроса в лист, обновление таких таблиц и связь между таблицей на листе и запросом, который её наполняет. | | [Power Query: выполнение и прогресс](/reference/f1/pq-execution/) | 9 | Граф запроса, обновление, отмена и наблюдение за долгими операциями. | | [Power Query: доверие и приватность](/reference/f1/pq-trust/) | 6 | Уровни приватности источников, решения о доверии и настройки подключений. | | [Power Query: внешние mashup](/reference/f1/pq-mashup/) | 3 | Чтение, запись и обновление наборов запросов Power Query, собранных вне продукта. | | [VBA и макросы](/reference/f1/vba/) | 12 | Инспекция проекта, планирование и запуск, статус, отмена и откат, доверие к макросам и список одобренных. | | [Защита и рецензирование](/reference/f1/protection/) | 8 | Защита листа и книги, разрешения на диапазоны, аудит защиты, отслеживание изменений, примечания и рукописные пометки. | ## Словарь типов [Заголовок раздела «Словарь типов»](#словарь-типов) В колонке «Тип TypeScript» стоят имена вроде `ViewportWindow` или `ContractSubsetSessionInfo`. Их определения собраны в [словаре типов](/reference/f1/types-session/) — 946 имён, разложенных по тем же темам, что и операции. Каждое имя в таблицах полей ведёт прямо к своему определению. Возврат под другим именем Операция может вернуть success payload с другим `operation`: `open_workbook_subset_from_bytes` → `open_workbook_subset`; `move_clipboard_range` → `paste_range`; `paste_conditional_formatting_rules` → `apply_conditional_formatting_rules`.

# Сводные таблицы

> Кэш, вычисляемые поля и элементы, группировка и детализация, макет, фильтры отчёта, сортировка и параметры полей значений. Операций на странице: 11.

Кэш, вычисляемые поля и элементы, группировка и детализация, макет, фильтры отчёта, сортировка и параметры полей значений. Термины — в [глоссарии](/start/glossary/). **Операции на этой странице — 11** * [`pivot_cache_options`](#pivot_cache_options) * [`pivot_calculated_fields`](#pivot_calculated_fields) * [`pivot_calculated_items`](#pivot_calculated_items) * [`pivot_data_model_olap_readonly`](#pivot_data_model_olap_readonly) * [`pivot_field_list_authoring`](#pivot_field_list_authoring) * [`pivot_grouping_drilldown`](#pivot_grouping_drilldown) * [`pivot_layout_format`](#pivot_layout_format) * [`pivot_move_copy`](#pivot_move_copy) * [`pivot_report_filter_pages`](#pivot_report_filter_pages) * [`pivot_sort_filter_ranking`](#pivot_sort_filter_ranking) * [`pivot_value_field_settings`](#pivot_value_field_settings) ## pivot\_cache\_options [Заголовок раздела «pivot\_cache\_options»](#pivot_cache_options) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | --------------------------------------------------------------------------------------------- | ----- | | operation | `"pivot_cache_options"` | да | | `subsetId` | string | да | | `requestId` | string | да | | intent | [ContractPivotCacheOptionsAction](/reference/f1/types-pivot/#contractpivotcacheoptionsaction) | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · pivot\_cache\_options** | Поле | Тип TypeScript | Обяз. | | --------------------- | -------------------------------------------------------------------------------------------- | ----- | | operation | `"pivot_cache_options"` | да | | `subsetId` | string | да | | `requestId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | action | string | да | | status | string | да | | `didChange` | boolean | да | | options | [ContractPivotCacheOptionsView](/reference/f1/types-pivot/#contractpivotcacheoptionsview)\[] | да | | `refreshedPivotNames` | string\[] | да | | `dirtyCellCount` | number | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pivot_cache_options",
  "subsetId": "<subsetId>",
  "requestId": "<string>",
  "intent": "<ContractPivotCacheOptionsAction>",
  "requestedBackend": "native-desktop"
}
```
 ## pivot\_calculated\_fields [Заголовок раздела «pivot\_calculated\_fields»](#pivot_calculated_fields) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ----------------------------------------------------------------------------------------------------- | ----- | | operation | `"pivot_calculated_fields"` | да | | `subsetId` | string | да | | intent | [ContractPivotCalculatedFieldsAction](/reference/f1/types-pivot/#contractpivotcalculatedfieldsaction) | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · pivot\_calculated\_fields** | Поле | Тип TypeScript | Обяз. | | ------------------- | -------------------------------------------------------------------------------------------------- | ----- | | operation | `"pivot_calculated_fields"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | action | string | да | | status | string | да | | caches | [ContractPivotCalculatedCacheView](/reference/f1/types-pivot/#contractpivotcalculatedcacheview)\[] | да | | fields | [ContractPivotCalculatedFieldView](/reference/f1/types-pivot/#contractpivotcalculatedfieldview)\[] | да | | `refreshedCacheIds` | string\[] | да | | `dirtyCellCount` | number | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pivot_calculated_fields",
  "subsetId": "<subsetId>",
  "intent": "<ContractPivotCalculatedFieldsAction>",
  "requestedBackend": "native-desktop"
}
```
 ## pivot\_calculated\_items [Заголовок раздела «pivot\_calculated\_items»](#pivot_calculated_items) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | --------------------------------------------------------------------------------------------------- | ----- | | operation | `"pivot_calculated_items"` | да | | `subsetId` | string | да | | intent | [ContractPivotCalculatedItemsAction](/reference/f1/types-pivot/#contractpivotcalculateditemsaction) | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · pivot\_calculated\_items** | Поле | Тип TypeScript | Обяз. | | ------------------- | ---------------------------------------------------------------------------------------------------------- | ----- | | operation | `"pivot_calculated_items"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | action | string | да | | status | string | да | | fields | [ContractPivotCalculatedItemFieldView](/reference/f1/types-pivot/#contractpivotcalculateditemfieldview)\[] | да | | items | [ContractPivotCalculatedItemView](/reference/f1/types-pivot/#contractpivotcalculateditemview)\[] | да | | `refreshedCacheIds` | string\[] | да | | `dirtyCellCount` | number | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pivot_calculated_items",
  "subsetId": "<subsetId>",
  "intent": "<ContractPivotCalculatedItemsAction>",
  "requestedBackend": "native-desktop"
}
```
 ## pivot\_data\_model\_olap\_readonly [Заголовок раздела «pivot\_data\_model\_olap\_readonly»](#pivot_data_model_olap_readonly) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | --------------------------------------------------------------------------------------------------------------- | ----- | | operation | `"pivot_data_model_olap_readonly"` | да | | `subsetId` | string | да | | `requestId` | string | да | | intent | [ContractPivotDataModelOlapReadonlyAction](/reference/f1/types-pivot/#contractpivotdatamodelolapreadonlyaction) | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · pivot\_data\_model\_olap\_readonly** | Поле | Тип TypeScript | Обяз. | | ------------------------ | ----------------------------------------------------------------------------------------------------- | ----- | | operation | `"pivot_data_model_olap_readonly"` | да | | `subsetId` | string | да | | `requestId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | action | string | да | | status | `"ok"` \| “blocked” | да | | `didChange` | false | да | | `blockedReasonCode` | string \| null | да | | `selectedEntityStableId` | string \| null | да | | inventory | [ContractPivotDataModelOlapInventory](/reference/f1/types-pivot/#contractpivotdatamodelolapinventory) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pivot_data_model_olap_readonly",
  "subsetId": "<subsetId>",
  "requestId": "<string>",
  "intent": "<ContractPivotDataModelOlapReadonlyAction>",
  "requestedBackend": "native-desktop"
}
```
 ## pivot\_field\_list\_authoring [Заголовок раздела «pivot\_field\_list\_authoring»](#pivot_field_list_authoring) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | --------------------------------------------------------------------------------------------------------- | ----- | | operation | `"pivot_field_list_authoring"` | да | | `subsetId` | string | да | | `requestId` | string | да | | intent | [ContractPivotFieldListAuthoringAction](/reference/f1/types-pivot/#contractpivotfieldlistauthoringaction) | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · pivot\_field\_list\_authoring** | Поле | Тип TypeScript | Обяз. | | ---------------- | -------------------------------------------------------------------------------------- | ----- | | operation | `"pivot_field_list_authoring"` | да | | `subsetId` | string | да | | `requestId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | action | string | да | | status | string | да | | `didChange` | boolean | да | | `draftChanged` | boolean | да | | layouts | [ContractPivotFieldListView](/reference/f1/types-pivot/#contractpivotfieldlistview)\[] | да | | `dirtyCellCount` | number | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pivot_field_list_authoring",
  "subsetId": "<subsetId>",
  "requestId": "<string>",
  "intent": "<ContractPivotFieldListAuthoringAction>",
  "requestedBackend": "native-desktop"
}
```
 ## pivot\_grouping\_drilldown [Заголовок раздела «pivot\_grouping\_drilldown»](#pivot_grouping_drilldown) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ------------------------------------------------------------------------------------------------------- | ----- | | operation | `"pivot_grouping_drilldown"` | да | | `subsetId` | string | да | | `requestId` | string | да | | intent | [ContractPivotGroupingDrilldownAction](/reference/f1/types-pivot/#contractpivotgroupingdrilldownaction) | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · pivot\_grouping\_drilldown** | Поле | Тип TypeScript | Обяз. | | --------------------- | --------------------------------------------------------------------------------------------------- | ----- | | operation | `"pivot_grouping_drilldown"` | да | | `subsetId` | string | да | | `requestId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | action | string | да | | status | string | да | | `didChange` | boolean | да | | caches | [ContractPivotGroupingCacheView](/reference/f1/types-pivot/#contractpivotgroupingcacheview)\[] | да | | items | [ContractPivotGroupingItemView](/reference/f1/types-pivot/#contractpivotgroupingitemview)\[] | да | | groups | [ContractPivotGroupView](/reference/f1/types-pivot/#contractpivotgroupview)\[] | да | | `expandedItems` | [ContractPivotExpandedItemView](/reference/f1/types-pivot/#contractpivotexpandeditemview)\[] | да | | `hierarchyNodes` | [ContractPivotHierarchyNodeView](/reference/f1/types-pivot/#contractpivothierarchynodeview)\[] | да | | `refreshedPivotNames` | string\[] | да | | `detailContext` | [ContractPivotDetailContextView](/reference/f1/types-pivot/#contractpivotdetailcontextview) \| null | нет | | `getPivotData` | [ContractPivotGetPivotDataView](/reference/f1/types-pivot/#contractpivotgetpivotdataview) \| null | нет | | `detailSheetLineage` | [ContractPivotDetailLineageView](/reference/f1/types-pivot/#contractpivotdetaillineageview) \| null | нет | | `dirtyCellCount` | number | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pivot_grouping_drilldown",
  "subsetId": "<subsetId>",
  "requestId": "<string>",
  "intent": "<ContractPivotGroupingDrilldownAction>",
  "requestedBackend": "native-desktop"
}
```
 ## pivot\_layout\_format [Заголовок раздела «pivot\_layout\_format»](#pivot_layout_format) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | --------------------------------------------------------------------------------------------- | ----- | | operation | `"pivot_layout_format"` | да | | `subsetId` | string | да | | `requestId` | string | да | | intent | [ContractPivotLayoutFormatAction](/reference/f1/types-pivot/#contractpivotlayoutformataction) | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · pivot\_layout\_format** | Поле | Тип TypeScript | Обяз. | | --------------------- | -------------------------------------------------------------------------------------------- | ----- | | operation | `"pivot_layout_format"` | да | | `subsetId` | string | да | | `requestId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | action | string | да | | status | string | да | | `didChange` | boolean | да | | layouts | [ContractPivotLayoutFormatView](/reference/f1/types-pivot/#contractpivotlayoutformatview)\[] | да | | `refreshedPivotNames` | string\[] | да | | `dirtyCellCount` | number | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pivot_layout_format",
  "subsetId": "<subsetId>",
  "requestId": "<string>",
  "intent": "<ContractPivotLayoutFormatAction>",
  "requestedBackend": "native-desktop"
}
```
 ## pivot\_move\_copy [Заголовок раздела «pivot\_move\_copy»](#pivot_move_copy) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ------------------------------------------------------------------------------------- | ----- | | operation | `"pivot_move_copy"` | да | | `subsetId` | string | да | | `requestId` | string | да | | intent | [ContractPivotMoveCopyAction](/reference/f1/types-pivot/#contractpivotmovecopyaction) | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · pivot\_move\_copy** | Поле | Тип TypeScript | Обяз. | | ------------------- | ---------------------------------------------------------------------------------------------- | ----- | | operation | `"pivot_move_copy"` | да | | `subsetId` | string | да | | `requestId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | action | string | да | | status | string | да | | `didChange` | boolean | да | | pivots | [ContractPivotMoveCopyView](/reference/f1/types-pivot/#contractpivotmovecopyview)\[] | да | | `destinationSheets` | [ContractPivotMoveCopySheetView](/reference/f1/types-pivot/#contractpivotmovecopysheetview)\[] | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pivot_move_copy",
  "subsetId": "<subsetId>",
  "requestId": "<string>",
  "intent": "<ContractPivotMoveCopyAction>",
  "requestedBackend": "native-desktop"
}
```
 ## pivot\_report\_filter\_pages [Заголовок раздела «pivot\_report\_filter\_pages»](#pivot_report_filter_pages) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ------------------------------------------------------------------------------------------------------- | ----- | | operation | `"pivot_report_filter_pages"` | да | | `subsetId` | string | да | | `requestId` | string | да | | intent | [ContractPivotReportFilterPagesAction](/reference/f1/types-pivot/#contractpivotreportfilterpagesaction) | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · pivot\_report\_filter\_pages** | Поле | Тип TypeScript | Обяз. | | --------------------- | ---------------------------------------------------------------------------------------------------- | ----- | | operation | `"pivot_report_filter_pages"` | да | | `subsetId` | string | да | | `requestId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | action | string | да | | status | string | да | | `didChange` | boolean | да | | reports | [ContractPivotReportFilterView](/reference/f1/types-pivot/#contractpivotreportfilterview)\[] | да | | `generatedPages` | [ContractPivotReportFilterPageView](/reference/f1/types-pivot/#contractpivotreportfilterpageview)\[] | да | | `refreshedPivotNames` | string\[] | да | | `dirtyCellCount` | number | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pivot_report_filter_pages",
  "subsetId": "<subsetId>",
  "requestId": "<string>",
  "intent": "<ContractPivotReportFilterPagesAction>",
  "requestedBackend": "native-desktop"
}
```
 ## pivot\_sort\_filter\_ranking [Заголовок раздела «pivot\_sort\_filter\_ranking»](#pivot_sort_filter_ranking) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ----------------------------------------------------------------------------------------- | ----- | | operation | `"pivot_sort_filter_ranking"` | да | | `subsetId` | string | да | | `requestId` | string | да | | intent | [ContractPivotSortFilterAction](/reference/f1/types-pivot/#contractpivotsortfilteraction) | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · pivot\_sort\_filter\_ranking** | Поле | Тип TypeScript | Обяз. | | --------------------- | ---------------------------------------------------------------------------------------- | ----- | | operation | `"pivot_sort_filter_ranking"` | да | | `subsetId` | string | да | | `requestId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | action | string | да | | status | string | да | | `didChange` | boolean | да | | fields | [ContractPivotSortFilterView](/reference/f1/types-pivot/#contractpivotsortfilterview)\[] | да | | `refreshedPivotNames` | string\[] | да | | `dirtyCellCount` | number | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pivot_sort_filter_ranking",
  "subsetId": "<subsetId>",
  "requestId": "<string>",
  "intent": "<ContractPivotSortFilterAction>",
  "requestedBackend": "native-desktop"
}
```
 ## pivot\_value\_field\_settings [Заголовок раздела «pivot\_value\_field\_settings»](#pivot_value_field_settings) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | --------------------------------------------------------------------------------------------------------- | ----- | | operation | `"pivot_value_field_settings"` | да | | `subsetId` | string | да | | `requestId` | string | да | | intent | [ContractPivotValueFieldSettingsAction](/reference/f1/types-pivot/#contractpivotvaluefieldsettingsaction) | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · pivot\_value\_field\_settings** | Поле | Тип TypeScript | Обяз. | | --------------------- | -------------------------------------------------------------------------------------------------------- | ----- | | operation | `"pivot_value_field_settings"` | да | | `subsetId` | string | да | | `requestId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | action | string | да | | status | string | да | | `didChange` | boolean | да | | `valueFields` | [ContractPivotValueFieldSettingsView](/reference/f1/types-pivot/#contractpivotvaluefieldsettingsview)\[] | да | | `refreshedPivotNames` | string\[] | да | | `dirtyCellCount` | number | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pivot_value_field_settings",
  "subsetId": "<subsetId>",
  "requestId": "<string>",
  "intent": "<ContractPivotValueFieldSettingsAction>",
  "requestedBackend": "native-desktop"
}
```

# Power Query: коннекторы

> Подключение к Postgres, SQL Server, OData и веб-источникам: проверка связи, предпросмотр, навигация по объектам. Операций на странице: 13.

Подключение к Postgres, SQL Server, OData и веб-источникам: проверка связи, предпросмотр, навигация по объектам. Термины — в [глоссарии](/start/glossary/). **Операции на этой странице — 13** * [`evaluate_power_query_odata_feed_transform`](#evaluate_power_query_odata_feed_transform) * [`evaluate_power_query_postgres_transform`](#evaluate_power_query_postgres_transform) * [`evaluate_power_query_sqlserver_transform`](#evaluate_power_query_sqlserver_transform) * [`evaluate_power_query_transform`](#evaluate_power_query_transform) * [`evaluate_power_query_web_connector_transform`](#evaluate_power_query_web_connector_transform) * [`pq_postgres_cancel`](#pq_postgres_cancel) * [`pq_postgres_list_navigation`](#pq_postgres_list_navigation) * [`pq_postgres_preview`](#pq_postgres_preview) * [`pq_postgres_test_connection`](#pq_postgres_test_connection) * [`pq_sqlserver_cancel`](#pq_sqlserver_cancel) * [`pq_sqlserver_list_navigation`](#pq_sqlserver_list_navigation) * [`pq_sqlserver_preview`](#pq_sqlserver_preview) * [`pq_sqlserver_test_connection`](#pq_sqlserver_test_connection) ## evaluate\_power\_query\_odata\_feed\_transform [Заголовок раздела «evaluate\_power\_query\_odata\_feed\_transform»](#evaluate_power_query_odata_feed_transform) Вычисляет/оценивает power query odata feed transform. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ------------------------------------------------------------------------------------------ | ----- | | operation | `"evaluate_power_query_odata_feed_transform"` | да | | `mSource` | string | да | | connector | [ApprovedODataFeedDescriptor](/reference/f1/types-powerquery/#approvedodatafeeddescriptor) | нет | | destination | [PowerQueryLoadDestination](/reference/f1/types-powerquery/#powerqueryloaddestination) | нет | | `refreshQueryId` | string | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · evaluate\_power\_query\_odata\_feed\_transform** | Поле | Тип TypeScript | Обяз. | | ---------- | -------------------------------------------------------------------------------------------------------- | ----- | | operation | `"evaluate_power_query_odata_feed_transform"` | да | | outcome | [ContractPowerQueryTransformOutcome](/reference/f1/types-powerquery/#contractpowerquerytransformoutcome) | да | | `loadPlan` | [PowerQueryLoadPlan](/reference/f1/types-powerquery/#powerqueryloadplan) | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "evaluate_power_query_odata_feed_transform",
  "mSource": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## evaluate\_power\_query\_postgres\_transform [Заголовок раздела «evaluate\_power\_query\_postgres\_transform»](#evaluate_power_query_postgres_transform) Вычисляет/оценивает power query postgres transform. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------------------- | ----- | | operation | `"evaluate_power_query_postgres_transform"` | да | | descriptor | [PqPostgresDialogDescriptor](/reference/f1/types-powerquery/#pqpostgresdialogdescriptor) | нет | | table | [PqPostgresPreviewTableRef](/reference/f1/types-powerquery/#pqpostgrespreviewtableref) | нет | | `mSource` | string | нет | | destination | [PowerQueryLoadDestination](/reference/f1/types-powerquery/#powerqueryloaddestination) | нет | | `refreshQueryId` | string | нет | | `connectUser` | string | нет | | `lanGrants` | [PqPostgresLanGrantWire](/reference/f1/types-powerquery/#pqpostgreslangrantwire)\[] | нет | | privacy | [PqPrivacyEvaluationInput](/reference/f1/types-powerquery/#pqprivacyevaluationinput) | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · evaluate\_power\_query\_postgres\_transform** | Поле | Тип TypeScript | Обяз. | | ---------- | -------------------------------------------------------------------------------------------------------- | ----- | | operation | `"evaluate_power_query_postgres_transform"` | да | | outcome | [ContractPowerQueryTransformOutcome](/reference/f1/types-powerquery/#contractpowerquerytransformoutcome) | да | | `loadPlan` | [PowerQueryLoadPlan](/reference/f1/types-powerquery/#powerqueryloadplan) | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "evaluate_power_query_postgres_transform",
  "requestedBackend": "native-desktop"
}
```
 ## evaluate\_power\_query\_sqlserver\_transform [Заголовок раздела «evaluate\_power\_query\_sqlserver\_transform»](#evaluate_power_query_sqlserver_transform) Вычисляет/оценивает power query sqlserver transform. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | -------------------------------------------------------------------------------------- | ----- | | operation | `"evaluate_power_query_sqlserver_transform"` | да | | descriptor | [PqSqlServerDescriptor](/reference/f1/types-powerquery/#pqsqlserverdescriptor) | нет | | table | [PqSqlServerTableRef](/reference/f1/types-powerquery/#pqsqlservertableref) | нет | | destination | [PowerQueryLoadDestination](/reference/f1/types-powerquery/#powerqueryloaddestination) | нет | | `refreshQueryId` | string | нет | | privacy | [PqPrivacyEvaluationInput](/reference/f1/types-powerquery/#pqprivacyevaluationinput) | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · evaluate\_power\_query\_sqlserver\_transform** | Поле | Тип TypeScript | Обяз. | | ---------- | -------------------------------------------------------------------------------------------------------- | ----- | | operation | `"evaluate_power_query_sqlserver_transform"` | да | | outcome | [ContractPowerQueryTransformOutcome](/reference/f1/types-powerquery/#contractpowerquerytransformoutcome) | да | | `loadPlan` | [PowerQueryLoadPlan](/reference/f1/types-powerquery/#powerqueryloadplan) | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "evaluate_power_query_sqlserver_transform",
  "requestedBackend": "native-desktop"
}
```
 ## evaluate\_power\_query\_transform [Заголовок раздела «evaluate\_power\_query\_transform»](#evaluate_power_query_transform) Вычисляет/оценивает power query transform. **Запрос** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | ------------------------ | -------------------------------------------------------------------------------------------------------- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | operation | `"evaluate_power_query_transform"` | да | | | `mSource` | string | да | | | `sourceId` | string | да | | | `sourceUri` | string | нет | | | `sourceKind` | `"csv"` \| “workbook” \| “folder” \| “json” \| “xml” | нет | Для `csv` и `workbook` — справочное значение, оно и так выводится из запроса. Для `folder` — значащее: именно оно направляет обработку по пути объединения файлов папки, а не одиночного файла. | | `previewStep` | number | нет | Intermediate-step preview (same semantics as every other Power Query source). | | destination | [PowerQueryLoadDestination](/reference/f1/types-powerquery/#powerqueryloaddestination) | нет | Необязательное место загрузки результата. Без поля — просмотр без изменений и без плана. С полем — тоже просмотр, но в ответе приходит проверенный план загрузки в `loadPlan`; сама загрузка не выполняется. | | `includeDependencyGraph` | boolean | нет | | | `paramOptions` | [ContractPersistedParamOptionsBinding](/reference/f1/types-common/#contractpersistedparamoptionsbinding) | нет | | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | | **Ответ при успехе · evaluate\_power\_query\_transform** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | ----------------- | -------------------------------------------------------------------------------------------------------- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | operation | `"evaluate_power_query_transform"` | да | | | outcome | [ContractPowerQueryTransformOutcome](/reference/f1/types-powerquery/#contractpowerquerytransformoutcome) | да | | | `loadPlan` | [PowerQueryLoadPlan](/reference/f1/types-powerquery/#powerqueryloadplan) | нет | Есть в ответе, только если запрос содержал место загрузки и вычисление прошло. При обычном просмотре и при отказе поля нет. Данные при этом никуда не записываются. | | recomputed | boolean | нет | | | `dependencyGraph` | [ContractDependencyGraphSnapshot](/reference/f1/types-formulas/#contractdependencygraphsnapshot) \| null | нет | | **Минимальный JSON-шаблон** 
```json
{
  "operation": "evaluate_power_query_transform",
  "mSource": "<string>",
  "sourceId": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## evaluate\_power\_query\_web\_connector\_transform [Заголовок раздела «evaluate\_power\_query\_web\_connector\_transform»](#evaluate_power_query_web_connector_transform) Вычисляет/оценивает power query web connector transform. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ------------------------------------------------------------------------------------------------ | ----- | | operation | `"evaluate_power_query_web_connector_transform"` | да | | `mSource` | string | да | | connector | [ApprovedWebConnectorDescriptor](/reference/f1/types-powerquery/#approvedwebconnectordescriptor) | нет | | destination | [PowerQueryLoadDestination](/reference/f1/types-powerquery/#powerqueryloaddestination) | нет | | `refreshQueryId` | string | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · evaluate\_power\_query\_web\_connector\_transform** | Поле | Тип TypeScript | Обяз. | | ---------- | -------------------------------------------------------------------------------------------------------- | ----- | | operation | `"evaluate_power_query_web_connector_transform"` | да | | outcome | [ContractPowerQueryTransformOutcome](/reference/f1/types-powerquery/#contractpowerquerytransformoutcome) | да | | `loadPlan` | [PowerQueryLoadPlan](/reference/f1/types-powerquery/#powerqueryloadplan) | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "evaluate_power_query_web_connector_transform",
  "mSource": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## pq\_postgres\_cancel [Заголовок раздела «pq\_postgres\_cancel»](#pq_postgres_cancel) **Запрос** | Поле | Тип TypeScript | Обяз. | | ---------- | ---------------------------------------------------------------------------------------- | ----- | | operation | `"pq_postgres_cancel"` | да | | descriptor | [PqPostgresDialogDescriptor](/reference/f1/types-powerquery/#pqpostgresdialogdescriptor) | нет | **Ответ при успехе · pq\_postgres\_cancel** | Поле | Тип TypeScript | Обяз. | | ------------ | ---------------------- | ----- | | operation | `"pq_postgres_cancel"` | да | | acknowledged | boolean | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pq_postgres_cancel",
  "requestedBackend": "native-desktop"
}
```
 ## pq\_postgres\_list\_navigation [Заголовок раздела «pq\_postgres\_list\_navigation»](#pq_postgres_list_navigation) **Запрос** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | ------------- | ---------------------------------------------------------------------------------------- | ----- | ---------------------------------------------------------------------------------------- | | operation | `"pq_postgres_list_navigation"` | да | | | descriptor | [PqPostgresDialogDescriptor](/reference/f1/types-powerquery/#pqpostgresdialogdescriptor) | да | | | schema | string | нет | Без поля возвращаются корневые схемы; с полем — таблицы и представления указанной схемы. | | `connectUser` | string | нет | | | `lanGrants` | [PqPostgresLanGrantWire](/reference/f1/types-powerquery/#pqpostgreslangrantwire)\[] | нет | | | privacy | [PqPrivacyEvaluationInput](/reference/f1/types-powerquery/#pqprivacyevaluationinput) | нет | | **Ответ при успехе · pq\_postgres\_list\_navigation** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | --------- | --------------------------------------------------------------------------------------------------- | ----- | ------------------------------------------- | | operation | `"pq_postgres_list_navigation"` | да | | | schemas | [PqPostgresNavigationSchemaWire](/reference/f1/types-powerquery/#pqpostgresnavigationschemawire)\[] | нет | Есть в ответе на запрос корневых схем. | | tables | [PqPostgresNavTableWire](/reference/f1/types-powerquery/#pqpostgresnavtablewire)\[] | нет | Есть в ответе на запрос таблиц одной схемы. | | denied | [PqPostgresDeniedWire](/reference/f1/types-powerquery/#pqpostgresdeniedwire) | нет | | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pq_postgres_list_navigation",
  "descriptor": "<PqPostgresDialogDescriptor>",
  "requestedBackend": "native-desktop"
}
```
 ## pq\_postgres\_preview [Заголовок раздела «pq\_postgres\_preview»](#pq_postgres_preview) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------- | ---------------------------------------------------------------------------------------- | ----- | | operation | `"pq_postgres_preview"` | да | | descriptor | [PqPostgresDialogDescriptor](/reference/f1/types-powerquery/#pqpostgresdialogdescriptor) | да | | table | [PqPostgresPreviewTableRef](/reference/f1/types-powerquery/#pqpostgrespreviewtableref) | да | | `maxRows` | number | нет | | `connectUser` | string | нет | | `lanGrants` | [PqPostgresLanGrantWire](/reference/f1/types-powerquery/#pqpostgreslangrantwire)\[] | нет | | privacy | [PqPrivacyEvaluationInput](/reference/f1/types-powerquery/#pqprivacyevaluationinput) | нет | **Ответ при успехе · pq\_postgres\_preview** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | --------- | ---------------------------------------------------------------------------- | ----- | -------------------------------------------------------------------------------------- | | operation | `"pq_postgres_preview"` | да | | | columns | string\[] | нет | | | rows | string\[]\[] | нет | Display-projected rows (each cell a string); bounded ≤ min(maxRows, descriptor bound). | | truncated | boolean | да | | | denied | [PqPostgresDeniedWire](/reference/f1/types-powerquery/#pqpostgresdeniedwire) | нет | | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pq_postgres_preview",
  "descriptor": "<PqPostgresDialogDescriptor>",
  "table": "<PqPostgresPreviewTableRef>",
  "requestedBackend": "native-desktop"
}
```
 ## pq\_postgres\_test\_connection [Заголовок раздела «pq\_postgres\_test\_connection»](#pq_postgres_test_connection) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------- | ---------------------------------------------------------------------------------------- | ----- | | operation | `"pq_postgres_test_connection"` | да | | descriptor | [PqPostgresDialogDescriptor](/reference/f1/types-powerquery/#pqpostgresdialogdescriptor) | да | | `connectUser` | string | нет | | `lanGrants` | [PqPostgresLanGrantWire](/reference/f1/types-powerquery/#pqpostgreslangrantwire)\[] | нет | | privacy | [PqPrivacyEvaluationInput](/reference/f1/types-powerquery/#pqprivacyevaluationinput) | нет | **Ответ при успехе · pq\_postgres\_test\_connection** | Поле | Тип TypeScript | Обяз. | | --------------- | ---------------------------------------------------------------------------- | ----- | | operation | `"pq_postgres_test_connection"` | да | | `serverVersion` | string | нет | | denied | [PqPostgresDeniedWire](/reference/f1/types-powerquery/#pqpostgresdeniedwire) | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pq_postgres_test_connection",
  "descriptor": "<PqPostgresDialogDescriptor>",
  "requestedBackend": "native-desktop"
}
```
 ## pq\_sqlserver\_cancel [Заголовок раздела «pq\_sqlserver\_cancel»](#pq_sqlserver_cancel) **Запрос** | Поле | Тип TypeScript | Обяз. | | --------- | ----------------------- | ----- | | operation | `"pq_sqlserver_cancel"` | да | **Ответ при успехе · pq\_sqlserver\_cancel** | Поле | Тип TypeScript | Обяз. | | ------------ | ----------------------- | ----- | | operation | `"pq_sqlserver_cancel"` | да | | acknowledged | boolean | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pq_sqlserver_cancel",
  "requestedBackend": "native-desktop"
}
```
 ## pq\_sqlserver\_list\_navigation [Заголовок раздела «pq\_sqlserver\_list\_navigation»](#pq_sqlserver_list_navigation) **Запрос** | Поле | Тип TypeScript | Обяз. | | ---------- | ------------------------------------------------------------------------------------ | ----- | | operation | `"pq_sqlserver_list_navigation"` | да | | descriptor | [PqSqlServerDescriptor](/reference/f1/types-powerquery/#pqsqlserverdescriptor) | да | | privacy | [PqPrivacyEvaluationInput](/reference/f1/types-powerquery/#pqprivacyevaluationinput) | нет | **Ответ при успехе · pq\_sqlserver\_list\_navigation** | Поле | Тип TypeScript | Обяз. | | --------- | ------------------------------------------------------------------------------------------------- | ----- | | operation | `"pq_sqlserver_list_navigation"` | да | | items | [PqSqlServerNavigationItemWire](/reference/f1/types-powerquery/#pqsqlservernavigationitemwire)\[] | нет | | denied | [PqSqlServerDeniedWire](/reference/f1/types-powerquery/#pqsqlserverdeniedwire) | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pq_sqlserver_list_navigation",
  "descriptor": "<PqSqlServerDescriptor>",
  "requestedBackend": "native-desktop"
}
```
 ## pq\_sqlserver\_preview [Заголовок раздела «pq\_sqlserver\_preview»](#pq_sqlserver_preview) **Запрос** | Поле | Тип TypeScript | Обяз. | | ---------- | ------------------------------------------------------------------------------------ | ----- | | operation | `"pq_sqlserver_preview"` | да | | descriptor | [PqSqlServerDescriptor](/reference/f1/types-powerquery/#pqsqlserverdescriptor) | да | | table | [PqSqlServerTableRef](/reference/f1/types-powerquery/#pqsqlservertableref) | да | | `maxRows` | number | нет | | privacy | [PqPrivacyEvaluationInput](/reference/f1/types-powerquery/#pqprivacyevaluationinput) | нет | **Ответ при успехе · pq\_sqlserver\_preview** | Поле | Тип TypeScript | Обяз. | | --------- | ------------------------------------------------------------------------------ | ----- | | operation | `"pq_sqlserver_preview"` | да | | columns | string\[] | нет | | rows | string\[]\[] | нет | | truncated | boolean | да | | denied | [PqSqlServerDeniedWire](/reference/f1/types-powerquery/#pqsqlserverdeniedwire) | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pq_sqlserver_preview",
  "descriptor": "<PqSqlServerDescriptor>",
  "table": "<PqSqlServerTableRef>",
  "requestedBackend": "native-desktop"
}
```
 ## pq\_sqlserver\_test\_connection [Заголовок раздела «pq\_sqlserver\_test\_connection»](#pq_sqlserver_test_connection) **Запрос** | Поле | Тип TypeScript | Обяз. | | ---------- | ------------------------------------------------------------------------------------ | ----- | | operation | `"pq_sqlserver_test_connection"` | да | | descriptor | [PqSqlServerDescriptor](/reference/f1/types-powerquery/#pqsqlserverdescriptor) | да | | privacy | [PqPrivacyEvaluationInput](/reference/f1/types-powerquery/#pqprivacyevaluationinput) | нет | **Ответ при успехе · pq\_sqlserver\_test\_connection** | Поле | Тип TypeScript | Обяз. | | --------------- | ------------------------------------------------------------------------------ | ----- | | operation | `"pq_sqlserver_test_connection"` | да | | `serverVersion` | string | нет | | denied | [PqSqlServerDeniedWire](/reference/f1/types-powerquery/#pqsqlserverdeniedwire) | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pq_sqlserver_test_connection",
  "descriptor": "<PqSqlServerDescriptor>",
  "requestedBackend": "native-desktop"
}
```

# Power Query: выполнение и прогресс

> Граф запроса, обновление, отмена и наблюдение за долгими операциями. Операций на странице: 9.

Граф запроса, обновление, отмена и наблюдение за долгими операциями. Термины — в [глоссарии](/start/glossary/). **Операции на этой странице — 9** * [`pq-query-graph-cancel`](#pq-query-graph-cancel) * [`pq-query-graph-explain`](#pq-query-graph-explain) * [`pq-query-graph-refresh`](#pq-query-graph-refresh) * [`pq-query-graph-snapshot`](#pq-query-graph-snapshot) * [`pq-scale-progress-cancel`](#pq-scale-progress-cancel) * [`pq-scale-progress-close`](#pq-scale-progress-close) * [`pq-scale-progress-open`](#pq-scale-progress-open) * [`pq-scale-progress-pull`](#pq-scale-progress-pull) * [`pq-scale-progress-snapshot`](#pq-scale-progress-snapshot) ## pq-query-graph-cancel [Заголовок раздела «pq-query-graph-cancel»](#pq-query-graph-cancel) **Запрос** | Поле | Тип TypeScript | Обяз. | | ----------- | ------------------------- | ----- | | operation | `"pq-query-graph-cancel"` | да | | generation | number | да | | `subset_id` | string | нет | **Ответ при успехе · pq-query-graph-cancel** | Поле | Тип TypeScript | Обяз. | | --------- | ---------------------------------------------------------------------------------------- | ----- | | operation | `"pq-query-graph-cancel"` | да | | outcome | [PqQueryGraphRefreshOutcome](/reference/f1/types-powerquery/#pqquerygraphrefreshoutcome) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pq-query-graph-cancel",
  "generation": 0,
  "requestedBackend": "native-desktop"
}
```
 ## pq-query-graph-explain [Заголовок раздела «pq-query-graph-explain»](#pq-query-graph-explain) **Запрос** | Поле | Тип TypeScript | Обяз. | | ----------------- | -------------------------- | ----- | | operation | `"pq-query-graph-explain"` | да | | `query_stable_id` | string | да | | `subset_id` | string | нет | **Ответ при успехе · pq-query-graph-explain** | Поле | Тип TypeScript | Обяз. | | --------- | -------------------------------------------------------------------------- | ----- | | operation | `"pq-query-graph-explain"` | да | | explain | [PqQueryGraphExplain](/reference/f1/types-powerquery/#pqquerygraphexplain) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pq-query-graph-explain",
  "query_stable_id": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## pq-query-graph-refresh [Заголовок раздела «pq-query-graph-refresh»](#pq-query-graph-refresh) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------- | ---------------------------------------------------------------- | ----- | | operation | `"pq-query-graph-refresh"` | да | | scope | `"current"` \| “all” \| string | да | | `query_stable_id` | string | нет | | `subset_id` | string | нет | | `user_store_levels` | { canonicalScope: string; level: string; invalid?: boolean; }\[] | нет | **Ответ при успехе · pq-query-graph-refresh** | Поле | Тип TypeScript | Обяз. | | ------------ | --------------------------------------------------------------------------------------------- | ----- | | operation | `"pq-query-graph-refresh"` | да | | outcome | [PqQueryGraphRefreshOutcome](/reference/f1/types-powerquery/#pqquerygraphrefreshoutcome) | да | | committed | boolean | да | | publications | [PqQueryGraphNodePublication](/reference/f1/types-powerquery/#pqquerygraphnodepublication)\[] | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pq-query-graph-refresh",
  "scope": "current",
  "requestedBackend": "native-desktop"
}
```
 ## pq-query-graph-snapshot [Заголовок раздела «pq-query-graph-snapshot»](#pq-query-graph-snapshot) **Запрос** | Поле | Тип TypeScript | Обяз. | | ----------- | --------------------------- | ----- | | operation | `"pq-query-graph-snapshot"` | да | | `subset_id` | string | нет | **Ответ при успехе · pq-query-graph-snapshot** | Поле | Тип TypeScript | Обяз. | | --------- | ---------------------------------------------------------------------------- | ----- | | operation | `"pq-query-graph-snapshot"` | да | | snapshot | [PqQueryGraphSnapshot](/reference/f1/types-powerquery/#pqquerygraphsnapshot) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pq-query-graph-snapshot",
  "requestedBackend": "native-desktop"
}
```
 ## pq-scale-progress-cancel [Заголовок раздела «pq-scale-progress-cancel»](#pq-scale-progress-cancel) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------ | ---------------------------- | ----- | | operation | `"pq-scale-progress-cancel"` | да | | `session_id` | string | да | **Ответ при успехе · pq-scale-progress-cancel** | Поле | Тип TypeScript | Обяз. | | --------- | -------------------------------------------------------------------------------------------- | ----- | | operation | `"pq-scale-progress-cancel"` | да | | outcome | [PqScaleProgressCancelPayload](/reference/f1/types-powerquery/#pqscaleprogresscancelpayload) | нет | | denied | [PqScaleDenied](/reference/f1/types-powerquery/#pqscaledenied) | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pq-scale-progress-cancel",
  "session_id": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## pq-scale-progress-close [Заголовок раздела «pq-scale-progress-close»](#pq-scale-progress-close) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------ | --------------------------- | ----- | | operation | `"pq-scale-progress-close"` | да | | `session_id` | string | да | **Ответ при успехе · pq-scale-progress-close** | Поле | Тип TypeScript | Обяз. | | --------- | --------------------------- | ----- | | operation | `"pq-scale-progress-close"` | да | | closed | boolean | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pq-scale-progress-close",
  "session_id": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## pq-scale-progress-open [Заголовок раздела «pq-scale-progress-open»](#pq-scale-progress-open) **Запрос** | Поле | Тип TypeScript | Обяз. | | ---------------- | -------------------------- | ----- | | operation | `"pq-scale-progress-open"` | да | | `rows_requested` | number | нет | | `max_batch_rows` | number | нет | **Ответ при успехе · pq-scale-progress-open** | Поле | Тип TypeScript | Обяз. | | --------- | ---------------------------------------------------------------------------------------- | ----- | | operation | `"pq-scale-progress-open"` | да | | session | [PqScaleProgressOpenPayload](/reference/f1/types-powerquery/#pqscaleprogressopenpayload) | да | | denied | [PqScaleDenied](/reference/f1/types-powerquery/#pqscaledenied) | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pq-scale-progress-open",
  "requestedBackend": "native-desktop"
}
```
 ## pq-scale-progress-pull [Заголовок раздела «pq-scale-progress-pull»](#pq-scale-progress-pull) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------ | -------------------------- | ----- | | operation | `"pq-scale-progress-pull"` | да | | `session_id` | string | да | **Ответ при успехе · pq-scale-progress-pull** | Поле | Тип TypeScript | Обяз. | | --------- | ---------------------------------------------------------------------------------------- | ----- | | operation | `"pq-scale-progress-pull"` | да | | progress | [PqScaleProgressPullPayload](/reference/f1/types-powerquery/#pqscaleprogresspullpayload) | нет | | denied | [PqScaleDenied](/reference/f1/types-powerquery/#pqscaledenied) | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pq-scale-progress-pull",
  "session_id": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## pq-scale-progress-snapshot [Заголовок раздела «pq-scale-progress-snapshot»](#pq-scale-progress-snapshot) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------ | ------------------------------ | ----- | | operation | `"pq-scale-progress-snapshot"` | да | | `session_id` | string | да | **Ответ при успехе · pq-scale-progress-snapshot** | Поле | Тип TypeScript | Обяз. | | --------- | ------------------------------------------------------------------------------------------------ | ----- | | operation | `"pq-scale-progress-snapshot"` | да | | snapshot | [PqScaleProgressSnapshotPayload](/reference/f1/types-powerquery/#pqscaleprogresssnapshotpayload) | нет | | denied | [PqScaleDenied](/reference/f1/types-powerquery/#pqscaledenied) | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pq-scale-progress-snapshot",
  "session_id": "<string>",
  "requestedBackend": "native-desktop"
}
```

# Power Query: выражения M

> Вычисление и разбор M-выражений, в том числе с внешними источниками. Операций на странице: 9.

Вычисление и разбор M-выражений, в том числе с внешними источниками. Термины — в [глоссарии](/start/glossary/). **Операции на этой странице — 9** * [`evaluate_m_expression`](#evaluate_m_expression) * [`evaluate_m_expression_with_odata_feed`](#evaluate_m_expression_with_odata_feed) * [`evaluate_m_expression_with_sources`](#evaluate_m_expression_with_sources) * [`evaluate_m_expression_with_web_connector`](#evaluate_m_expression_with_web_connector) * [`evaluate_m_expression_with_web_source`](#evaluate_m_expression_with_web_source) * [`inspect_m_expression`](#inspect_m_expression) * [`inspect_m_expression_with_odata_feed`](#inspect_m_expression_with_odata_feed) * [`inspect_m_expression_with_postgres`](#inspect_m_expression_with_postgres) * [`inspect_m_expression_with_sources`](#inspect_m_expression_with_sources) ## evaluate\_m\_expression [Заголовок раздела «evaluate\_m\_expression»](#evaluate_m_expression) Вычисляет/оценивает m expression. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"evaluate_m_expression"` | да | | `mText` | string | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · evaluate\_m\_expression** | Поле | Тип TypeScript | Обяз. | | --------- | -------------------------------------------------------------------- | ----- | | operation | `"evaluate_m_expression"` | да | | outcome | [MExpressionOutcome](/reference/f1/types-common/#mexpressionoutcome) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "evaluate_m_expression",
  "mText": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## evaluate\_m\_expression\_with\_odata\_feed [Заголовок раздела «evaluate\_m\_expression\_with\_odata\_feed»](#evaluate_m_expression_with_odata_feed) Вычисляет/оценивает m expression with odata feed. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ------------------------------------------------------------------------------------------ | ----- | | operation | `"evaluate_m_expression_with_odata_feed"` | да | | `mText` | string | да | | connector | [ApprovedODataFeedDescriptor](/reference/f1/types-powerquery/#approvedodatafeeddescriptor) | нет | | privacy | [PqPrivacyEvaluationInput](/reference/f1/types-powerquery/#pqprivacyevaluationinput) | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · evaluate\_m\_expression\_with\_odata\_feed** | Поле | Тип TypeScript | Обяз. | | --------- | -------------------------------------------------------------------- | ----- | | operation | `"evaluate_m_expression_with_odata_feed"` | да | | outcome | [MExpressionOutcome](/reference/f1/types-common/#mexpressionoutcome) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "evaluate_m_expression_with_odata_feed",
  "mText": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## evaluate\_m\_expression\_with\_sources [Заголовок раздела «evaluate\_m\_expression\_with\_sources»](#evaluate_m_expression_with_sources) Вычисляет/оценивает m expression with sources. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | --------------------------------------------------------------------------------------- | ----- | | operation | `"evaluate_m_expression_with_sources"` | да | | `mText` | string | да | | sources | [ApprovedSourceDescriptor](/reference/f1/types-powerquery/#approvedsourcedescriptor)\[] | да | | privacy | [PqPrivacyEvaluationInput](/reference/f1/types-powerquery/#pqprivacyevaluationinput) | нет | | `foldMode` | `"folding-on"` \| “force-local” | нет | | `userStoreLevels` | [PqPrivacyLevelAssignment](/reference/f1/types-powerquery/#pqprivacylevelassignment)\[] | нет | | `subsetId` | string | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · evaluate\_m\_expression\_with\_sources** | Поле | Тип TypeScript | Обяз. | | --------- | -------------------------------------------------------------------- | ----- | | operation | `"evaluate_m_expression_with_sources"` | да | | outcome | [MExpressionOutcome](/reference/f1/types-common/#mexpressionoutcome) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "evaluate_m_expression_with_sources",
  "mText": "<string>",
  "sources": [],
  "requestedBackend": "native-desktop"
}
```
 ## evaluate\_m\_expression\_with\_web\_connector [Заголовок раздела «evaluate\_m\_expression\_with\_web\_connector»](#evaluate_m_expression_with_web_connector) Вычисляет/оценивает m expression with web connector. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ------------------------------------------------------------------------------------------------ | ----- | | operation | `"evaluate_m_expression_with_web_connector"` | да | | `mText` | string | да | | connector | [ApprovedWebConnectorDescriptor](/reference/f1/types-powerquery/#approvedwebconnectordescriptor) | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · evaluate\_m\_expression\_with\_web\_connector** | Поле | Тип TypeScript | Обяз. | | --------- | -------------------------------------------------------------------- | ----- | | operation | `"evaluate_m_expression_with_web_connector"` | да | | outcome | [MExpressionOutcome](/reference/f1/types-common/#mexpressionoutcome) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "evaluate_m_expression_with_web_connector",
  "mText": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## evaluate\_m\_expression\_with\_web\_source [Заголовок раздела «evaluate\_m\_expression\_with\_web\_source»](#evaluate_m_expression_with_web_source) Вычисляет/оценивает m expression with web source. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ------------------------------------------------------------------------------------------ | ----- | | operation | `"evaluate_m_expression_with_web_source"` | да | | `mText` | string | да | | source | [ApprovedWebSourceDescriptor](/reference/f1/types-powerquery/#approvedwebsourcedescriptor) | нет | | privacy | [PqPrivacyEvaluationInput](/reference/f1/types-powerquery/#pqprivacyevaluationinput) | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · evaluate\_m\_expression\_with\_web\_source** | Поле | Тип TypeScript | Обяз. | | --------- | -------------------------------------------------------------------- | ----- | | operation | `"evaluate_m_expression_with_web_source"` | да | | outcome | [MExpressionOutcome](/reference/f1/types-common/#mexpressionoutcome) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "evaluate_m_expression_with_web_source",
  "mText": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## inspect\_m\_expression [Заголовок раздела «inspect\_m\_expression»](#inspect_m_expression) Инспектирует m expression. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"inspect_m_expression"` | да | | `mText` | string | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · inspect\_m\_expression** | Поле | Тип TypeScript | Обяз. | | --------- | ------------------------------------------------------------------------------------------ | ----- | | operation | `"inspect_m_expression"` | да | | snapshot | [PowerQueryInspectorSnapshot](/reference/f1/types-powerquery/#powerqueryinspectorsnapshot) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "inspect_m_expression",
  "mText": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## inspect\_m\_expression\_with\_odata\_feed [Заголовок раздела «inspect\_m\_expression\_with\_odata\_feed»](#inspect_m_expression_with_odata_feed) Инспектирует m expression with odata feed. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ------------------------------------------------------------------------------------------ | ----- | | operation | `"inspect_m_expression_with_odata_feed"` | да | | `mText` | string | да | | connector | [ApprovedODataFeedDescriptor](/reference/f1/types-powerquery/#approvedodatafeeddescriptor) | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · inspect\_m\_expression\_with\_odata\_feed** | Поле | Тип TypeScript | Обяз. | | --------- | ------------------------------------------------------------------------------------------ | ----- | | operation | `"inspect_m_expression_with_odata_feed"` | да | | snapshot | [PowerQueryInspectorSnapshot](/reference/f1/types-powerquery/#powerqueryinspectorsnapshot) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "inspect_m_expression_with_odata_feed",
  "mText": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## inspect\_m\_expression\_with\_postgres [Заголовок раздела «inspect\_m\_expression\_with\_postgres»](#inspect_m_expression_with_postgres) Инспектирует m expression with postgres. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------------------- | ----- | | operation | `"inspect_m_expression_with_postgres"` | да | | `mText` | string | да | | descriptor | [PqPostgresDialogDescriptor](/reference/f1/types-powerquery/#pqpostgresdialogdescriptor) | нет | | schema | string | нет | | item | string | нет | | `connectUser` | string | нет | | `lanGrants` | [PqPostgresLanGrantWire](/reference/f1/types-powerquery/#pqpostgreslangrantwire)\[] | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · inspect\_m\_expression\_with\_postgres** | Поле | Тип TypeScript | Обяз. | | --------- | ------------------------------------------------------------------------------------------ | ----- | | operation | `"inspect_m_expression_with_postgres"` | да | | snapshot | [PowerQueryInspectorSnapshot](/reference/f1/types-powerquery/#powerqueryinspectorsnapshot) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "inspect_m_expression_with_postgres",
  "mText": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## inspect\_m\_expression\_with\_sources [Заголовок раздела «inspect\_m\_expression\_with\_sources»](#inspect_m_expression_with_sources) Инспектирует m expression with sources. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | --------------------------------------------------------------------------------------- | ----- | | operation | `"inspect_m_expression_with_sources"` | да | | `mText` | string | да | | sources | [ApprovedSourceDescriptor](/reference/f1/types-powerquery/#approvedsourcedescriptor)\[] | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · inspect\_m\_expression\_with\_sources** | Поле | Тип TypeScript | Обяз. | | --------- | ------------------------------------------------------------------------------------------ | ----- | | operation | `"inspect_m_expression_with_sources"` | да | | snapshot | [PowerQueryInspectorSnapshot](/reference/f1/types-powerquery/#powerqueryinspectorsnapshot) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "inspect_m_expression_with_sources",
  "mText": "<string>",
  "sources": [],
  "requestedBackend": "native-desktop"
}
```

# Power Query: внешние mashup

> Чтение, запись и обновление наборов запросов Power Query, собранных вне продукта. Операций на странице: 3.

Чтение, запись и обновление наборов запросов Power Query, собранных вне продукта. Термины — в [глоссарии](/start/glossary/). **Операции на этой странице — 3** * [`read_foreign_mashup`](#read_foreign_mashup) * [`refresh_foreign_mashup_query`](#refresh_foreign_mashup_query) * [`write_foreign_mashup`](#write_foreign_mashup) ## read\_foreign\_mashup [Заголовок раздела «read\_foreign\_mashup»](#read_foreign_mashup) **Запрос** | Поле | Тип TypeScript | Обяз. | | ---------- | ----------------------- | ----- | | operation | “read\_foreign\_mashup” | да | | `subsetId` | string | да | **Ответ при успехе · read\_foreign\_mashup** | Поле | Тип TypeScript | Обяз. | | ---------- | -------------------------------------------------------------------------------------------------- | ----- | | operation | “read\_foreign\_mashup” | да | | projection | [ContractForeignMashupProjection](/reference/f1/types-powerquery/#contractforeignmashupprojection) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "read_foreign_mashup",
  "subsetId": "<subsetId>"
}
```
 ## refresh\_foreign\_mashup\_query [Заголовок раздела «refresh\_foreign\_mashup\_query»](#refresh_foreign_mashup_query) В опубликованный выпуск пока не вошла Операция описана контрактом, но ядро последнего выпуска её не принимает: на такой запрос придёт отказ с перечнем известных ему операций. Что входит в выпуск, а что пока только в контракт — в [обзоре справочника](/reference/f1/overview/). **Запрос** | Поле | Тип TypeScript | Обяз. | Что это | | ------------------ | --------------------------------- | ----- | ------------------------------------------------------------------------------------------------ | | operation | “refresh\_foreign\_mashup\_query” | да | | | `expectedRevision` | number | да | | | `subsetId` | string | да | | | `queryIdentity` | string | да | | | generation | number | да | Поколение вызывающего, возвращается неизменным: устаревший ответ отбрасывается детерминированно. | | cancel | boolean | нет | Отмена двигает только заграждение поколения — ничего не вычисляет и не меняет. | **Ответ при успехе · refresh\_foreign\_mashup\_query** | Поле | Тип TypeScript | Обяз. | | --------- | -------------------------------------------------------------------------------------------------------- | ----- | | operation | “refresh\_foreign\_mashup\_query” | да | | outcome | [ContractForeignMashupRefreshResult](/reference/f1/types-powerquery/#contractforeignmashuprefreshresult) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "refresh_foreign_mashup_query",
  "expectedRevision": 0,
  "subsetId": "<subsetId>",
  "queryIdentity": "<queryIdentity>",
  "generation": 0
}
```
 ## write\_foreign\_mashup [Заголовок раздела «write\_foreign\_mashup»](#write_foreign_mashup) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ------------------------------------------------------------------------------------- | ----- | | operation | “write\_foreign\_mashup” | да | | `expectedRevision` | number | да | | `subsetId` | string | да | | `readOnly` | boolean | нет | | edits | [ContractMashupWriteEdit](/reference/f1/types-powerquery/#contractmashupwriteedit)\[] | да | **Ответ при успехе · write\_foreign\_mashup** | Поле | Тип TypeScript | Обяз. | | --------- | -------------------------------------------------------------------------------------- | ----- | | operation | “write\_foreign\_mashup” | да | | outcome | [ContractMashupWriteResult](/reference/f1/types-powerquery/#contractmashupwriteresult) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "write_foreign_mashup",
  "expectedRevision": 0,
  "subsetId": "<subsetId>",
  "edits": []
}
```

# Power Query: запросы и шаги

> Жизненный цикл запросов, применённые шаги, параметры и навигация по папкам. Операций на странице: 13.

Жизненный цикл запросов, применённые шаги, параметры и навигация по папкам. Термины — в [глоссарии](/start/glossary/). **Операции на этой странице — 13** * [`commit_applied_step_edit`](#commit_applied_step_edit) * [`commit_power_query_load`](#commit_power_query_load) * [`delete_power_query`](#delete_power_query) * [`duplicate_power_query`](#duplicate_power_query) * [`list_power_query_definitions`](#list_power_query_definitions) * [`mutate_applied_step`](#mutate_applied_step) * [`power_query_folder_navigator`](#power_query_folder_navigator) * [`power_query_parameter_manager`](#power_query_parameter_manager) * [`profile_applied_step_columns`](#profile_applied_step_columns) * [`project_applied_steps`](#project_applied_steps) * [`reference_power_query`](#reference_power_query) * [`rename_power_query`](#rename_power_query) * [`save_power_query_definition`](#save_power_query_definition) ## commit\_applied\_step\_edit [Заголовок раздела «commit\_applied\_step\_edit»](#commit_applied_step_edit) Фиксирует applied step edit. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"commit_applied_step_edit"` | да | | `mText` | string | да | | `queryStableId` | string | нет | | `stepId` | string | да | | `canonicalM` | string | да | | `editorSessionId` | string | нет | | generation | number | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · commit\_applied\_step\_edit** | Поле | Тип TypeScript | Обяз. | | --------- | -------------------------------------------------------------------- | ----- | | operation | `"commit_applied_step_edit"` | да | | result | [StepMutationResult](/reference/f1/types-common/#stepmutationresult) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "commit_applied_step_edit",
  "mText": "<string>",
  "stepId": "<string>",
  "canonicalM": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## commit\_power\_query\_load [Заголовок раздела «commit\_power\_query\_load»](#commit_power_query_load) Фиксирует power query load. **Запрос** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | ------------------ | ---------------------------------------------------------------------------- | ----- | ----------------------------------------------------------------------------- | | operation | `"commit_power_query_load"` | да | | | `subsetId` | string | да | | | `loadPlan` | [PowerQueryLoadPlan](/reference/f1/types-powerquery/#powerqueryloadplan) | да | | | query | unknown | да | Opaque, secret-free Rust-owned persisted query record returned by evaluation. | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | | **Ответ при успехе · commit\_power\_query\_load** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | ------------------ | -------------------------------------------------------------------------- | ----- | ---------------------------------------------------------------------------------------------------- | | operation | `"commit_power_query_load"` | да | | | `queryId` | string | да | | | `appliedEditCount` | number | да | | | `createdSheet` | boolean | да | | | `sheetKey` | string | нет | | | `staleClearCount` | number | да | | | projection | Extract< ComputeResponsePayload, { operation: `"open_workbook_subset"` } > | да | Состояние книги после применения правки, полученное в том же сеансе внутри одной неделимой операции. | **Минимальный JSON-шаблон** 
```json
{
  "operation": "commit_power_query_load",
  "subsetId": "<subsetId>",
  "loadPlan": "<PowerQueryLoadPlan>",
  "query": "<unknown>",
  "requestedBackend": "native-desktop"
}
```
 ## delete\_power\_query [Заголовок раздела «delete\_power\_query»](#delete_power_query) **Запрос** | Поле | Тип TypeScript | Обяз. | | ---------- | ---------------------- | ----- | | operation | “delete\_power\_query” | да | | `subsetId` | string | да | | `stableId` | string | да | **Ответ при успехе · delete\_power\_query** | Поле | Тип TypeScript | Обяз. | | -------------------- | ---------------------- | ----- | | operation | “delete\_power\_query” | да | | status | string | да | | reason | string | нет | | `removedDisplayName` | string | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "delete_power_query",
  "subsetId": "<subsetId>",
  "stableId": "<stableId>"
}
```
 ## duplicate\_power\_query [Заголовок раздела «duplicate\_power\_query»](#duplicate_power_query) **Запрос** | Поле | Тип TypeScript | Обяз. | | ---------- | ------------------------- | ----- | | operation | “duplicate\_power\_query” | да | | `subsetId` | string | да | | `stableId` | string | да | **Ответ при успехе · duplicate\_power\_query** | Поле | Тип TypeScript | Обяз. | | ---------------- | ------------------------- | ----- | | operation | “duplicate\_power\_query” | да | | status | string | да | | reason | string | нет | | `newStableId` | string | нет | | `newDisplayName` | string | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "duplicate_power_query",
  "subsetId": "<subsetId>",
  "stableId": "<stableId>"
}
```
 ## list\_power\_query\_definitions [Заголовок раздела «list\_power\_query\_definitions»](#list_power_query_definitions) **Запрос** | Поле | Тип TypeScript | Обяз. | | ---------- | --------------------------------- | ----- | | operation | “list\_power\_query\_definitions” | да | | `subsetId` | string | да | **Ответ при успехе · list\_power\_query\_definitions** | Поле | Тип TypeScript | Обяз. | | --------- | --------------------------------- | ----- | | operation | “list\_power\_query\_definitions” | да | | queries | unknown\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "list_power_query_definitions",
  "subsetId": "<subsetId>"
}
```
 ## mutate\_applied\_step [Заголовок раздела «mutate\_applied\_step»](#mutate_applied_step) Изменяет applied step. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"mutate_applied_step"` | да | | `mText` | string | да | | `queryStableId` | string | нет | | mutation | [StepMutation](/reference/f1/types-common/#stepmutation) | да | | `editorSessionId` | string | нет | | generation | number | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · mutate\_applied\_step** | Поле | Тип TypeScript | Обяз. | | --------- | -------------------------------------------------------------------- | ----- | | operation | `"mutate_applied_step"` | да | | result | [StepMutationResult](/reference/f1/types-common/#stepmutationresult) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "mutate_applied_step",
  "mText": "<string>",
  "mutation": "<StepMutation>",
  "requestedBackend": "native-desktop"
}
```
 ## power\_query\_folder\_navigator [Заголовок раздела «power\_query\_folder\_navigator»](#power_query_folder_navigator) **Запрос** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | ------------------ | ---------------------------------------------------------------------------- | ----- | --------------------------------------------------------------------------------------------------------------------------------- | | operation | `"power_query_folder_navigator"` | да | | | action | string | да | “list-entries” \| “preview-entry” \| “preview-combined” \| “refresh” \| “package-ledger” | | `sourceKind` | `"folder"` \| “json” \| “xml” | да | | | `rootUri` | string | да | Адрес папки в том же виде, что и в операции преобразования выше: `file:///путь` с параметрами `include`, `exclude` и `recursive`. | | `entryId` | string | нет | | | `lineageJson` | string | нет | | | `savedDigest` | number | нет | | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | | **Ответ при успехе · power\_query\_folder\_navigator** | Поле | Тип TypeScript | Обяз. | | --------- | ---------------------------------------------------------------------------- | ----- | | operation | `"power_query_folder_navigator"` | да | | outcome | [FolderNavigatorOutcome](/reference/f1/types-common/#foldernavigatoroutcome) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "power_query_folder_navigator",
  "action": "<string>",
  "sourceKind": "folder",
  "rootUri": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## power\_query\_parameter\_manager [Заголовок раздела «power\_query\_parameter\_manager»](#power_query_parameter_manager) **Запрос** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | ------------------ | ---------------------------------------------------------------------------- | ----- | ----------------------------------------------------------------------------------------------------------- | | operation | `"power_query_parameter_manager"` | да | | | `subsetId` | string | да | | | action | string | да | One of “create” \| “edit” \| “rename” \| “duplicate” \| “delete” \| “list” \| “set-value”. | | dto | [ContractParameterDTO](/reference/f1/types-common/#contractparameterdto) | нет | Полный объект: при `create` его идентификатор не учитывается, при `edit` значения полей заменяются целиком. | | id | string | нет | Target parameter’s stable id; required by edit/rename/duplicate/delete/set-value. | | name | string | нет | New display name; required by “rename”. | | value | [ContractParamValueRepr](/reference/f1/types-common/#contractparamvaluerepr) | нет | New current value; required by “set-value”. | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | | **Ответ при успехе · power\_query\_parameter\_manager** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | ----------------- | -------------------------------------------------------------------------------------------------------- | ----- | ------------------------------------------------------------------------------------------------------- | | operation | `"power_query_parameter_manager"` | да | | | status | string | да | | | reason | string \| null | нет | | | parameter | [ContractParameterDTO](/reference/f1/types-common/#contractparameterdto) \| null | нет | Параметр, к которому относилось действие или который оно создало. Нет в ответе при `list` и при отказе. | | parameters | [ContractParameterDTO](/reference/f1/types-common/#contractparameterdto)\[] | да | Every parameter currently registered, in stable creation order. | | recomputed | [ContractRecomputedQueryStatus](/reference/f1/types-powerquery/#contractrecomputedquerystatus)\[] | да | Есть в ответе, только если `edit` или `set-value` действительно изменили значение. | | `dependencyGraph` | [ContractDependencyGraphSnapshot](/reference/f1/types-formulas/#contractdependencygraphsnapshot) \| null | нет | | **Минимальный JSON-шаблон** 
```json
{
  "operation": "power_query_parameter_manager",
  "subsetId": "<subsetId>",
  "action": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## profile\_applied\_step\_columns [Заголовок раздела «profile\_applied\_step\_columns»](#profile_applied_step_columns) Профилирует applied step columns. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"profile_applied_step_columns"` | да | | `mText` | string | да | | `queryStableId` | string | нет | | `stepId` | string | нет | | `editorSessionId` | string | нет | | generation | number | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · profile\_applied\_step\_columns** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | ------------- | ---------------------------------------------------------------------- | ----- | ---------------------------------------------------------------------------------------------------------------------------------------- | | operation | `"profile_applied_step_columns"` | да | | | profiled | boolean | да | `true`, если профиль удалось посчитать; `false`, если вычисление не прошло. | | columns | [ColumnProfile](/reference/f1/types-format/#columnprofile)\[] | да | По одному профилю на каждый столбец результата; пусто, если вычисление не прошло. Значения считает ядро, интерфейс их только показывает. | | `rowCount` | number | да | Настоящее число строк результата, а не размер выборки. | | sampled | boolean | да | `true`, если профиль построен не по всем строкам, а по началу результата: строк оказалось больше предела выборки. | | `sampledRows` | number | да | Сколько строк вошло в профиль: либо все, либо предел выборки — что меньше. | | `sampleCap` | number | да | Предел выборки строк, действовавший при этом проходе. | | block | { sourceId: string; mSource: string; reason: string; detail: string; } | нет | Причина, по которой профиль построить не удалось. Частичного профиля не бывает: либо он есть целиком, либо здесь стоит причина отказа. | | session | [EditorSessionStamp](/reference/f1/types-session/#editorsessionstamp) | нет | Отметка сеанса, возвращаемая в ответах, привязанных к сеансу. В вызовах без сеанса поля нет. | **Минимальный JSON-шаблон** 
```json
{
  "operation": "profile_applied_step_columns",
  "mText": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## project\_applied\_steps [Заголовок раздела «project\_applied\_steps»](#project_applied_steps) Проецирует applied steps. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"project_applied_steps"` | да | | `mText` | string | да | | `queryStableId` | string | нет | | `editorSessionId` | string | нет | | generation | number | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · project\_applied\_steps** | Поле | Тип TypeScript | Обяз. | | ---------- | -------------------------------------------------------------------------------- | ----- | | operation | `"project_applied_steps"` | да | | projection | [AppliedStepsProjection](/reference/f1/types-powerquery/#appliedstepsprojection) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "project_applied_steps",
  "mText": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## reference\_power\_query [Заголовок раздела «reference\_power\_query»](#reference_power_query) **Запрос** | Поле | Тип TypeScript | Обяз. | | ---------- | ------------------------- | ----- | | operation | “reference\_power\_query” | да | | `subsetId` | string | да | | `stableId` | string | да | **Ответ при успехе · reference\_power\_query** | Поле | Тип TypeScript | Обяз. | | ------------------ | ------------------------- | ----- | | operation | “reference\_power\_query” | да | | status | string | да | | reason | string | нет | | `newStableId` | string | нет | | `newDisplayName` | string | нет | | `upstreamStableId` | string | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "reference_power_query",
  "subsetId": "<subsetId>",
  "stableId": "<stableId>"
}
```
 ## rename\_power\_query [Заголовок раздела «rename\_power\_query»](#rename_power_query) **Запрос** | Поле | Тип TypeScript | Обяз. | | ---------------- | ---------------------- | ----- | | operation | “rename\_power\_query” | да | | `subsetId` | string | да | | `stableId` | string | да | | `newDisplayName` | string | да | **Ответ при успехе · rename\_power\_query** | Поле | Тип TypeScript | Обяз. | | --------------------- | ---------------------- | ----- | | operation | “rename\_power\_query” | да | | status | string | да | | reason | string | нет | | `previousDisplayName` | string | нет | | `newDisplayName` | string | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "rename_power_query",
  "subsetId": "<subsetId>",
  "stableId": "<stableId>",
  "newDisplayName": "<newDisplayName>"
}
```
 ## save\_power\_query\_definition [Заголовок раздела «save\_power\_query\_definition»](#save_power_query_definition) Сохраняет power query definition. **Запрос** | Поле | Тип TypeScript | Обяз. | | -------------------------- | ---------------------------------------------------------------------------- | ----- | | operation | `"save_power_query_definition"` | да | | `subsetId` | string | да | | query | unknown | да | | `boundDestinationSheetKey` | string | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · save\_power\_query\_definition** | Поле | Тип TypeScript | Обяз. | | --------- | ------------------------------- | ----- | | operation | `"save_power_query_definition"` | да | | status | string | да | | reason | string | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "save_power_query_definition",
  "subsetId": "<subsetId>",
  "query": "<unknown>",
  "requestedBackend": "native-desktop"
}
```

# Power Query: таблицы из запросов

> Загрузка результата запроса в лист, обновление таких таблиц и связь между таблицей на листе и запросом, который её наполняет. Операций на странице: 8.

Загрузка результата запроса в лист, обновление таких таблиц и связь между таблицей на листе и запросом, который её наполняет. Термины — в [глоссарии](/start/glossary/). **Операции на этой странице — 8** * [`pq-product-ribbon-list`](#pq-product-ribbon-list) * [`pq-product-ribbon-probe`](#pq-product-ribbon-probe) * [`pq-product-ribbon-remove`](#pq-product-ribbon-remove) * [`product_table_range_load_to`](#product_table_range_load_to) * [`product_table_range_mutate_step`](#product_table_range_mutate_step) * [`product_table_range_open_query`](#product_table_range_open_query) * [`product_table_range_refresh_all`](#product_table_range_refresh_all) * [`product_table_range_refresh_current`](#product_table_range_refresh_current) ## pq-product-ribbon-list [Заголовок раздела «pq-product-ribbon-list»](#pq-product-ribbon-list) **Запрос** | Поле | Тип TypeScript | Обяз. | | --------- | -------------------------- | ----- | | operation | `"pq-product-ribbon-list"` | да | **Ответ при успехе · pq-product-ribbon-list** | Поле | Тип TypeScript | Обяз. | | --------- | --------------------------------------------------------------------------------------------- | ----- | | operation | `"pq-product-ribbon-list"` | да | | queries | [PqProductRibbonQueryPayload](/reference/f1/types-powerquery/#pqproductribbonquerypayload)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pq-product-ribbon-list",
  "requestedBackend": "native-desktop"
}
```
 ## pq-product-ribbon-probe [Заголовок раздела «pq-product-ribbon-probe»](#pq-product-ribbon-probe) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------ | --------------------------- | ----- | | operation | `"pq-product-ribbon-probe"` | да | | `sheet_name` | string | да | | `table_name` | string | нет | | `range_ref` | string | нет | **Ответ при успехе · pq-product-ribbon-probe** | Поле | Тип TypeScript | Обяз. | | --------- | ------------------------------------------------------------------------------------------ | ----- | | operation | `"pq-product-ribbon-probe"` | да | | query | [PqProductRibbonQueryPayload](/reference/f1/types-powerquery/#pqproductribbonquerypayload) | нет | | denied | [PqProductRibbonDenied](/reference/f1/types-powerquery/#pqproductribbondenied) | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pq-product-ribbon-probe",
  "sheet_name": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## pq-product-ribbon-remove [Заголовок раздела «pq-product-ribbon-remove»](#pq-product-ribbon-remove) **Запрос** | Поле | Тип TypeScript | Обяз. | | ---------- | ---------------------------- | ----- | | operation | `"pq-product-ribbon-remove"` | да | | `query_id` | string | да | **Ответ при успехе · pq-product-ribbon-remove** | Поле | Тип TypeScript | Обяз. | | --------- | ---------------------------- | ----- | | operation | `"pq-product-ribbon-remove"` | да | | removed | boolean | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pq-product-ribbon-remove",
  "query_id": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## product\_table\_range\_load\_to [Заголовок раздела «product\_table\_range\_load\_to»](#product_table_range_load_to) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | -------------------------------------------------------------------------------- | ----- | | operation | `"product_table_range_load_to"` | да | | `subsetId` | string | да | | identity | [TableRangeSourceIdentity](/reference/f1/types-data/#tablerangesourceidentity) | да | | `mText` | string | да | | `queryStableId` | string | нет | | `displayName` | string | нет | | destination | [TableRangeOutputPlacement](/reference/f1/types-data/#tablerangeoutputplacement) | да | | anchor | [CellAnchor](/reference/f1/types-cells/#cellanchor) | нет | | `includeHeader` | boolean | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · product\_table\_range\_load\_to** | Поле | Тип TypeScript | Обяз. | | --------- | ------------------------------- | ----- | | operation | `"product_table_range_load_to"` | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "product_table_range_load_to",
  "subsetId": "<subsetId>",
  "identity": "<TableRangeSourceIdentity>",
  "mText": "<string>",
  "destination": "<TableRangeOutputPlacement>",
  "includeHeader": false,
  "requestedBackend": "native-desktop"
}
```
 ## product\_table\_range\_mutate\_step [Заголовок раздела «product\_table\_range\_mutate\_step»](#product_table_range_mutate_step) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ------------------------------------------------------------------------------ | ----- | | operation | `"product_table_range_mutate_step"` | да | | `subsetId` | string | да | | identity | [TableRangeSourceIdentity](/reference/f1/types-data/#tablerangesourceidentity) | да | | `mText` | string | да | | `queryStableId` | string | нет | | mutation | [StepMutation](/reference/f1/types-common/#stepmutation) | да | | `editorSessionId` | string | нет | | generation | number | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · product\_table\_range\_mutate\_step** | Поле | Тип TypeScript | Обяз. | | --------- | ------------------------------------------------------------------------------------------------ | ----- | | operation | `"product_table_range_mutate_step"` | да | | result | [TableRangeQueryMutationPreview](/reference/f1/types-powerquery/#tablerangequerymutationpreview) | да | | session | [EditorSessionStamp](/reference/f1/types-session/#editorsessionstamp) | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "product_table_range_mutate_step",
  "subsetId": "<subsetId>",
  "identity": "<TableRangeSourceIdentity>",
  "mText": "<string>",
  "mutation": "<StepMutation>",
  "requestedBackend": "native-desktop"
}
```
 ## product\_table\_range\_open\_query [Заголовок раздела «product\_table\_range\_open\_query»](#product_table_range_open_query) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ------------------------------------------------------------------------------ | ----- | | operation | `"product_table_range_open_query"` | да | | `subsetId` | string | да | | identity | [TableRangeSourceIdentity](/reference/f1/types-data/#tablerangesourceidentity) | да | | `queryStableId` | string | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · product\_table\_range\_open\_query** | Поле | Тип TypeScript | Обяз. | | ------------------------ | -------------------------------------------------------------------------------- | ----- | | operation | `"product_table_range_open_query"` | да | | ready | boolean | да | | projection | [AppliedStepsProjection](/reference/f1/types-powerquery/#appliedstepsprojection) | нет | | preview | [TableRangeQueryPreview](/reference/f1/types-powerquery/#tablerangequerypreview) | нет | | session | [EditorSessionStamp](/reference/f1/types-session/#editorsessionstamp) | нет | | `blockReason` | string | нет | | `blockDetail` | string | нет | | `existingOutputStableId` | string | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "product_table_range_open_query",
  "subsetId": "<subsetId>",
  "identity": "<TableRangeSourceIdentity>",
  "requestedBackend": "native-desktop"
}
```
 ## product\_table\_range\_refresh\_all [Заголовок раздела «product\_table\_range\_refresh\_all»](#product_table_range_refresh_all) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"product_table_range_refresh_all"` | да | | `subsetId` | string | да | | action | `"run"` \| “start” \| “poll” \| “commit” \| “cancel” | нет | | generation | number | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · product\_table\_range\_refresh\_all** | Поле | Тип TypeScript | Обяз. | | --------- | ----------------------------------- | ----- | | operation | `"product_table_range_refresh_all"` | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "product_table_range_refresh_all",
  "subsetId": "<subsetId>",
  "requestedBackend": "native-desktop"
}
```
 ## product\_table\_range\_refresh\_current [Заголовок раздела «product\_table\_range\_refresh\_current»](#product_table_range_refresh_current) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"product_table_range_refresh_current"` | да | | `subsetId` | string | да | | `queryStableId` | string | да | | action | `"run"` \| “start” \| “poll” \| “commit” \| “cancel” | нет | | generation | number | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · product\_table\_range\_refresh\_current** | Поле | Тип TypeScript | Обяз. | | --------- | --------------------------------------- | ----- | | operation | `"product_table_range_refresh_current"` | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "product_table_range_refresh_current",
  "subsetId": "<subsetId>",
  "queryStableId": "<string>",
  "requestedBackend": "native-desktop"
}
```

# Power Query: доверие и приватность

> Уровни приватности источников, решения о доверии и настройки подключений. Операций на странице: 6.

Уровни приватности источников, решения о доверии и настройки подключений. Термины — в [глоссарии](/start/glossary/). **Операции на этой странице — 6** * [`pq-data-source-settings-apply`](#pq-data-source-settings-apply) * [`pq-data-source-settings-list`](#pq-data-source-settings-list) * [`pq-privacy-level-list`](#pq-privacy-level-list) * [`pq-privacy-level-reset`](#pq-privacy-level-reset) * [`pq-privacy-level-set`](#pq-privacy-level-set) * [`source_trust_decision`](#source_trust_decision) ## pq-data-source-settings-apply [Заголовок раздела «pq-data-source-settings-apply»](#pq-data-source-settings-apply) В опубликованный выпуск пока не вошла Операция описана контрактом, но ядро последнего выпуска её не принимает: на такой запрос придёт отказ с перечнем известных ему операций. Что входит в выпуск, а что пока только в контракт — в [обзоре справочника](/reference/f1/overview/). **Запрос** | Поле | Тип TypeScript | Обяз. | | ---------- | ------------------------------------------------------------------ | ----- | | operation | “pq-data-source-settings-apply” | да | | `subsetId` | string | да | | action | “change-source-path” \| “clear-permissions” \| “set-privacy-level” | да | | `scopeId` | string | да | | `newPath` | string | нет | | level | string | нет | **Ответ при успехе · pq-data-source-settings-apply** | Поле | Тип TypeScript | Обяз. | | --------- | ------------------------------------------------------------------------------------------ | ----- | | operation | “pq-data-source-settings-apply” | да | | outcome | [PqDataSourceSettingsOutcome](/reference/f1/types-powerquery/#pqdatasourcesettingsoutcome) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pq-data-source-settings-apply",
  "subsetId": "<subsetId>",
  "action": "change-source-path",
  "scopeId": "<scopeId>"
}
```
 ## pq-data-source-settings-list [Заголовок раздела «pq-data-source-settings-list»](#pq-data-source-settings-list) В опубликованный выпуск пока не вошла Операция описана контрактом, но ядро последнего выпуска её не принимает: на такой запрос придёт отказ с перечнем известных ему операций. Что входит в выпуск, а что пока только в контракт — в [обзоре справочника](/reference/f1/overview/). **Запрос** | Поле | Тип TypeScript | Обяз. | | ---------- | ------------------------------ | ----- | | operation | “pq-data-source-settings-list” | да | | `subsetId` | string | да | **Ответ при успехе · pq-data-source-settings-list** | Поле | Тип TypeScript | Обяз. | | --------- | ------------------------------------------------------------------------- | ----- | | operation | “pq-data-source-settings-list” | да | | sources | [PqDataSourceEntry](/reference/f1/types-powerquery/#pqdatasourceentry)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pq-data-source-settings-list",
  "subsetId": "<subsetId>"
}
```
 ## pq-privacy-level-list [Заголовок раздела «pq-privacy-level-list»](#pq-privacy-level-list) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | --------------------------------------------------------------------------------------- | ----- | | operation | `"pq-privacy-level-list"` | да | | `userStore` | [PqPrivacyLevelAssignment](/reference/f1/types-powerquery/#pqprivacylevelassignment)\[] | нет | | `workbookDeclared` | [PqPrivacyLevelAssignment](/reference/f1/types-powerquery/#pqprivacylevelassignment)\[] | нет | | `knownScopes` | [PqSourceScopeWire](/reference/f1/types-powerquery/#pqsourcescopewire)\[] | нет | | `subsetId` | string | нет | **Ответ при успехе · pq-privacy-level-list** | Поле | Тип TypeScript | Обяз. | | --------- | ------------------------------------------------------------------------------------- | ----- | | operation | `"pq-privacy-level-list"` | да | | entries | [PqPrivacyLevelListEntry](/reference/f1/types-powerquery/#pqprivacylevellistentry)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pq-privacy-level-list",
  "requestedBackend": "native-desktop"
}
```
 ## pq-privacy-level-reset [Заголовок раздела «pq-privacy-level-reset»](#pq-privacy-level-reset) **Запрос** | Поле | Тип TypeScript | Обяз. | | ---------------- | -------------------------- | ----- | | operation | `"pq-privacy-level-reset"` | да | | `canonicalScope` | string | да | **Ответ при успехе · pq-privacy-level-reset** | Поле | Тип TypeScript | Обяз. | | --------- | ---------------------------------------------------------------------------------------- | ----- | | operation | `"pq-privacy-level-reset"` | да | | outcome | [PqPrivacyLevelWriteOutcome](/reference/f1/types-powerquery/#pqprivacylevelwriteoutcome) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pq-privacy-level-reset",
  "canonicalScope": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## pq-privacy-level-set [Заголовок раздела «pq-privacy-level-set»](#pq-privacy-level-set) **Запрос** | Поле | Тип TypeScript | Обяз. | | ---------------- | ------------------------ | ----- | | operation | `"pq-privacy-level-set"` | да | | `canonicalScope` | string | да | | level | string | да | **Ответ при успехе · pq-privacy-level-set** | Поле | Тип TypeScript | Обяз. | | --------- | ---------------------------------------------------------------------------------------- | ----- | | operation | `"pq-privacy-level-set"` | да | | outcome | [PqPrivacyLevelWriteOutcome](/reference/f1/types-powerquery/#pqprivacylevelwriteoutcome) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "pq-privacy-level-set",
  "canonicalScope": "<string>",
  "level": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## source\_trust\_decision [Заголовок раздела «source\_trust\_decision»](#source_trust_decision) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ----------------------------------------------------------------------------------------------------------- | ----- | | operation | `"source_trust_decision"` | да | | action | [ContractSourceTrustAction](/reference/f1/types-common/#contractsourcetrustaction) | да | | observation | [ContractSourceTrustObservation](/reference/f1/types-common/#contractsourcetrustobservation) | да | | grant | [ContractSourceTrustGrantBinding](/reference/f1/types-common/#contractsourcetrustgrantbinding) \| null | нет | | session | [ContractSourceTrustSessionBinding](/reference/f1/types-session/#contractsourcetrustsessionbinding) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · source\_trust\_decision** | Поле | Тип TypeScript | Обяз. | | --------- | -------------------------------------------------------------------------------------- | ----- | | operation | `"source_trust_decision"` | да | | decision | [ContractSourceTrustDecision](/reference/f1/types-common/#contractsourcetrustdecision) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "source_trust_decision",
  "action": "<ContractSourceTrustAction>",
  "observation": "<ContractSourceTrustObservation>",
  "requestedBackend": "native-desktop"
}
```

# Печать и разметка

> Параметры страницы, разрывы, фон листа и печать листов с диаграммами. Операций на странице: 7.

Параметры страницы, разрывы, фон листа и печать листов с диаграммами. Термины — в [глоссарии](/start/glossary/). **Операции на этой странице — 7** * [`apply_sheet_background_patch`](#apply_sheet_background_patch) * [`apply_worksheet_page_setup`](#apply_worksheet_page_setup) * [`compute_page_break_layout`](#compute_page_break_layout) * [`create_chart_sheet_bounded`](#create_chart_sheet_bounded) * [`mutate_worksheet_page_breaks`](#mutate_worksheet_page_breaks) * [`preview_chart_sheet_print`](#preview_chart_sheet_print) * [`set_chart_sheet_print_bounded`](#set_chart_sheet_print_bounded) ## apply\_sheet\_background\_patch [Заголовок раздела «apply\_sheet\_background\_patch»](#apply_sheet_background_patch) Применяет sheet background patch. **Запрос** | Поле | Тип TypeScript | Обяз. | | -------------------- | ------------------------------------------------------------------------------------------------- | ----- | | operation | `"apply_sheet_background_patch"` | да | | `subsetId` | string | да | | `packageBytesBase64` | string | да | | patch | [ContractXlsxSheetBackgroundPatch](/reference/f1/types-session/#contractxlsxsheetbackgroundpatch) | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · apply\_sheet\_background\_patch** | Поле | Тип TypeScript | Обяз. | | -------------------- | -------------------------------- | ----- | | operation | `"apply_sheet_background_patch"` | да | | `packageBytesBase64` | string | да | | `byteCount` | number | да | | applied | boolean | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "apply_sheet_background_patch",
  "subsetId": "<subsetId>",
  "packageBytesBase64": "<base64>",
  "patch": "<ContractXlsxSheetBackgroundPatch>",
  "requestedBackend": "native-desktop"
}
```
 ## apply\_worksheet\_page\_setup [Заголовок раздела «apply\_worksheet\_page\_setup»](#apply_worksheet_page_setup) Применяет worksheet page setup. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ----------------------------------------------------------------------------------- | ----- | | operation | `"apply_worksheet_page_setup"` | да | | `subsetId` | string | да | | `sheetKey` | string | да | | `pageSetup` | [ContractWorksheetPageSetup](/reference/f1/types-print/#contractworksheetpagesetup) | да | | `expectedRevision` | number \| null | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · apply\_worksheet\_page\_setup** | Поле | Тип TypeScript | Обяз. | | ---------------------------- | ------------------------------------------------------------------------------------------------------------ | ----- | | operation | `"apply_worksheet_page_setup"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `changedPageSetup` | boolean | да | | `pageSetup` | [ContractWorksheetPageSetup](/reference/f1/types-print/#contractworksheetpagesetup) | да | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `dirtyCellCount` | number | да | | `currentSourceSaveReadiness` | [ContractCurrentSourceSaveReadiness](/reference/f1/types-common/#contractcurrentsourcesavereadiness) \| null | нет | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "apply_worksheet_page_setup",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "pageSetup": "<ContractWorksheetPageSetup>",
  "requestedBackend": "native-desktop"
}
```
 ## compute\_page\_break\_layout [Заголовок раздела «compute\_page\_break\_layout»](#compute_page_break_layout) Вычисляет page break layout. **Запрос** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | ------------------ | ----------------------------------------------------------------------------------- | ----- | ------------------------------------------------------------------------------------------------------------------- | | operation | `"compute_page_break_layout"` | да | | | `subsetId` | string | да | | | `sheetKey` | string | да | | | `usedRowEnd` | number | да | Правый нижний угол занятой области, которую должна покрыть разбивка на страницы. Отсчёт с нуля, границы включаются. | | `usedColEnd` | number | да | | | `pageSetup` | [ContractPageBreakPageSetup](/reference/f1/types-print/#contractpagebreakpagesetup) | да | | | `manualRowBreaks` | number\[] | да | Номера строк, перед которыми пользователь поставил разрыв страницы вручную. Отсчёт с нуля. | | `manualColBreaks` | number\[] | да | Номера столбцов, перед которыми пользователь поставил разрыв страницы вручную. Отсчёт с нуля. | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | | **Ответ при успехе · compute\_page\_break\_layout** | Поле | Тип TypeScript | Обяз. | | ------------- | ----------------------------------------------------------------------------------- | ----- | | operation | `"compute_page_break_layout"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `rowBreaks` | [ContractPageBreakLine](/reference/f1/types-print/#contractpagebreakline)\[] | да | | `colBreaks` | [ContractPageBreakLine](/reference/f1/types-print/#contractpagebreakline)\[] | да | | `pagesAcross` | number | да | | `pagesDown` | number | да | | `pageCount` | number | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "compute_page_break_layout",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "usedRowEnd": 0,
  "usedColEnd": 0,
  "pageSetup": "<ContractPageBreakPageSetup>",
  "manualRowBreaks": 0,
  "manualColBreaks": 0,
  "requestedBackend": "native-desktop"
}
```
 ## create\_chart\_sheet\_bounded [Заголовок раздела «create\_chart\_sheet\_bounded»](#create_chart_sheet_bounded) Создаёт chart sheet bounded. **Запрос** | Поле | Тип TypeScript | Обяз. | | --------------------- | ---------------------------------------------------------------------------- | ----- | | operation | `"create_chart_sheet_bounded"` | да | | `subsetId` | string | да | | `sourceSheetKey` | string | да | | `sourceChartStableId` | string | да | | name | string | да | | `targetIndex` | number \| null | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · create\_chart\_sheet\_bounded** | Поле | Тип TypeScript | Обяз. | | ------------------------ | ----------------------------------------------------------------------------------------------- | ----- | | operation | `"create_chart_sheet_bounded"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `createdSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `surfaceObjects` | [ContractSheetObject](/reference/f1/types-session/#contractsheetobject)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) \| null | нет | | `nativeChartsheetClaim` | `"live_verified"` | да | | `lifecycleClaim` | `"live_verified"` | да | | `macroSheetParityClaim` | `"no"` | да | | `dialogSheetParityClaim` | `"no"` | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "create_chart_sheet_bounded",
  "subsetId": "<subsetId>",
  "sourceSheetKey": "<string>",
  "sourceChartStableId": "<string>",
  "name": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## mutate\_worksheet\_page\_breaks [Заголовок раздела «mutate\_worksheet\_page\_breaks»](#mutate_worksheet_page_breaks) В опубликованный выпуск пока не вошла Операция описана контрактом, но ядро последнего выпуска её не принимает: на такой запрос придёт отказ с перечнем известных ему операций. Что входит в выпуск, а что пока только в контракт — в [обзоре справочника](/reference/f1/overview/). **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ----------------------------------------------------------------------------------------------- | ----- | | operation | “mutate\_worksheet\_page\_breaks” | да | | `subsetId` | string | да | | `sheetKey` | string | да | | intent | [ContractWorksheetPageBreakIntent](/reference/f1/types-print/#contractworksheetpagebreakintent) | да | | `expectedRevision` | number | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | **Ответ при успехе · mutate\_worksheet\_page\_breaks** | Поле | Тип TypeScript | Обяз. | | ------------------- | --------------------------------------------------------------------------------------------------- | ----- | | operation | “mutate\_worksheet\_page\_breaks” | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `changedPageBreaks` | boolean | да | | `effectiveScale` | number | да | | areas | [ContractPageBreakAreaProjection](/reference/f1/types-print/#contractpagebreakareaprojection)\[] | да | | `rowBreaks` | [ContractPageBreakLine](/reference/f1/types-print/#contractpagebreakline)\[] | да | | `colBreaks` | [ContractPageBreakLine](/reference/f1/types-print/#contractpagebreakline)\[] | да | | `pagesAcross` | number | да | | `pagesDown` | number | да | | `pageCount` | number | да | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `dirtyCellCount` | number | да | | `recalcNeeded` | boolean | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "mutate_worksheet_page_breaks",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetKey>",
  "intent": "<ContractWorksheetPageBreakIntent>",
  "expectedRevision": 0
}
```
 ## preview\_chart\_sheet\_print [Заголовок раздела «preview\_chart\_sheet\_print»](#preview_chart_sheet_print) Формирует preview для chart sheet print. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"preview_chart_sheet_print"` | да | | `subsetId` | string | да | | `sheetKey` | string | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · preview\_chart\_sheet\_print** | Поле | Тип TypeScript | Обяз. | | ------------------------ | ---------------------------------------------------------------------------------------------- | ----- | | operation | `"preview_chart_sheet_print"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `chartSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | settings | [ContractChartSheetPrintSettings](/reference/f1/types-charts/#contractchartsheetprintsettings) | да | | preview | [ContractChartSheetPrintPreview](/reference/f1/types-charts/#contractchartsheetprintpreview) | да | | `nativeChartsheetClaim` | `"live_verified"` | да | | `printPreviewClaim` | `"live_verified"` | да | | `macroSheetParityClaim` | `"no"` | да | | `dialogSheetParityClaim` | `"no"` | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "preview_chart_sheet_print",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "requestedBackend": "native-desktop"
}
```
 ## set\_chart\_sheet\_print\_bounded [Заголовок раздела «set\_chart\_sheet\_print\_bounded»](#set_chart_sheet_print_bounded) Устанавливает chart sheet print bounded. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------------------------- | ----- | | operation | `"set_chart_sheet_print_bounded"` | да | | `subsetId` | string | да | | `sheetKey` | string | да | | settings | [ContractChartSheetPrintSettings](/reference/f1/types-charts/#contractchartsheetprintsettings) | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · set\_chart\_sheet\_print\_bounded** | Поле | Тип TypeScript | Обяз. | | ------------------------ | ---------------------------------------------------------------------------------------------- | ----- | | operation | `"set_chart_sheet_print_bounded"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `didChange` | boolean | да | | `chartSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | settings | [ContractChartSheetPrintSettings](/reference/f1/types-charts/#contractchartsheetprintsettings) | да | | preview | [ContractChartSheetPrintPreview](/reference/f1/types-charts/#contractchartsheetprintpreview) | да | | `nativeChartsheetClaim` | `"live_verified"` | да | | `printPreviewClaim` | `"live_verified"` | да | | `macroSheetParityClaim` | `"no"` | да | | `dialogSheetParityClaim` | `"no"` | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "set_chart_sheet_print_bounded",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "settings": "<ContractChartSheetPrintSettings>",
  "requestedBackend": "native-desktop"
}
```

# Защита и рецензирование

> Защита листа и книги, разрешения на диапазоны, аудит защиты, отслеживание изменений, примечания и рукописные пометки. Операций на странице: 8.

Защита листа и книги, разрешения на диапазоны, аудит защиты, отслеживание изменений, примечания и рукописные пометки. Термины — в [глоссарии](/start/glossary/). **Операции на этой странице — 8** * [`apply_track_insert_delete`](#apply_track_insert_delete) * [`apply_track_visibility`](#apply_track_visibility) * [`protected_ranges_permissions`](#protected_ranges_permissions) * [`protection_inspector_audit`](#protection_inspector_audit) * [`review_annotations_lifecycle`](#review_annotations_lifecycle) * [`review_ink_lifecycle`](#review_ink_lifecycle) * [`set_sheet_protection_bounded`](#set_sheet_protection_bounded) * [`workbook_protection_lifecycle`](#workbook_protection_lifecycle) ## apply\_track\_insert\_delete [Заголовок раздела «apply\_track\_insert\_delete»](#apply_track_insert_delete) Применяет track insert delete. **Запрос** | Поле | Тип TypeScript | Обяз. | | -------------------- | -------------------------------------------------------------------------------------------- | ----- | | operation | `"apply_track_insert_delete"` | да | | `expectedRevision` | number \| null | нет | | `subsetId` | string | да | | `sheetKey` | string | да | | axis | [ContractTrackAxis](/reference/f1/types-protection/#contracttrackaxis) | да | | index | number | да | | action | [ContractTrackStructureAction](/reference/f1/types-protection/#contracttrackstructureaction) | да | | scope | [CellRange](/reference/f1/types-cells/#cellrange) \| null | нет | | count | number | нет | | `insertedHeaderText` | string \| null | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · apply\_track\_insert\_delete** | Поле | Тип TypeScript | Обяз. | | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- | | operation | `"apply_track_insert_delete"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | axis | [ContractTrackAxis](/reference/f1/types-protection/#contracttrackaxis) | да | | index | number | да | | action | [ContractTrackStructureAction](/reference/f1/types-protection/#contracttrackstructureaction) | да | | scope | [CellRange](/reference/f1/types-cells/#cellrange) \| null | нет | | count | number | да | | `changedRows` | number\[] | да | | `changedColumns` | number\[] | да | | `shiftedCellCount` | number | да | | `removedCellCount` | number | да | | `trackStructureClaim` | `"live_verified"` | да | | `structureScope` | \| “active\_visible\_value\_track\_current\_sheet” \| “active\_visible\_value\_and\_simple\_formula\_insert\_current\_sheet” \| “active\_visible\_value\_and\_simple\_formula\_structure\_current\_sheet” \| “table\_scoped\_sparse\_structure\_current\_sheet” | да | | `formulaReferenceRewriteClaim` | \| “no” \| “insert\_only\_bounded\_same\_sheet\_refs” \| “bounded\_same\_sheet\_refs” | да | | `mergeReferenceRewriteClaim` | `"no"` \| “bounded\_track\_merge\_refs” | да | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `dirtyCellCount` | number | да | | `currentSourceSaveReadiness` | [ContractCurrentSourceSaveReadiness](/reference/f1/types-common/#contractcurrentsourcesavereadiness) \| null | нет | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "apply_track_insert_delete",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "axis": "<ContractTrackAxis>",
  "index": 0,
  "action": "<ContractTrackStructureAction>",
  "requestedBackend": "native-desktop"
}
```
 ## apply\_track\_visibility [Заголовок раздела «apply\_track\_visibility»](#apply_track_visibility) Применяет track visibility. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------------ | -------------------------------------------------------------------------------------------- | ----- | | operation | `"apply_track_visibility"` | да | | `subsetId` | string | да | | `sheetKey` | string | да | | axis | [ContractTrackAxis](/reference/f1/types-protection/#contracttrackaxis) | да | | `visibilityOwner` | [ContractTrackVisibilityOwner](/reference/f1/types-protection/#contracttrackvisibilityowner) | нет | | index | number \| null | нет | | indices | number\[] | нет | | `replaceOwnerProjection` | boolean | нет | | hidden | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · apply\_track\_visibility** | Поле | Тип TypeScript | Обяз. | | ---------------------------- | ------------------------------------------------------------------------------------------------------------ | ----- | | operation | `"apply_track_visibility"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | axis | [ContractTrackAxis](/reference/f1/types-protection/#contracttrackaxis) | да | | index | number | да | | hidden | boolean | да | | `changedRows` | number\[] | да | | `changedColumns` | number\[] | да | | `hiddenRows` | number\[] | да | | `manualHiddenRows` | number\[] | да | | `filterHiddenRows` | number\[] | да | | `dirtyCellCount` | number | да | | `currentSourceSaveReadiness` | [ContractCurrentSourceSaveReadiness](/reference/f1/types-common/#contractcurrentsourcesavereadiness) \| null | нет | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "apply_track_visibility",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "axis": "<ContractTrackAxis>",
  "hidden": false,
  "requestedBackend": "native-desktop"
}
```
 ## protected\_ranges\_permissions [Заголовок раздела «protected\_ranges\_permissions»](#protected_ranges_permissions) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------------------------- | ----- | | operation | `"protected_ranges_permissions"` | да | | `subsetId` | string | да | | intent | [ContractProtectedRangesIntent](/reference/f1/types-protection/#contractprotectedrangesintent) | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · protected\_ranges\_permissions** | Поле | Тип TypeScript | Обяз. | | ---------- | ---------------------------------------------------------------------------------------------- | ----- | | operation | `"protected_ranges_permissions"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | result | [ContractProtectedRangesResult](/reference/f1/types-protection/#contractprotectedrangesresult) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "protected_ranges_permissions",
  "subsetId": "<subsetId>",
  "intent": "<ContractProtectedRangesIntent>",
  "requestedBackend": "native-desktop"
}
```
 ## protection\_inspector\_audit [Заголовок раздела «protection\_inspector\_audit»](#protection_inspector_audit) **Запрос** | Поле | Тип TypeScript | Обяз. | | -------------------- | ---------------------------------------------------------------------------------------------- | ----- | | operation | `"protection_inspector_audit"` | да | | `subsetId` | string | да | | `requestId` | string | да | | `expectedRevision` | number | да | | `expectedGeneration` | number | да | | `readOnly` | boolean | нет | | intent | [ContractProtectionAuditIntent](/reference/f1/types-protection/#contractprotectionauditintent) | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · protection\_inspector\_audit** | Поле | Тип TypeScript | Обяз. | | ---------- | ---------------------------------------------------------------------------------------------- | ----- | | operation | `"protection_inspector_audit"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | result | [ContractProtectionAuditResult](/reference/f1/types-protection/#contractprotectionauditresult) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "protection_inspector_audit",
  "subsetId": "<subsetId>",
  "requestId": "<string>",
  "expectedRevision": 0,
  "expectedGeneration": 0,
  "intent": "<ContractProtectionAuditIntent>",
  "requestedBackend": "native-desktop"
}
```
 ## review\_annotations\_lifecycle [Заголовок раздела «review\_annotations\_lifecycle»](#review_annotations_lifecycle) **Запрос** | Поле | Тип TypeScript | Обяз. | | -------------------- | -------------------------------------------------------------------------------------------------- | ----- | | operation | `"review_annotations_lifecycle"` | да | | `subsetId` | string | да | | `requestId` | string | да | | `expectedRevision` | number | да | | `expectedGeneration` | number | да | | `nowUtc` | string | да | | `readOnly` | boolean | нет | | protected | boolean | нет | | state | [ContractReviewAnnotationsState](/reference/f1/types-protection/#contractreviewannotationsstate) | да | | intent | [ContractReviewAnnotationsIntent](/reference/f1/types-protection/#contractreviewannotationsintent) | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · review\_annotations\_lifecycle** | Поле | Тип TypeScript | Обяз. | | ----------------- | --------------------------------------------------------------------------------------------------- | ----- | | operation | `"review_annotations_lifecycle"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | result | [ContractReviewAnnotationsResult](/reference/f1/types-protection/#contractreviewannotationsresult) | да | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "review_annotations_lifecycle",
  "subsetId": "<subsetId>",
  "requestId": "<string>",
  "expectedRevision": 0,
  "expectedGeneration": 0,
  "nowUtc": "<string>",
  "state": "<ContractReviewAnnotationsState>",
  "intent": "<ContractReviewAnnotationsIntent>",
  "requestedBackend": "native-desktop"
}
```
 ## review\_ink\_lifecycle [Заголовок раздела «review\_ink\_lifecycle»](#review_ink_lifecycle) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | -------------------------------------------------------------------------------------------- | ----- | | operation | `"review_ink_lifecycle"` | да | | `subsetId` | string | да | | scope | [ContractReviewInkDeleteScope](/reference/f1/types-protection/#contractreviewinkdeletescope) | да | | `sheetPath` | string \| null | нет | | `expectedRevision` | number | да | | `readOnly` | boolean | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · review\_ink\_lifecycle** | Поле | Тип TypeScript | Обяз. | | --------------------------------- | --------------------------------------------------------------------------------------------------------------- | ----- | | operation | `"review_ink_lifecycle"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | scope | [ContractReviewInkDeleteScope](/reference/f1/types-protection/#contractreviewinkdeletescope) | да | | `deletedCount` | number | да | | `byteCount` | number | да | | `identityLedger` | [ContractReviewInkIdentityLedgerEntry](/reference/f1/types-protection/#contractreviewinkidentityledgerentry)\[] | да | | `removedPartCount` | number | да | | `removedRelationshipCount` | number | да | | `removedContentTypeOverrideCount` | number | да | | `preservedInkParts` | [ContractReviewInkPreservedPart](/reference/f1/types-protection/#contractreviewinkpreservedpart)\[] | да | | `preexistingOrphanCount` | number | да | | `orphanCount` | number | да | | `newOrphanCount` | number | да | | `objectInventory` | [ContractWorkbookObjectInventoryEntry](/reference/f1/types-session/#contractworkbookobjectinventoryentry)\[] | да | | `inkProjection` | [ContractReviewInkProjectionItem](/reference/f1/types-protection/#contractreviewinkprojectionitem)\[] | да | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `surfaceObjects` | [ContractSheetObject](/reference/f1/types-session/#contractsheetobject)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) | нет | **Минимальный JSON-шаблон** 
```json
{
  "operation": "review_ink_lifecycle",
  "subsetId": "<subsetId>",
  "scope": "<ContractReviewInkDeleteScope>",
  "expectedRevision": 0,
  "requestedBackend": "native-desktop"
}
```
 ## set\_sheet\_protection\_bounded [Заголовок раздела «set\_sheet\_protection\_bounded»](#set_sheet_protection_bounded) Устанавливает sheet protection bounded. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ----------------------------------------------------------------------------------------------------------------------- | ----- | | operation | `"set_sheet_protection_bounded"` | да | | `subsetId` | string | да | | `sheetKey` | string | да | | protected | boolean | да | | `allowedActions` | [ContractSheetProtectionAllowedAction](/reference/f1/types-protection/#contractsheetprotectionallowedaction)\[] \| null | нет | | password | string \| null | нет | | `sessionAction` | [ContractSheetProtectionSessionAction](/reference/f1/types-protection/#contractsheetprotectionsessionaction) \| null | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · set\_sheet\_protection\_bounded** | Поле | Тип TypeScript | Обяз. | | --------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----- | | operation | `"set_sheet_protection_bounded"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `changedSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `previousProtected` | boolean | да | | `previousAllowedActions` | [ContractSheetProtectionAllowedAction](/reference/f1/types-protection/#contractsheetprotectionallowedaction)\[] \| null | нет | | `previousPasswordProtected` | boolean | да | | protected | boolean | да | | `allowedActions` | [ContractSheetProtectionAllowedAction](/reference/f1/types-protection/#contractsheetprotectionallowedaction)\[] \| null | нет | | `passwordProtected` | boolean | да | | `packageProtected` | boolean | да | | `effectiveProtected` | boolean | да | | `sessionUnlocked` | boolean | да | | `sessionAction` | [ContractSheetProtectionSessionAction](/reference/f1/types-protection/#contractsheetprotectionsessionaction) \| null | нет | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) \| null | нет | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `sheetProtectionClaim` | `"live_verified"` | да | | `protectionScope` | `"same_workbook_sheetProtection_metadata"` | да | | `passwordProtectionClaim` | `"live_verified"` | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "set_sheet_protection_bounded",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "protected": false,
  "requestedBackend": "native-desktop"
}
```
 ## workbook\_protection\_lifecycle [Заголовок раздела «workbook\_protection\_lifecycle»](#workbook_protection_lifecycle) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------------------------------- | ----- | | operation | `"workbook_protection_lifecycle"` | да | | `subsetId` | string | да | | intent | [ContractWorkbookProtectionIntent](/reference/f1/types-protection/#contractworkbookprotectionintent) | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · workbook\_protection\_lifecycle** | Поле | Тип TypeScript | Обяз. | | ---------- | ---------------------------------------------------------------------------------------------------- | ----- | | operation | `"workbook_protection_lifecycle"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | result | [ContractWorkbookProtectionResult](/reference/f1/types-protection/#contractworkbookprotectionresult) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "workbook_protection_lifecycle",
  "subsetId": "<subsetId>",
  "intent": "<ContractWorkbookProtectionIntent>",
  "requestedBackend": "native-desktop"
}
```

# Сеанс и книга

> Открытие подмножества книги, сохранение, окно просмотра, восстановление, свойства, сравнение и слияние ревизий. Операций на странице: 17.

Открытие подмножества книги, сохранение, окно просмотра, восстановление, свойства, сравнение и слияние ревизий. Термины — в [глоссарии](/start/glossary/). **Запрос** | Поле | Тип TypeScript | Обяз. | | ---------------------- | ------------------------------------------------------------------------------------------------ | ----- | | operation | `"open_workbook_subset_from_bytes"` | да | | `sourceName` | string | да | | `sourceBytesBase64` | string | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `delimitedOpenOptions` | [ContractDelimitedOpenOptions](/reference/f1/types-common/#contractdelimitedopenoptions) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · open\_workbook\_subset** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | ----------------------------- | -------------------------------------------------------------------------------------------------------------------- | ----- | ----------------------------------------------------------------------------------------------- | | operation | `"open_workbook_subset"` | да | | | `subsetId` | string | да | | | `sheetCount` | number | да | | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | | readiness | [ContractWorkbookReadiness](/reference/f1/types-session/#contractworkbookreadiness) | да | | | `formatCapabilities` | [ContractFormatCapabilities](/reference/f1/types-format/#contractformatcapabilities) \| null | нет | | | `xlsbDirtySaveProfile` | [ContractXlsbDirtySaveProfile](/reference/f1/types-common/#contractxlsbdirtysaveprofile) \| null | нет | | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | нет | | | `themeFonts` | [ContractWorkbookThemeFontsProjection](/reference/f1/types-session/#contractworkbookthemefontsprojection) \| null | нет | | | `tableMetadata` | [ContractTableMetadataProjection](/reference/f1/types-data/#contracttablemetadataprojection) \| null | нет | | | `workbookTableMetadata` | [ContractTableMetadataProjection](/reference/f1/types-data/#contracttablemetadataprojection) \| null | нет | | | `worksheetAutoFilterMetadata` | [ContractWorksheetAutoFilterMetadata](/reference/f1/types-data/#contractworksheetautofiltermetadata) \| null | нет | | | `directionPlaceholder` | [ContractDirectionPlaceholderSubset](/reference/f1/types-session/#contractdirectionplaceholdersubset) \| null | нет | | | `objectStatusPlaceholder` | [ContractObjectStatusPlaceholderSubset](/reference/f1/types-session/#contractobjectstatusplaceholdersubset) \| null | нет | | | `surfaceObjects` | [ContractSheetObject](/reference/f1/types-session/#contractsheetobject)\[] \| null | нет | | | `objectInventory` | [ContractWorkbookObjectInventoryEntry](/reference/f1/types-session/#contractworkbookobjectinventoryentry)\[] \| null | нет | | | `inkProjection` | [ContractReviewInkProjectionItem](/reference/f1/types-protection/#contractreviewinkprojectionitem)\[] \| null | нет | | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | | `recalcNeeded` | boolean | да | | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | | `conditionalFormattingRules` | [ContractConditionalRule](/reference/f1/types-format/#contractconditionalrule)\[] | нет | | | `dataValidationMetadata` | [ContractDataValidationMetadata](/reference/f1/types-data/#contractdatavalidationmetadata) | нет | | | `frozenBandCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | нет | | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) \| null | нет | | | `formulaTrustSnapshot` | [ContractFormulaTrustSnapshot](/reference/f1/types-formulas/#contractformulatrustsnapshot) \| null | нет | | | `themeColorPalette` | string\[] | нет | | | `viewportReadiness` | [ContractViewportReadiness](/reference/f1/types-session/#contractviewportreadiness) | нет | Готовность области данных: показывать её можно только после того, как ядро объявило её готовой. | **Минимальный JSON-шаблон** 
```json
{
  "operation": "open_workbook_subset_from_bytes",
  "sourceName": "book.xlsx",
  "sourceBytesBase64": "<base64>",
  "requestedBackend": "native-desktop"
}
```
 ## publish\_file\_open\_recovery [Заголовок раздела «publish\_file\_open\_recovery»](#publish_file_open_recovery) Публикует file open recovery. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | -------------------------------------------------------------------------------- | ----- | | operation | `"publish_file_open_recovery"` | да | | `sourceUri` | string | да | | `destinationUri` | string | да | | `planId` | string | да | | mode | [ContractFileRecoveryMode](/reference/f1/types-common/#contractfilerecoverymode) | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · publish\_file\_open\_recovery** | Поле | Тип TypeScript | Обяз. | | ----------- | ---------------------------------------------------------------------------------------------- | ----- | | operation | `"publish_file_open_recovery"` | да | | publication | [ContractFileRecoveryPublication](/reference/f1/types-common/#contractfilerecoverypublication) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "publish_file_open_recovery",
  "sourceUri": "file:///path/book.xlsx",
  "destinationUri": "file:///path/output.xlsx",
  "planId": "<string>",
  "mode": "<ContractFileRecoveryMode>",
  "requestedBackend": "native-desktop"
}
```
 ## replay\_workbook\_history [Заголовок раздела «replay\_workbook\_history»](#replay_workbook_history) Воспроизводит workbook history. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ------------------------------------------------------------------------------------------------- | ----- | | operation | `"replay_workbook_history"` | да | | `subsetId` | string | да | | direction | [ContractWorkbookHistoryDirection](/reference/f1/types-session/#contractworkbookhistorydirection) | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · replay\_workbook\_history** | Поле | Тип TypeScript | Обяз. | | -------------- | ------------------------------------------------------------------------------------------------- | ----- | | operation | `"replay_workbook_history"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | direction | [ContractWorkbookHistoryDirection](/reference/f1/types-session/#contractworkbookhistorydirection) | да | | `historyOwner` | [ContractWorkbookHistoryOwner](/reference/f1/types-session/#contractworkbookhistoryowner) | да | | `undoDepth` | number | да | | `redoDepth` | number | да | | revision | number | да | | replayed | ComputeResponsePayload | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "replay_workbook_history",
  "subsetId": "<subsetId>",
  "direction": "<ContractWorkbookHistoryDirection>",
  "requestedBackend": "native-desktop"
}
```
 ## save\_workbook\_subset [Заголовок раздела «save\_workbook\_subset»](#save_workbook_subset) Сохраняет workbook subset. **Запрос** | Поле | Тип TypeScript | Обяз. | | ---------------------- | ------------------------------------------------------------------------------------------------ | ----- | | operation | `"save_workbook_subset"` | да | | `subsetId` | string | да | | `destinationUri` | string | да | | `preserveCachedValues` | boolean | да | | `delimitedSaveOptions` | [ContractDelimitedSaveOptions](/reference/f1/types-common/#contractdelimitedsaveoptions) \| null | нет | | `xlsxSavePatch` | [ContractXlsxSavePatch](/reference/f1/types-common/#contractxlsxsavepatch) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · save\_workbook\_subset** | Поле | Тип TypeScript | Обяз. | | -------------- | --------------------------------------------------------------------------------------------- | ----- | | operation | `"save_workbook_subset"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `saveRoute` | [ContractCurrentSubsetSaveRoute](/reference/f1/types-session/#contractcurrentsubsetsaveroute) | да | | `wroteBytes` | number | да | | `recalcNeeded` | boolean | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "save_workbook_subset",
  "subsetId": "<subsetId>",
  "destinationUri": "file:///path/output.xlsx",
  "preserveCachedValues": false,
  "requestedBackend": "native-desktop"
}
```
 ## save\_workbook\_subset\_to\_bytes [Заголовок раздела «save\_workbook\_subset\_to\_bytes»](#save_workbook_subset_to_bytes) Сохраняет workbook subset to bytes. **Запрос** | Поле | Тип TypeScript | Обяз. | | ---------------------- | ------------------------------------------------------------------------------------------------ | ----- | | operation | `"save_workbook_subset_to_bytes"` | да | | `subsetId` | string | да | | `saveFormat` | [ContractFileFormat](/reference/f1/types-format/#contractfileformat) \| null | нет | | `preserveCachedValues` | boolean | да | | `delimitedSaveOptions` | [ContractDelimitedSaveOptions](/reference/f1/types-common/#contractdelimitedsaveoptions) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · save\_workbook\_subset\_to\_bytes** | Поле | Тип TypeScript | Обяз. | | ---------------------- | -------------------------------------------------------------------------------------------------- | ----- | | operation | `"save_workbook_subset_to_bytes"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `saveRoute` | [ContractCurrentSubsetSaveRoute](/reference/f1/types-session/#contractcurrentsubsetsaveroute) | да | | `formulaTrustSnapshot` | [ContractFormulaTrustSnapshot](/reference/f1/types-formulas/#contractformulatrustsnapshot) \| null | нет | | `savedFormat` | [ContractFileFormat](/reference/f1/types-format/#contractfileformat) | да | | `byteCount` | number | да | | `bytesBase64` | string | да | | `recalcNeeded` | boolean | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "save_workbook_subset_to_bytes",
  "subsetId": "<subsetId>",
  "preserveCachedValues": false,
  "requestedBackend": "native-desktop"
}
```
 ## synchronize\_workbook\_viewport [Заголовок раздела «synchronize\_workbook\_viewport»](#synchronize_workbook_viewport) Синхронизирует workbook viewport. **Запрос** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | ----------------------------- | ---------------------------------------------------------------------------- | ----- | -------------------------------------------------------------------------------------------------------------------------------------- | | operation | `"synchronize_workbook_viewport"` | да | | | `subsetId` | string | да | | | `sourceUri` | string | да | | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | | `recordHistory` | false | да | Изменение вида — не правка пользователя и в историю не попадает. | | `expectedReadinessGeneration` | number \| null | нет | Опускать поле стоит только в старом коде. Обычный порядок — привязать показ к тому поколению данных, которое вы видели перед запросом. | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | | **Ответ при успехе · synchronize\_workbook\_viewport** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | ------------------- | --------------------------------------------------------------------------------------------------------------- | ----- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | operation | `"synchronize_workbook_viewport"` | да | | | `subsetId` | string | да | | | `viewportReadiness` | [ContractViewportReadiness](/reference/f1/types-session/#contractviewportreadiness) | да | | | projection | [OpenWorkbookSubsetProjectionPayload](/reference/f1/types-session/#openworkbooksubsetprojectionpayload) \| null | нет | Есть только при `state=ready`. В ответах об отложенном, отменённом, вытесненном или неудавшемся запросе пустого состояния, выдаваемого за готовые данные, не бывает. | **Минимальный JSON-шаблон** 
```json
{
  "operation": "synchronize_workbook_viewport",
  "subsetId": "<subsetId>",
  "sourceUri": "file:///path/book.xlsx",
  "recordHistory": false,
  "requestedBackend": "native-desktop"
}
```
 ## workbook\_accessibility [Заголовок раздела «workbook\_accessibility»](#workbook_accessibility) **Запрос** | Поле | Тип TypeScript | Обяз. | | -------------------- | ------------------------------------------------------------------------------------------------------- | ----- | | operation | `"workbook_accessibility"` | да | | `subsetId` | string | да | | `requestId` | string | да | | `expectedRevision` | number | да | | `expectedGeneration` | number | да | | `readOnly` | boolean | нет | | protected | boolean | нет | | intent | [ContractWorkbookAccessibilityIntent](/reference/f1/types-session/#contractworkbookaccessibilityintent) | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · workbook\_accessibility** | Поле | Тип TypeScript | Обяз. | | ---------- | ------------------------------------------------------------------------------------------------------- | ----- | | operation | `"workbook_accessibility"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | result | [ContractWorkbookAccessibilityResult](/reference/f1/types-session/#contractworkbookaccessibilityresult) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "workbook_accessibility",
  "subsetId": "<subsetId>",
  "requestId": "<string>",
  "expectedRevision": 0,
  "expectedGeneration": 0,
  "intent": "<ContractWorkbookAccessibilityIntent>",
  "requestedBackend": "native-desktop"
}
```
 ## workbook\_links\_manager [Заголовок раздела «workbook\_links\_manager»](#workbook_links_manager) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | --------------------------------------------------------------------------------------- | ----- | | operation | `"workbook_links_manager"` | да | | `subsetId` | string | да | | intent | [ContractWorkbookLinksIntent](/reference/f1/types-session/#contractworkbooklinksintent) | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · workbook\_links\_manager** | Поле | Тип TypeScript | Обяз. | | ---------- | --------------------------------------------------------------------------------------- | ----- | | operation | `"workbook_links_manager"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | result | [ContractWorkbookLinksResult](/reference/f1/types-session/#contractworkbooklinksresult) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "workbook_links_manager",
  "subsetId": "<subsetId>",
  "intent": "<ContractWorkbookLinksIntent>",
  "requestedBackend": "native-desktop"
}
```
 ## workbook\_window\_session\_command [Заголовок раздела «workbook\_window\_session\_command»](#workbook_window_session_command) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ------------------------------------------------------------------------------------------------------- | ----- | | operation | `"workbook_window_session_command"` | да | | `subsetId` | string | да | | intent | [ContractWorkbookWindowSessionAction](/reference/f1/types-session/#contractworkbookwindowsessionaction) | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · workbook\_window\_session\_command** | Поле | Тип TypeScript | Обяз. | | ---------- | --------------------------------------------------------------------------------------------------------------- | ----- | | operation | `"workbook_window_session_command"` | да | | projection | [ContractWorkbookWindowSessionProjection](/reference/f1/types-session/#contractworkbookwindowsessionprojection) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "workbook_window_session_command",
  "subsetId": "<subsetId>",
  "intent": "<ContractWorkbookWindowSessionAction>",
  "requestedBackend": "native-desktop"
}
```

# Листы

> Жизненный цикл листов, копирование между книгами, видимость, защита и закрепление областей. Операций на странице: 17.

Жизненный цикл листов, копирование между книгами, видимость, защита и закрепление областей. Термины — в [глоссарии](/start/glossary/). **Операции на этой странице — 17** * [`apply_freeze_pane`](#apply_freeze_pane) * [`copy_sheet_bounded`](#copy_sheet_bounded) * [`copy_sheet_to_workbook_bounded`](#copy_sheet_to_workbook_bounded) * [`copy_sheet_values_only_bounded`](#copy_sheet_values_only_bounded) * [`create_sheet_bounded`](#create_sheet_bounded) * [`custom_views_manager`](#custom_views_manager) * [`delete_sheet_bounded`](#delete_sheet_bounded) * [`move_sheet_to_workbook_bounded`](#move_sheet_to_workbook_bounded) * [`redo_sheet_lifecycle_bounded`](#redo_sheet_lifecycle_bounded) * [`rename_sheet_bounded`](#rename_sheet_bounded) * [`reorder_sheet_bounded`](#reorder_sheet_bounded) * [`set_sheet_code_name_bounded`](#set_sheet_code_name_bounded) * [`set_sheet_right_to_left_bounded`](#set_sheet_right_to_left_bounded) * [`set_sheet_tab_color_bounded`](#set_sheet_tab_color_bounded) * [`set_sheet_visibility_bounded`](#set_sheet_visibility_bounded) * [`undo_delete_sheet_bounded`](#undo_delete_sheet_bounded) * [`undo_sheet_lifecycle_bounded`](#undo_sheet_lifecycle_bounded) ## apply\_freeze\_pane [Заголовок раздела «apply\_freeze\_pane»](#apply_freeze_pane) Применяет freeze pane. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"apply_freeze_pane"` | да | | `subsetId` | string | да | | `sheetKey` | string | да | | row | number | да | | col | number | да | | frozen | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · apply\_freeze\_pane** | Поле | Тип TypeScript | Обяз. | | ---------------------------- | ------------------------------------------------------------------------------------------------------------ | ----- | | operation | `"apply_freeze_pane"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | frozen | boolean | да | | `topLeftCell` | string \| null | нет | | `xSplit` | number \| null | нет | | `ySplit` | number \| null | нет | | `changedFreezePane` | boolean | да | | `dirtyCellCount` | number | да | | `currentSourceSaveReadiness` | [ContractCurrentSourceSaveReadiness](/reference/f1/types-common/#contractcurrentsourcesavereadiness) \| null | нет | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "apply_freeze_pane",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "row": 0,
  "col": 0,
  "frozen": false,
  "requestedBackend": "native-desktop"
}
```
 ## copy\_sheet\_bounded [Заголовок раздела «copy\_sheet\_bounded»](#copy_sheet_bounded) Копирует sheet bounded. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"copy_sheet_bounded"` | да | | `subsetId` | string | да | | `sheetKey` | string | да | | name | string | да | | `targetIndex` | number \| null | нет | | `expectedRevision` | number \| null | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · copy\_sheet\_bounded** | Поле | Тип TypeScript | Обяз. | | ---------------------------- | --------------------------------------------------------------------------------------------------- | ----- | | operation | `"copy_sheet_bounded"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `sourceSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `copiedSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) \| null | нет | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `sheetCopyClaim` | `"live_verified"` | да | | `copyScope` | `"same_workbook_cell_formula_style_merge_layout_and_safe_sheet_metadata"` | да | | `copiedSheetIdentityNew` | true | да | | `copiedSheetValuesPreserved` | true | да | | `formulaCopyClaim` | `"live_verified"` | да | | `formulaCopyScope` | `"same_sheet_formula_text_and_cached_value_preserved"` | да | | `styleCopyClaim` | `"live_verified"` | да | | `styleCopyScope` | `"existing_workbook_style_indexes_preserved"` | да | | `mergeLayoutCopyClaim` | `"live_verified"` | да | | `mergeLayoutCopyScope` | `"row_column_geometry_merges_freeze_views_tables_and_safe_sheet_xml_preserved"` | да | | `pqOutputTargetCopyClaim` | `"no"` | да | | `vbaModuleCopyClaim` | `"no"` | да | | `broadWorkbookCloneClaim` | `"no"` | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "copy_sheet_bounded",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "name": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## copy\_sheet\_to\_workbook\_bounded [Заголовок раздела «copy\_sheet\_to\_workbook\_bounded»](#copy_sheet_to_workbook_bounded) Копирует sheet to workbook bounded. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"copy_sheet_to_workbook_bounded"` | да | | `sourceSubsetId` | string | да | | `targetSubsetId` | string | да | | `sourceSheetKey` | string | да | | name | string | да | | `targetViewport` | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · copy\_sheet\_to\_workbook\_bounded** | Поле | Тип TypeScript | Обяз. | | ---------------------------- | ----------------------------------------------------------------------------------------------- | ----- | | operation | `"copy_sheet_to_workbook_bounded"` | да | | `sourceSubsetId` | string | да | | `targetSubsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `sourceSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `copiedSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `targetActiveSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `targetSheetCount` | number | да | | `targetWorkbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | `targetGeometry` | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `targetRecalcNeeded` | boolean | да | | `targetViewport` | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `targetPreviewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `targetLayoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) \| null | нет | | `sheetCopyClaim` | `"live_verified"` | да | | `copyScope` | `"bounded_cross_workbook_cell_formula_style_merge_layout"` | да | | `copiedSheetIdentityNew` | true | да | | `copiedSheetValuesPreserved` | true | да | | `formulaCopyClaim` | `"live_verified"` | да | | `formulaCopyScope` | `"same_sheet_formula_text_and_cached_value_preserved"` | да | | `styleCopyClaim` | `"live_verified"` | да | | `styleCopyScope` | `"existing_target_workbook_style_indexes_preserved"` | да | | `mergeLayoutCopyClaim` | `"live_verified"` | да | | `mergeLayoutCopyScope` | `"row_column_geometry_merges_and_freeze_preserved"` | да | | `pqOutputTargetCopyClaim` | `"no"` | да | | `vbaModuleCopyClaim` | `"no"` | да | | `broadWorkbookCloneClaim` | `"no"` | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "copy_sheet_to_workbook_bounded",
  "sourceSubsetId": "<string>",
  "targetSubsetId": "<string>",
  "sourceSheetKey": "<string>",
  "name": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## copy\_sheet\_values\_only\_bounded [Заголовок раздела «copy\_sheet\_values\_only\_bounded»](#copy_sheet_values_only_bounded) Копирует sheet values only bounded. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"copy_sheet_values_only_bounded"` | да | | `subsetId` | string | да | | `sheetKey` | string | да | | name | string | да | | `expectedRevision` | number \| null | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · copy\_sheet\_values\_only\_bounded** | Поле | Тип TypeScript | Обяз. | | ---------------------------- | --------------------------------------------------------------------------------------------------- | ----- | | operation | `"copy_sheet_values_only_bounded"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `sourceSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `copiedSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) \| null | нет | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `sheetCopyClaim` | `"live_verified"` | да | | `copyScope` | `"values_only_same_workbook_sheet"` | да | | `copiedSheetIdentityNew` | true | да | | `copiedSheetValuesPreserved` | true | да | | `formulaCopyClaim` | `"no"` | да | | `styleCopyClaim` | `"no"` | да | | `mergeLayoutCopyClaim` | `"no"` | да | | `pqOutputTargetCopyClaim` | `"no"` | да | | `vbaModuleCopyClaim` | `"no"` | да | | `broadWorkbookCloneClaim` | `"no"` | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "copy_sheet_values_only_bounded",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "name": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## create\_sheet\_bounded [Заголовок раздела «create\_sheet\_bounded»](#create_sheet_bounded) Создаёт sheet bounded. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"create_sheet_bounded"` | да | | `subsetId` | string | да | | name | string | да | | `targetIndex` | number \| null | нет | | `expectedRevision` | number \| null | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · create\_sheet\_bounded** | Поле | Тип TypeScript | Обяз. | | ------------------------------------ | --------------------------------------------------------------------------------------------------- | ----- | | operation | `"create_sheet_bounded"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `createdSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) \| null | нет | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `sheetCreateClaim` | `"live_verified"` | да | | `sheetCopyClaim` | `"live_verified"` | да | | `deleteReferencedSheetClaim` | `"blocked_truthful_boundary"` | да | | `formulaReferenceDeleteRewriteClaim` | `"no"` | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "create_sheet_bounded",
  "subsetId": "<subsetId>",
  "name": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## custom\_views\_manager [Заголовок раздела «custom\_views\_manager»](#custom_views_manager) **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------------- | ----- | | operation | `"custom_views_manager"` | да | | `subsetId` | string | да | | intent | [ContractCustomViewsIntent](/reference/f1/types-common/#contractcustomviewsintent) | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · custom\_views\_manager** | Поле | Тип TypeScript | Обяз. | | ---------- | ----------------------------------------------------------------------------------- | ----- | | operation | `"custom_views_manager"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | result | [ContractCustomViewsResult](/reference/f1/types-common/#contractcustomviewsresult) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "custom_views_manager",
  "subsetId": "<subsetId>",
  "intent": "<ContractCustomViewsIntent>",
  "requestedBackend": "native-desktop"
}
```
 ## delete\_sheet\_bounded [Заголовок раздела «delete\_sheet\_bounded»](#delete_sheet_bounded) Удаляет sheet bounded. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"delete_sheet_bounded"` | да | | `subsetId` | string | да | | `sheetKey` | string | да | | `expectedRevision` | number \| null | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · delete\_sheet\_bounded** | Поле | Тип TypeScript | Обяз. | | ------------------------------------ | --------------------------------------------------------------------------------------------------- | ----- | | operation | `"delete_sheet_bounded"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `deletedSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) \| null | нет | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `sheetDeleteClaim` | `"live_verified"` | да | | `deleteScope` | `"unreferenced_bounded_sheet_only"` | да | | `deleteReferencedSheetClaim` | `"blocked_truthful_boundary"` | да | | `sheetCopyClaim` | `"live_verified"` | да | | `formulaReferenceDeleteRewriteClaim` | `"no"` | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "delete_sheet_bounded",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "requestedBackend": "native-desktop"
}
```
 ## move\_sheet\_to\_workbook\_bounded [Заголовок раздела «move\_sheet\_to\_workbook\_bounded»](#move_sheet_to_workbook_bounded) Перемещает sheet to workbook bounded. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"move_sheet_to_workbook_bounded"` | да | | `sourceSubsetId` | string | да | | `targetSubsetId` | string | да | | `sourceSheetKey` | string | да | | name | string | да | | `sourceViewport` | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `targetViewport` | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · move\_sheet\_to\_workbook\_bounded** | Поле | Тип TypeScript | Обяз. | | ---------------------------------- | ----------------------------------------------------------------------------------------------- | ----- | | operation | `"move_sheet_to_workbook_bounded"` | да | | `sourceSubsetId` | string | да | | `targetSubsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | `targetDelta` | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `sourceDelta` | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `sourceSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `movedSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sourceActiveSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sourceSheetCount` | number | да | | `sourceWorkbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | `sourceGeometry` | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `sourceRecalcNeeded` | boolean | да | | `sourceViewport` | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `sourcePreviewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `sourceLayoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) \| null | нет | | `targetActiveSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `targetSheetCount` | number | да | | `targetWorkbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | `targetGeometry` | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `targetRecalcNeeded` | boolean | да | | `targetViewport` | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `targetPreviewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `targetLayoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) \| null | нет | | `sheetMoveClaim` | `"live_verified"` | да | | `moveScope` | `"bounded_cross_workbook_unreferenced_sheet_cell_formula_style_merge_layout"` | да | | `sourceSheetRemoved` | true | да | | `targetSheetIdentityNew` | true | да | | `movedSheetValuesPreserved` | true | да | | `formulaCopyClaim` | `"live_verified"` | да | | `formulaCopyScope` | `"same_sheet_formula_text_and_cached_value_preserved"` | да | | `styleCopyClaim` | `"live_verified"` | да | | `styleCopyScope` | `"existing_target_workbook_style_indexes_preserved"` | да | | `mergeLayoutCopyClaim` | `"live_verified"` | да | | `mergeLayoutCopyScope` | `"row_column_geometry_merges_and_freeze_preserved"` | да | | `formulaReferenceMoveRewriteClaim` | `"no"` | да | | `pqOutputTargetCopyClaim` | `"no"` | да | | `vbaModuleCopyClaim` | `"no"` | да | | `broadWorkbookCloneClaim` | `"no"` | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "move_sheet_to_workbook_bounded",
  "sourceSubsetId": "<string>",
  "targetSubsetId": "<string>",
  "sourceSheetKey": "<string>",
  "name": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## redo\_sheet\_lifecycle\_bounded [Заголовок раздела «redo\_sheet\_lifecycle\_bounded»](#redo_sheet_lifecycle_bounded) Повторяет sheet lifecycle bounded. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"redo_sheet_lifecycle_bounded"` | да | | `subsetId` | string | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · redo\_sheet\_lifecycle\_bounded** | Поле | Тип TypeScript | Обяз. | | ------------------------- | ----------------------------------------------------------------------------------------------- | ----- | | operation | `"redo_sheet_lifecycle_bounded"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | action | string | да | | `sheetName` | string | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) \| null | нет | | `sheetLifecycleRedoClaim` | `"live_verified"` | да | | `redoScope` | `"last_undone_current_workbook_sheet_move_or_copy_snapshot_current_session"` | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "redo_sheet_lifecycle_bounded",
  "subsetId": "<subsetId>",
  "requestedBackend": "native-desktop"
}
```
 ## rename\_sheet\_bounded [Заголовок раздела «rename\_sheet\_bounded»](#rename_sheet_bounded) Переименовывает sheet bounded. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"rename_sheet_bounded"` | да | | `subsetId` | string | да | | `sheetKey` | string | да | | `newName` | string | да | | `expectedRevision` | number \| null | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · rename\_sheet\_bounded** | Поле | Тип TypeScript | Обяз. | | --------------------------------- | --------------------------------------------------------------------------------------------------- | ----- | | operation | `"rename_sheet_bounded"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `renamedSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) \| null | нет | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `sheetRenameClaim` | `"live_verified"` | да | | `formulaReferenceAutoUpdateClaim` | `"live_verified"` | да | | `formulaReferenceBehavior` | `"updated_truthfully"` | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "rename_sheet_bounded",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "newName": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## reorder\_sheet\_bounded [Заголовок раздела «reorder\_sheet\_bounded»](#reorder_sheet_bounded) Меняет порядок sheet bounded. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"reorder_sheet_bounded"` | да | | `subsetId` | string | да | | `sheetKey` | string | да | | `targetIndex` | number | да | | `expectedRevision` | number \| null | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · reorder\_sheet\_bounded** | Поле | Тип TypeScript | Обяз. | | -------------------------------------- | --------------------------------------------------------------------------------------------------- | ----- | | operation | `"reorder_sheet_bounded"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `movedSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `previousIndex` | number | да | | `targetIndex` | number | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) \| null | нет | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `sheetReorderClaim` | `"live_verified"` | да | | `reorderScope` | `"same_workbook_sheet_order_only"` | да | | `sheetIdentityPreservedAfterReorder` | true | да | | `formulaReferencePositionRewriteClaim` | `"no"` | да | | `formulaReferencesRemainIdentityBased` | true | да | | `sheetCopyClaim` | `"live_verified"` | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "reorder_sheet_bounded",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "targetIndex": 0,
  "requestedBackend": "native-desktop"
}
```
 ## set\_sheet\_code\_name\_bounded [Заголовок раздела «set\_sheet\_code\_name\_bounded»](#set_sheet_code_name_bounded) Устанавливает sheet code name bounded. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"set_sheet_code_name_bounded"` | да | | `subsetId` | string | да | | `sheetKey` | string | да | | `codeName` | string | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · set\_sheet\_code\_name\_bounded** | Поле | Тип TypeScript | Обяз. | | -------------------- | --------------------------------------------------------------------------------------------------- | ----- | | operation | `"set_sheet_code_name_bounded"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `changedSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `previousCodeName` | string \| null | да | | `codeName` | string | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) \| null | нет | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `sheetCodeNameClaim` | `"live_verified"` | да | | `codeNameScope` | `"same_workbook_worksheet_sheetPr_codeName"` | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "set_sheet_code_name_bounded",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "codeName": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## set\_sheet\_right\_to\_left\_bounded [Заголовок раздела «set\_sheet\_right\_to\_left\_bounded»](#set_sheet_right_to_left_bounded) Устанавливает sheet right to left bounded. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"set_sheet_right_to_left_bounded"` | да | | `subsetId` | string | да | | `sheetKey` | string | да | | `rightToLeft` | boolean | да | | `expectedRevision` | number \| null | нет | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · set\_sheet\_right\_to\_left\_bounded** | Поле | Тип TypeScript | Обяз. | | ----------------------- | --------------------------------------------------------------------------------------------------- | ----- | | operation | `"set_sheet_right_to_left_bounded"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `changedSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `previousRightToLeft` | boolean \| null | да | | `rightToLeft` | boolean | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) \| null | нет | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `sheetRightToLeftClaim` | `"live_verified"` | да | | `rightToLeftScope` | `"same_workbook_worksheet_sheetView_rightToLeft"` | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "set_sheet_right_to_left_bounded",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "rightToLeft": false,
  "requestedBackend": "native-desktop"
}
```
 ## set\_sheet\_tab\_color\_bounded [Заголовок раздела «set\_sheet\_tab\_color\_bounded»](#set_sheet_tab_color_bounded) Устанавливает sheet tab color bounded. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"set_sheet_tab_color_bounded"` | да | | `subsetId` | string | да | | `sheetKey` | string | да | | rgb | string \| null | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · set\_sheet\_tab\_color\_bounded** | Поле | Тип TypeScript | Обяз. | | --------------------- | --------------------------------------------------------------------------------------------------- | ----- | | operation | `"set_sheet_tab_color_bounded"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `changedSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `previousTabColorRgb` | string \| null | да | | `tabColorRgb` | string \| null | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) \| null | нет | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `sheetTabColorClaim` | `"live_verified"` | да | | `tabColorScope` | `"same_workbook_worksheet_sheetPr_tabColor_rgb"` | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "set_sheet_tab_color_bounded",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "rgb": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## set\_sheet\_visibility\_bounded [Заголовок раздела «set\_sheet\_visibility\_bounded»](#set_sheet_visibility_bounded) Устанавливает sheet visibility bounded. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ----------------------------------------------------------------------------------------- | ----- | | operation | `"set_sheet_visibility_bounded"` | да | | `subsetId` | string | да | | `sheetKey` | string | да | | `visibilityState` | [ContractSheetVisibilityState](/reference/f1/types-session/#contractsheetvisibilitystate) | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · set\_sheet\_visibility\_bounded** | Поле | Тип TypeScript | Обяз. | | --------------------------- | --------------------------------------------------------------------------------------------------- | ----- | | operation | `"set_sheet_visibility_bounded"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `changedSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `previousVisibilityState` | [ContractSheetVisibilityState](/reference/f1/types-session/#contractsheetvisibilitystate) | да | | `visibilityState` | [ContractSheetVisibilityState](/reference/f1/types-session/#contractsheetvisibilitystate) | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) \| null | нет | | `workbookHistory` | [ContractWorkbookHistoryProjection](/reference/f1/types-session/#contractworkbookhistoryprojection) | да | | `sheetVisibilityClaim` | `"live_verified"` | да | | `visibilityScope` | `"same_workbook_visible_hidden_very_hidden"` | да | | `veryHiddenClaim` | `"live_verified"` | да | | `lastVisibleSheetHideClaim` | `"blocked_truthful_boundary"` | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "set_sheet_visibility_bounded",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "visibilityState": "<ContractSheetVisibilityState>",
  "requestedBackend": "native-desktop"
}
```
 ## undo\_delete\_sheet\_bounded [Заголовок раздела «undo\_delete\_sheet\_bounded»](#undo_delete_sheet_bounded) Отменяет delete sheet bounded. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"undo_delete_sheet_bounded"` | да | | `subsetId` | string | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · undo\_delete\_sheet\_bounded** | Поле | Тип TypeScript | Обяз. | | ------------------------------------ | ----------------------------------------------------------------------------------------------- | ----- | | operation | `"undo_delete_sheet_bounded"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `restoredSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `restoredIndex` | number | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) \| null | нет | | `sheetUndoDeleteClaim` | `"live_verified"` | да | | `undoDeleteScope` | `"last_unreferenced_bounded_sheet_current_session"` | да | | `undoDeletePersistenceClaim` | `"save_reopen_after_restore_live"` | да | | `formulaReferenceDeleteRewriteClaim` | `"no"` | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "undo_delete_sheet_bounded",
  "subsetId": "<subsetId>",
  "requestedBackend": "native-desktop"
}
```
 ## undo\_sheet\_lifecycle\_bounded [Заголовок раздела «undo\_sheet\_lifecycle\_bounded»](#undo_sheet_lifecycle_bounded) Отменяет sheet lifecycle bounded. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"undo_sheet_lifecycle_bounded"` | да | | `subsetId` | string | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · undo\_sheet\_lifecycle\_bounded** | Поле | Тип TypeScript | Обяз. | | ------------------------- | ----------------------------------------------------------------------------------------------- | ----- | | operation | `"undo_sheet_lifecycle_bounded"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | `supportedSubset` | string | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | action | string | да | | `sheetName` | string | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | `sheetCount` | number | да | | `workbookSheets` | [ContractWorkbookSheetMeta](/reference/f1/types-session/#contractworkbooksheetmeta)\[] | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | | `layoutMetrics` | [ContractLayoutMetricsSubset](/reference/f1/types-session/#contractlayoutmetricssubset) \| null | нет | | `sheetLifecycleUndoClaim` | `"live_verified"` | да | | `undoScope` | `"last_current_workbook_sheet_move_or_copy_snapshot_current_session"` | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "undo_sheet_lifecycle_bounded",
  "subsetId": "<subsetId>",
  "requestedBackend": "native-desktop"
}
```

# Транспорт и формат сообщений F1

> Формат запроса и ответа, выбор среды выполнения и обработка отказов.

Процессор запускается командой `compute_contract_cli --session`. После приветственной строки он принимает по одному запросу JSON в строке и отвечает одной строкой на каждый. В браузере используется тот же формат — через вызов сеанса в WebAssembly. 
```bash
# путь внутри установленного приложения — см. «Установка F1»
"$F1_CLI" --session
```
 Общие поля запроса | Поле | Тип TypeScript | Обяз. | Что это | | ------------------ | ------------------------------------------------------------ | ----- | ----------------------------------------------------------------------------------------------------------------------------------- | | `operation` | `ComputeRequest["operation"]` | да | Имя операции; по нему ядро выбирает, что делать. | | `requestedBackend` | `"wasm"` \| `"native-desktop"` \| `"service-host"` \| `null` | нет | Где вы просите выполнить запрос. | | `requestId` | `string` | нет | Ваш номер запроса. Ядро возвращает его в ответе слово в слово — так ответ связывается с запросом по имени, а не по порядку прихода. | Ответ при успехе — `ComputeSuccessEnvelope` | Поле | Тип TypeScript | Обяз. | Что это | | ------------------ | -------------------------------------------- | ----- | ------------------------------------------------------------------------------------- | | `ok` | `true` | да | Запрос выполнен. | | `requestId` | `string` | нет | Тот же номер, что вы прислали. | | `requestedBackend` | `ComputeBackendKind` | да | Где вы просили выполнить. | | `backendUsed` | `ComputeBackendKind` | да | Где выполнено на самом деле. | | `fallbackUsed` | `boolean` | да | `true`, если запрошенная среда оказалась недоступна и ядро выполнило запрос в другой. | | `warnings` | `ComputeWarning[]` | да | Предупреждения: на успех не влияют, но их стоит показать или записать. | | `responsiveRecalc` | `ContractResponsiveRecalcSnapshot` \| `null` | нет | Состояние фонового пересчёта на момент ответа, если он включён. | | `payload` | `ComputeResponsePayload` | да | Результат самой операции; его состав у каждой операции свой. | Ответ при отказе — `ComputeErrorEnvelope` | Поле | Тип TypeScript | Обяз. | Что это | | ---------------------- | -------------------------------------------------- | ----- | ------------------------------------------------------------------------------------- | | `ok` | `false` | да | Запрос отклонён; книга не изменилась. | | `requestId` | `string` | нет | Тот же номер, что вы прислали. | | `requestedBackend` | `ComputeBackendKind` | да | Где вы просили выполнить. | | `backendUsed` | `ComputeBackendKind` | да | Где выполнено на самом деле. | | `fallbackUsed` | `boolean` | да | `true`, если запрошенная среда оказалась недоступна и ядро выполнило запрос в другой. | | `warnings` | `ComputeWarning[]` | да | Предупреждения: на успех не влияют, но их стоит показать или записать. | | `code` | `string` | да | Код отказа — устойчивая строка, по которой отказ различают в коде. | | `message` | `string` | да | Пояснение словами. | | `details` | `string` \| `null` | нет | Подробности, если ядру есть что добавить. | | `dataValidationSource` | `ContractDataValidationSourceValidation` \| `null` | нет | Заполняется, когда отказ вызван проверкой данных: какое поле не принято и почему. | | `calculationStatus` | `ContractCalculationStatus` \| `null` | нет | Состояние вычислений, если отказ с ним связан. |

# Типы: ячейки и диапазоны

> Определения типов Compute Contract — адресация, содержимое, буфер обмена, поиск, сортировка и история правок. Имён: 22.

Определения имён из колонки «Тип TypeScript» на страницах операций. Другие темы словаря: [сеанс, книга и листы](/reference/f1/types-session/) · **ячейки и диапазоны** · [формулы и вычисления](/reference/f1/types-formulas/) · [форматирование](/reference/f1/types-format/) · [данные и объекты листа](/reference/f1/types-data/) · [сводные таблицы](/reference/f1/types-pivot/) · [диаграммы и графика](/reference/f1/types-charts/) · [печать и разметка страницы](/reference/f1/types-print/) · [Power Query](/reference/f1/types-powerquery/) · [VBA и макросы](/reference/f1/types-vba/) · [защита и рецензирование](/reference/f1/types-protection/) · [общие и служебные](/reference/f1/types-common/). **Типы на этой странице — 22** * [`CellAnchor`](#cellanchor) * [`CellInputEdit`](#cellinputedit) * [`CellRange`](#cellrange) * [`CellRect`](#cellrect) * [`ContractCellDetails`](#contractcelldetails) * [`ContractEntityCellMetadata`](#contractentitycellmetadata) * [`ContractFindIndexStats`](#contractfindindexstats) * [`ContractFindLookIn`](#contractfindlookin) * [`ContractFindMatch`](#contractfindmatch) * [`ContractFindScope`](#contractfindscope) * [`ContractFindSearchOrder`](#contractfindsearchorder) * [`ContractFormControlLinkedCellWrite`](#contractformcontrollinkedcellwrite) * [`ContractObjectAnchorCell`](#contractobjectanchorcell) * [`ContractOpenDocumentReplacementRange`](#contractopendocumentreplacementrange) * [`ContractParameterNumericRange`](#contractparameternumericrange) * [`ContractPreviewCell`](#contractpreviewcell) * [`ContractWhatIfCellRef`](#contractwhatifcellref) * [`ContractXlsxCellCopyPatch`](#contractxlsxcellcopypatch) * [`ContractXlsxCellShiftDirection`](#contractxlsxcellshiftdirection) * [`ContractXlsxCellShiftPatch`](#contractxlsxcellshiftpatch) * [`DeltaSummary`](#deltasummary) * [`SourceCellDescriptor`](#sourcecelldescriptor) ### CellAnchor [Заголовок раздела «CellAnchor»](#cellanchor) 
```ts
interface CellAnchor {
  row: number;
  col: number;
}
```
 ### CellInputEdit [Заголовок раздела «CellInputEdit»](#cellinputedit) 
```ts
type CellInputEdit =
  | { inputKind: "sheet-protection"; sheetKey: string; row: number; col: number; protected: boolean; }
  | { inputKind: "fill-series";
    sheetKey: string;
    row: number;
    col: number;
    rowEnd: number;
    colEnd: number;
  axis: "rows"
  | "columns"; seriesType:
  | "linear"
  | "growth"
  | "date"
  | "autofill"
  | "fill-down"
  | "fill-up"
  | "fill-left"
  | "fill-right"; dateUnit: "day"
  | "weekday"
  | "month"
  | "year"; stepValue: string; stopValue?: string
  | null; }
  | { inputKind: "drag-fill";
    sheetKey: string;
    row: number;
    col: number;
    rowEnd: number;
    colEnd: number;
    sourceRow: number;
    sourceCol: number;
    sourceRowEnd: number;
    sourceColEnd: number;
  axis: "rows"
  | "columns"; }
  | { inputKind: "prepared-cell";
    sheetKey: string;
    row: number;
    col: number;
    raw: string;
    display: string;
  formula?: string
  | null; cellType?: string
  | null; styleIndex?: number
  | null; richTextRuns?: ContractRichTextRun[]; }
  | { inputKind: "raw-user-input";
    sheetKey: string;
    row: number;
    col: number;
    input: string;
    locale?: string;
  }
  | { inputKind: "number"; sheetKey: string; row: number; col: number; input: string; }
  | { inputKind: "text"; sheetKey: string; row: number; col: number; input: string; }
  | { inputKind: "empty-string"; sheetKey: string; row: number; col: number; }
  | { inputKind: "clear-to-blank"; sheetKey: string; row: number; col: number; }
  | { inputKind: "clear-formatting"; sheetKey: string; row: number; col: number; }
  | { inputKind: "formula"; sheetKey: string; row: number; col: number; input: string; }
  | { inputKind: "legacy-array-formula";
    sheetKey: string;
    row: number;
    col: number;
    input: string;
    refRange: string;
  }
  | { inputKind: "formatting";
    sheetKey: string;
    row: number;
    col: number;
    fillColor?: string;
    fontColor?: string;
    numberFormat?: string;
    fontFamily?: string;
    fontSize?: number;
    bold?: boolean;
    italic?: boolean;
    fontVerticalAlign?: ContractPreviewFontVerticalAlign;
    underlineKind?: ContractPreviewUnderlineKind;
    underline?: boolean;
    strike?: boolean;
  horizontalAlign?: string
  | null; verticalAlign?: string
  | null; wrapText?: boolean; shrinkToFit?: boolean; locked?: boolean; hidden?: boolean; diagonalUp?: boolean; diagonalDown?: boolean; borderPreset?:
  | "all"
  | "none"
  | "bottom"
  | "top"
  | "left"
  | "right"
  | "outside-thin-all"
  | "outside-thin-top"
  | "outside-thin-bottom"
  | "outside-thin-left"
  | "outside-thin-right"
  | "outside-thin-top-bottom"
  | "outside-thin-top-left"
  | "outside-thin-top-right"
  | "outside-thin-bottom-left"
  | "outside-thin-bottom-right"
  | "outside-thin-left-right"
  | "outside-thin-top-bottom-left"
  | "outside-thin-top-bottom-right"
  | "outside-thin-top-left-right"
  | "outside-thin-bottom-left-right"
  | "outside-thick-all"
  | "outside-thick-top"
  | "outside-thick-bottom"
  | "outside-thick-left"
  | "outside-thick-right"
  | "outside-thick-top-bottom"
  | "outside-thick-top-left"
  | "outside-thick-top-right"
  | "outside-thick-bottom-left"
  | "outside-thick-bottom-right"
  | "outside-thick-left-right"
  | "outside-thick-top-bottom-left"
  | "outside-thick-top-bottom-right"
  | "outside-thick-top-left-right"
  | "outside-thick-bottom-left-right"
  | "outside-double-all"
  | "outside-double-top"
  | "outside-double-bottom"
  | "outside-double-left"
  | "outside-double-right"
  | "outside-double-top-bottom"
  | "outside-double-top-left"
  | "outside-double-top-right"
  | "outside-double-bottom-left"
  | "outside-double-bottom-right"
  | "outside-double-left-right"
  | "outside-double-top-bottom-left"
  | "outside-double-top-bottom-right"
  | "outside-double-top-left-right"
  | "outside-double-bottom-left-right"
  | "green-all"
  | `border-line-${string}`
  | `border-color-${string}`; textRotation?: number; indent?: number; };
```
 ### CellRange [Заголовок раздела «CellRange»](#cellrange) 
```ts
interface CellRange {
  sheetKey: string;
  rowStart: number;
  rowEnd: number;
  colStart: number;
  colEnd: number;
}
```
 ### CellRect [Заголовок раздела «CellRect»](#cellrect) 
```ts
interface CellRect {
  top: number;
  left: number;
  rows: number;
  cols: number;
}
```
 ### ContractCellDetails [Заголовок раздела «ContractCellDetails»](#contractcelldetails) 
```ts
interface ContractCellDetails {
  cellKey: string;
  address: string;
  displayValue: string | null;
  editText: string | null;
  calculationTrust?: ContractCalculationTrust | null;
}
```
 ### ContractEntityCellMetadata [Заголовок раздела «ContractEntityCellMetadata»](#contractentitycellmetadata) 
```ts
interface ContractEntityCellMetadata {
  cellKey: string;
  stableEntityId: string;
  kind: ContractEntityDataTypeKind;
  state: ContractEntityResolutionState;
  provider: ContractEntityProviderIdentity;
  originalText: string;
  displayText: string;
  fields: ContractEntityFieldValue[];
}
```
 ### ContractFindIndexStats [Заголовок раздела «ContractFindIndexStats»](#contractfindindexstats) 
```ts
interface ContractFindIndexStats {
  cacheHit: boolean;
  indexedCellCount: number;
  indexedBytes: number;
  queryCacheBytes: number;
  indexBuildCount: number;
  workbookRevision: number;
  invalidationCount: number;
  lastInvalidatedCellCount: number;
  lastInvalidatedRangeCount: number;
  lastInvalidatedSheetCount: number;
  lastReconciledQueryCount: number;
  fullResetCount: number;
}
```
 ### ContractFindLookIn [Заголовок раздела «ContractFindLookIn»](#contractfindlookin) 
```ts
type ContractFindLookIn = "values" | "formulas";
```
 ### ContractFindMatch [Заголовок раздела «ContractFindMatch»](#contractfindmatch) 
```ts
interface ContractFindMatch {
  cellKey: string;
  sheetName: string;
  address: string;
  value: string;
}
```
 ### ContractFindScope [Заголовок раздела «ContractFindScope»](#contractfindscope) 
```ts
type ContractFindScope = "active_sheet" | "workbook" | { selection: { range: CellRange } };
```
 ### ContractFindSearchOrder [Заголовок раздела «ContractFindSearchOrder»](#contractfindsearchorder) 
```ts
type ContractFindSearchOrder = "by_rows" | "by_columns";
```
 ### ContractFormControlLinkedCellWrite [Заголовок раздела «ContractFormControlLinkedCellWrite»](#contractformcontrollinkedcellwrite) 
```ts
interface ContractFormControlLinkedCellWrite {
  sheetKey: string;
  row: number;
  col: number;
  display: string;
}
```
 ### ContractObjectAnchorCell [Заголовок раздела «ContractObjectAnchorCell»](#contractobjectanchorcell) 
```ts
interface ContractObjectAnchorCell {
  row: number;
  col: number;
  dxEmu: number;
  dyEmu: number;
}
```
 ### ContractOpenDocumentReplacementRange [Заголовок раздела «ContractOpenDocumentReplacementRange»](#contractopendocumentreplacementrange) 
```ts
interface ContractOpenDocumentReplacementRange {
  rowStart: number;
  rowEnd: number;
  colStart: number;
  colEnd: number;
}
```
 ### ContractParameterNumericRange [Заголовок раздела «ContractParameterNumericRange»](#contractparameternumericrange) 
```ts
interface ContractParameterNumericRange {
  min: number;
  max: number;
}
```
 ### ContractPreviewCell [Заголовок раздела «ContractPreviewCell»](#contractpreviewcell) 
```ts
interface ContractPreviewCell {
  row: number;
  col: number;
  value: string;
  valueKind: ContractPreviewValueKind;


  scalarValueKind?: "number" | "text" | "date";
  delimitedValueKind?: "number" | "text" | "date" | "emptyString";


  delimitedSemanticValue?: string;
  rawFormula?: string;


  selectionAllowed?: boolean;
  hyperlink?: ContractPreviewHyperlink | null;
  booleanValue?: boolean | null;
  errorCode?: ContractErrorCode | null;
  formatting?: ContractPreviewFormatting | null;
  richTextRuns?: ContractRichTextRun[] | null;
}
```
 ### ContractWhatIfCellRef [Заголовок раздела «ContractWhatIfCellRef»](#contractwhatifcellref) 
```ts
interface ContractWhatIfCellRef {
  sheetKey: string;
  row: number;
  col: number;
}
```
 ### ContractXlsxCellCopyPatch [Заголовок раздела «ContractXlsxCellCopyPatch»](#contractxlsxcellcopypatch) 
```ts
interface ContractXlsxCellCopyPatch {
  activeSheetPath: string;
  sourceCellRef: string;
  targetCellRef: string;
}
```
 ### ContractXlsxCellShiftDirection [Заголовок раздела «ContractXlsxCellShiftDirection»](#contractxlsxcellshiftdirection) 
```ts
type ContractXlsxCellShiftDirection = | "insert-shift-right" | "insert-shift-down" | "delete-shift-left" | "delete-shift-up";
```
 ### ContractXlsxCellShiftPatch [Заголовок раздела «ContractXlsxCellShiftPatch»](#contractxlsxcellshiftpatch) 
```ts
interface ContractXlsxCellShiftPatch {
  activeSheetPath: string;
  rowStart: number;
  rowEnd: number;
  colStart: number;
  colEnd: number;
  direction: ContractXlsxCellShiftDirection;
}
```
 ### DeltaSummary [Заголовок раздела «DeltaSummary»](#deltasummary) 
```ts
interface DeltaSummary {
  deltaId: string;
  changedCellCount: number;
}
```
 ### SourceCellDescriptor [Заголовок раздела «SourceCellDescriptor»](#sourcecelldescriptor) 
```ts
type SourceCellDescriptor =
  | { kind: "blank" }
  | { kind: "text"; value: string }
  | { kind: "number"; value: number }
  | { kind: "integer"; value: number }
  | { kind: "logical"; value: boolean }
  | { kind: "date"; year: number; month: number; day: number }
  | { kind: "error"; code: string };
```

# Типы: диаграммы и графика

> Определения типов Compute Contract — диаграммы, спарклайны, фигуры и изображения. Имён: 92.

Определения имён из колонки «Тип TypeScript» на страницах операций. Другие темы словаря: [сеанс, книга и листы](/reference/f1/types-session/) · [ячейки и диапазоны](/reference/f1/types-cells/) · [формулы и вычисления](/reference/f1/types-formulas/) · [форматирование](/reference/f1/types-format/) · [данные и объекты листа](/reference/f1/types-data/) · [сводные таблицы](/reference/f1/types-pivot/) · **диаграммы и графика** · [печать и разметка страницы](/reference/f1/types-print/) · [Power Query](/reference/f1/types-powerquery/) · [VBA и макросы](/reference/f1/types-vba/) · [защита и рецензирование](/reference/f1/types-protection/) · [общие и служебные](/reference/f1/types-common/). ### ContractChartAreaFormatting [Заголовок раздела «ContractChartAreaFormatting»](#contractchartareaformatting) 
```ts
interface ContractChartAreaFormatting {
  style: ContractChartShapeStyle;
  layout?: ContractChartManualLayout | null;
}
```
 ### ContractChartAxisFormatting [Заголовок раздела «ContractChartAxisFormatting»](#contractchartaxisformatting) 
```ts
interface ContractChartAxisFormatting {
  axis: ContractChartAxisId;
  title?: string | null;
  visible: boolean;
  minimum?: number | null;
  maximum?: number | null;
  majorUnit?: number | null;
  minorUnit?: number | null;
  numberFormat?: string | null;
  logBase?: number | null;
  showMajorGridlines: boolean;
  showMinorGridlines: boolean;
}
```
 ### ContractChartAxisId [Заголовок раздела «ContractChartAxisId»](#contractchartaxisid) 
```ts
type ContractChartAxisId = | "primary-category" | "primary-value" | "secondary-category" | "secondary-value";
```
 ### ContractChartBoundedFamily [Заголовок раздела «ContractChartBoundedFamily»](#contractchartboundedfamily) 
```ts
type ContractChartBoundedFamily =
  | "bubble"
  | "radar"
  | "radar-markers"
  | "radar-filled"
  | "surface"
  | "wireframe-surface"
  | "contour"
  | "wireframe-contour"
  | "stock-hlc"
  | "stock-ohlc"
  | "stock-volume-hlc"
  | "stock-volume-ohlc"
  | "histogram"
  | "pareto"
  | "waterfall"
  | "funnel"
  | "box-whisker"
  | "treemap"
  | "sunburst"
  | "map";
```
 ### ContractChartBoxWhiskerSettings [Заголовок раздела «ContractChartBoxWhiskerSettings»](#contractchartboxwhiskersettings) 
```ts
interface ContractChartBoxWhiskerSettings {
  quartileMethod: ContractChartQuartileMethod;
  showMeanLine: boolean;
  showMeanMarker: boolean;
  showInnerPoints: boolean;
  showOutlierPoints: boolean;
  readonly summaries: ReadonlyArray<{
    seriesIndex: number;
    firstQuartile: number;
    median: number;
    thirdQuartile: number;
    mean: number;
    whiskerMinimum: number;
    whiskerMaximum: number;
    outliers: number[];
  }>;
}
```
 ### ContractChartBubblePointIdentity [Заголовок раздела «ContractChartBubblePointIdentity»](#contractchartbubblepointidentity) 
```ts
interface ContractChartBubblePointIdentity {
  pointIndex: number;
  size: number;
}
```
 ### ContractChartCapabilityRefusal [Заголовок раздела «ContractChartCapabilityRefusal»](#contractchartcapabilityrefusal) 
```ts
type ContractChartCapabilityRefusal =
  | "unsupported-chart-type"
  | "unsupported-series-type"
  | "unsupported-three-d"
  | "unsupported-stock"
  | "unsupported-surface"
  | "incompatible-combination";
```
 ### ContractChartCustomErrorBarRange [Заголовок раздела «ContractChartCustomErrorBarRange»](#contractchartcustomerrorbarrange) 
```ts
interface ContractChartCustomErrorBarRange {
  formula: string;
  pointCount: number;
}
```
 ### ContractChartDataLabelPosition [Заголовок раздела «ContractChartDataLabelPosition»](#contractchartdatalabelposition) 
```ts
type ContractChartDataLabelPosition =
  | "best-fit"
  | "center"
  | "inside-end"
  | "inside-base"
  | "outside-end"
  | "left"
  | "right"
  | "above"
  | "below";
```
 ### ContractChartDataLabelsFormatting [Заголовок раздела «ContractChartDataLabelsFormatting»](#contractchartdatalabelsformatting) 
```ts
interface ContractChartDataLabelsFormatting {
  visible: boolean;
  showValue: boolean;
  showCategoryName: boolean;
  showSeriesName: boolean;
  showLegendKey: boolean;
  showPercentage: boolean;
  separator?: string | null;
  numberFormat?: string | null;
  position?: ContractChartDataLabelPosition | null;
  showLeaderLines: boolean;
}
```
 ### ContractChartDataTableFormatting [Заголовок раздела «ContractChartDataTableFormatting»](#contractchartdatatableformatting) 
```ts
interface ContractChartDataTableFormatting {
  visible: boolean;
  showLegendKeys: boolean;
  showHorizontalBorder: boolean;
  showVerticalBorder: boolean;
  showOutlineBorder: boolean;
  style: ContractChartShapeStyle;
}
```
 ### ContractChartErrorBarDirection [Заголовок раздела «ContractChartErrorBarDirection»](#contractcharterrorbardirection) 
```ts
type ContractChartErrorBarDirection = "x" | "y";
```
 ### ContractChartErrorBarEndStyle [Заголовок раздела «ContractChartErrorBarEndStyle»](#contractcharterrorbarendstyle) 
```ts
type ContractChartErrorBarEndStyle = "both" | "plus" | "minus";
```
 ### ContractChartErrorBarKind [Заголовок раздела «ContractChartErrorBarKind»](#contractcharterrorbarkind) 
```ts
type ContractChartErrorBarKind = "fixed" | "percentage" | "standard-deviation" | "standard-error" | "custom";
```
 ### ContractChartErrorBarsFormatting [Заголовок раздела «ContractChartErrorBarsFormatting»](#contractcharterrorbarsformatting) 
```ts
interface ContractChartErrorBarsFormatting {
  direction: ContractChartErrorBarDirection;
  kind: ContractChartErrorBarKind;
  endStyle: ContractChartErrorBarEndStyle;
  noEndCap: boolean;
  value?: number | null;
  plusRange?: ContractChartCustomErrorBarRange | null;
  minusRange?: ContractChartCustomErrorBarRange | null;
}
```
 ### ContractChartFeatureCapability [Заголовок раздела «ContractChartFeatureCapability»](#contractchartfeaturecapability) 
```ts
interface ContractChartFeatureCapability {
  supported: boolean;
  reason?: ContractChartCapabilityRefusal | null;
}
```
 ### ContractChartFormatting [Заголовок раздела «ContractChartFormatting»](#contractchartformatting) 
```ts
interface ContractChartFormatting {
  template?: ContractChartTemplateSelection | null;
  family?: ContractChartBoundedFamily | null;
  bubbleScale?: number | null;
  missingValuePolicy?: ContractChartMissingValuePolicy;
  modern?: ContractChartModernFormatting;
  surface?: ContractChartSurfaceFormatting | null;
  title?: string | null;
  legendPosition: ContractChartLegendFormatPosition;
  legendOverlay: boolean;
  dataLabels: ContractChartDataLabelsFormatting;
  dataTable?: ContractChartDataTableFormatting;


  readonly capabilities?: ContractChartFormattingCapabilities;
  chartArea: ContractChartAreaFormatting;
  plotArea: ContractChartAreaFormatting;
  axes: ContractChartAxisFormatting[];
  series: ContractChartSeriesFormatting[];
}
```
 ### ContractChartFormattingCapabilities [Заголовок раздела «ContractChartFormattingCapabilities»](#contractchartformattingcapabilities) 
```ts
interface ContractChartFormattingCapabilities {
  combo?: ContractChartFeatureCapability;
  boundedFamilies?: ContractChartFeatureCapability;
  dataTable: ContractChartFeatureCapability;
  errorBars: ContractChartSeriesErrorBarCapability[];
}
```
 ### ContractChartFunnelSettings [Заголовок раздела «ContractChartFunnelSettings»](#contractchartfunnelsettings) 
```ts
interface ContractChartFunnelSettings {
  readonly points: ReadonlyArray<{ pointIndex: number; value: number }>;
}
```
 ### ContractChartGeographyRegion [Заголовок раздела «ContractChartGeographyRegion»](#contractchartgeographyregion) 
```ts
interface ContractChartGeographyRegion {
  readonly inputLabel: string;
  readonly identity: "FRA" | "DEU" | "ITA" | "ESP" | "PRT" | "GBR";
  readonly value: number;
  readonly color: string;
}
```
 ### ContractChartGeographySettings [Заголовок раздела «ContractChartGeographySettings»](#contractchartgeographysettings) 
```ts
interface ContractChartGeographySettings {
  readonly cultureLanguage?: string | null;
  readonly cultureRegion?: string | null;
  readonly attribution?: string | null;
  readonly minimum: number;
  readonly maximum: number;
  readonly regions: ReadonlyArray<ContractChartGeographyRegion>;
}
```
 ### ContractChartHierarchyBlankPolicy [Заголовок раздела «ContractChartHierarchyBlankPolicy»](#contractcharthierarchyblankpolicy) 
```ts
type ContractChartHierarchyBlankPolicy = "zero";
```
 ### ContractChartHierarchyErrorPolicy [Заголовок раздела «ContractChartHierarchyErrorPolicy»](#contractcharthierarchyerrorpolicy) 
```ts
type ContractChartHierarchyErrorPolicy = "refuse";
```
 ### ContractChartHierarchyNode [Заголовок раздела «ContractChartHierarchyNode»](#contractcharthierarchynode) 
```ts
interface ContractChartHierarchyNode {
  readonly nodeId: string;
  readonly parentId?: string | null;
  readonly level: number;
  readonly label: string;
  readonly aggregate: number;
  readonly leafCount: number;
  readonly color: string;
}
```
 ### ContractChartHierarchySettings [Заголовок раздела «ContractChartHierarchySettings»](#contractcharthierarchysettings) 
```ts
interface ContractChartHierarchySettings {
  readonly blankPolicy: ContractChartHierarchyBlankPolicy;
  readonly errorPolicy: ContractChartHierarchyErrorPolicy;
  readonly rootAggregate: number;
  readonly nodes: ReadonlyArray<ContractChartHierarchyNode>;
}
```
 ### ContractChartHistogramBin [Заголовок раздела «ContractChartHistogramBin»](#contractcharthistogrambin) 
```ts
interface ContractChartHistogramBin {
  readonly binIndex: number;
  readonly lowerBound: number;
  readonly upperBound: number;
  readonly count: number;
  readonly cumulativePercent: number;
}
```
 ### ContractChartHistogramSettings [Заголовок раздела «ContractChartHistogramSettings»](#contractcharthistogramsettings) 
```ts
interface ContractChartHistogramSettings {
  binCount?: number | null;
  binWidth?: number | null;
  underflow?: number | null;
  overflow?: number | null;
  intervalClosed: ContractChartIntervalClosedSide;
  readonly bins: ContractChartHistogramBin[];
}
```
 ### ContractChartIntervalClosedSide [Заголовок раздела «ContractChartIntervalClosedSide»](#contractchartintervalclosedside) 
```ts
type ContractChartIntervalClosedSide = "left" | "right";
```
 ### ContractChartLegendFormatPosition [Заголовок раздела «ContractChartLegendFormatPosition»](#contractchartlegendformatposition) 
```ts
type ContractChartLegendFormatPosition = "none" | "top" | "bottom" | "left" | "right";
```
 ### ContractChartLegendPosition [Заголовок раздела «ContractChartLegendPosition»](#contractchartlegendposition) 
```ts
type ContractChartLegendPosition = "top" | "left" | "right" | "bottom" | "none";
```
 ### ContractChartLineDash [Заголовок раздела «ContractChartLineDash»](#contractchartlinedash) 
```ts
type ContractChartLineDash = "solid" | "dash" | "dot" | "dash-dot";
```
 ### ContractChartManualLayout [Заголовок раздела «ContractChartManualLayout»](#contractchartmanuallayout) 
```ts
interface ContractChartManualLayout {
  x: number;
  y: number;
  width: number;
  height: number;
}
```
 ### ContractChartMarkerFormatting [Заголовок раздела «ContractChartMarkerFormatting»](#contractchartmarkerformatting) 
```ts
interface ContractChartMarkerFormatting {
  style: ContractChartMarkerStyle;
  size: number;
  fillColor?: string | null;
  lineColor?: string | null;


  fillThemeSlot?: number | null;
  lineThemeSlot?: number | null;
}
```
 ### ContractChartMarkerStyle [Заголовок раздела «ContractChartMarkerStyle»](#contractchartmarkerstyle) 
```ts
type ContractChartMarkerStyle = "none" | "circle" | "square" | "diamond" | "triangle" | "x" | "plus";
```
 ### ContractChartMissingValuePolicy [Заголовок раздела «ContractChartMissingValuePolicy»](#contractchartmissingvaluepolicy) 
```ts
type ContractChartMissingValuePolicy = "gap" | "zero" | "connect";
```
 ### ContractChartModernFormatting [Заголовок раздела «ContractChartModernFormatting»](#contractchartmodernformatting) 
```ts
interface ContractChartModernFormatting {
  histogram?: ContractChartHistogramSettings | null;
  waterfall?: ContractChartWaterfallSettings | null;
  funnel?: ContractChartFunnelSettings | null;
  boxWhisker?: ContractChartBoxWhiskerSettings | null;
  hierarchy?: ContractChartHierarchySettings | null;
  geography?: ContractChartGeographySettings | null;
  readonly seriesIdentities: ReadonlyArray<{
    seriesIndex: number;
    uniqueId: string;
  }>;
}
```
 ### ContractChartPayload [Заголовок раздела «ContractChartPayload»](#contractchartpayload) 
```ts
interface ContractChartPayload {
  status: ContractChartStatus;
  chartType?: ContractChartType | null;
  stackMode?: ContractChartStackMode | null;
  title?: string | null;
  categoryAxisTitle?: string | null;
  valueAxisTitle?: string | null;
  stylePreset?: ContractChartStylePreset | null;
  legendPosition?: ContractChartLegendPosition | null;
  chartAreaFillColor?: string | null;
  chartAreaLineColor?: string | null;
  plotAreaFillColor?: string | null;
  plotAreaLineColor?: string | null;
  seriesFillColor?: string | null;
  firstDataPointFillColor?: string | null;
  showDataLabels?: boolean | null;
  dataLabelNumberFormat?: string | null;
  valueAxisLineColor?: string | null;
  valueAxisMinimum?: number | null;
  valueAxisMaximum?: number | null;
  valueAxisNumberFormat?: string | null;
  showGridlines?: boolean | null;
  showAxes?: boolean | null;
  showTrendline?: boolean | null;
  showErrorBars?: boolean | null;
  showSecondaryAxis?: boolean | null;
  emptyCellBehavior?: "gaps" | "zero" | "connect" | null;
  pivotSourceName?: string | null;


  pivotLayoutBounds?: ContractSheetObjectBounds | null;


  formatting?: ContractChartFormatting | null;
  series: ContractChartSeries[];
}
```
 ### ContractChartPointFormatting [Заголовок раздела «ContractChartPointFormatting»](#contractchartpointformatting) 
```ts
interface ContractChartPointFormatting {
  pointIndex: number;
  style: ContractChartShapeStyle;
  marker?: ContractChartMarkerFormatting | null;
}
```
 ### ContractChartQuartileMethod [Заголовок раздела «ContractChartQuartileMethod»](#contractchartquartilemethod) 
```ts
type ContractChartQuartileMethod = "inclusive" | "exclusive";
```
 ### ContractChartSeries [Заголовок раздела «ContractChartSeries»](#contractchartseries) 
```ts
interface ContractChartSeries {
  name?: string | null;
  nameRef?: string | null;
  categoryRef?: string | null;
  valueRef?: string | null;
  categories: string[];


  categoryHierarchy?: string[][];
  values: number[];
}
```
 ### ContractChartSeriesErrorBarCapability [Заголовок раздела «ContractChartSeriesErrorBarCapability»](#contractchartserieserrorbarcapability) 
```ts
interface ContractChartSeriesErrorBarCapability {
  seriesIndex: number;
  directions: ContractChartErrorBarDirection[];
  kinds: ContractChartErrorBarKind[];
  reason?: ContractChartCapabilityRefusal | null;
}
```
 ### ContractChartSeriesFormatting [Заголовок раздела «ContractChartSeriesFormatting»](#contractchartseriesformatting) 
```ts
interface ContractChartSeriesFormatting {
  seriesIndex: number;
  chartType?: ContractChartSeriesType | null;
  secondaryAxis: boolean;
  stockRole?: ContractChartStockSeriesRole | null;
  xRange?: string | null;
  yRange?: string | null;
  bubbleSizeRange?: string | null;
  categoryRange?: string | null;
  valueRange?: string | null;


  readonly bubblePoints?: ContractChartBubblePointIdentity[];
  style: ContractChartShapeStyle;
  marker?: ContractChartMarkerFormatting | null;
  pointOverrides: ContractChartPointFormatting[];
  trendlines: ContractChartTrendlineFormatting[];
  errorBars: ContractChartErrorBarsFormatting[];
}
```
 ### ContractChartSeriesType [Заголовок раздела «ContractChartSeriesType»](#contractchartseriestype) 
```ts
type ContractChartSeriesType = "clustered-column" | "line" | "area";
```
 ### ContractChartShapeStyle [Заголовок раздела «ContractChartShapeStyle»](#contractchartshapestyle) 
```ts
interface ContractChartShapeStyle {
  fillColor?: string | null;
  lineColor?: string | null;
  lineWidthPt?: number | null;
  lineDash?: ContractChartLineDash | null;


  fillThemeSlot?: number | null;
  lineThemeSlot?: number | null;
}
```
 ### ContractChartSheetOrientation [Заголовок раздела «ContractChartSheetOrientation»](#contractchartsheetorientation) 
```ts
type ContractChartSheetOrientation = "portrait" | "landscape";
```
 ### ContractChartSheetPageMargins [Заголовок раздела «ContractChartSheetPageMargins»](#contractchartsheetpagemargins) 
```ts
interface ContractChartSheetPageMargins {
  left: number;
  right: number;
  top: number;
  bottom: number;
  header: number;
  footer: number;
}
```
 ### ContractChartSheetPrintPreview [Заголовок раздела «ContractChartSheetPrintPreview»](#contractchartsheetprintpreview) 
```ts
interface ContractChartSheetPrintPreview {
  sheetKey: string;
  pageCount: number;
  pageWidthPoints: number;
  pageHeightPoints: number;
  contentWidthPoints: number;
  contentHeightPoints: number;
  scale: number;
  orientation: ContractChartSheetOrientation;
  printArea: boolean;
}
```
 ### ContractChartSheetPrintSettings [Заголовок раздела «ContractChartSheetPrintSettings»](#contractchartsheetprintsettings) 
```ts
interface ContractChartSheetPrintSettings {
  paperSize: number;
  orientation: ContractChartSheetOrientation;
  scale: number;
  margins: ContractChartSheetPageMargins;
  oddHeader?: string | null;
  oddFooter?: string | null;
  printArea: boolean;
}
```
 ### ContractChartStackMode [Заголовок раздела «ContractChartStackMode»](#contractchartstackmode) 
```ts
type ContractChartStackMode = "none" | "stacked" | "percentStacked";
```
 ### ContractChartStatus [Заголовок раздела «ContractChartStatus»](#contractchartstatus) 
```ts
type ContractChartStatus = | "live-readonly" | "unsupported-chart-type" | "missing-cache" | "invalid-payload";
```
 ### ContractChartStockSeriesRole [Заголовок раздела «ContractChartStockSeriesRole»](#contractchartstockseriesrole) 
```ts
type ContractChartStockSeriesRole = "volume" | "open" | "high" | "low" | "close";
```
 ### ContractChartStylePreset [Заголовок раздела «ContractChartStylePreset»](#contractchartstylepreset) 
```ts
type ContractChartStylePreset = "default" | "muted" | "monochrome" | "colorful" | "clean";
```
 ### ContractChartSurfaceFormatting [Заголовок раздела «ContractChartSurfaceFormatting»](#contractchartsurfaceformatting) 
```ts
interface ContractChartSurfaceFormatting {
  view3D: ContractChartSurfaceView3D;
  backWall: ContractChartShapeStyle;
  sideWall: ContractChartShapeStyle;
  floor: ContractChartShapeStyle;
}
```
 ### ContractChartSurfaceView3D [Заголовок раздела «ContractChartSurfaceView3D»](#contractchartsurfaceview3d) 
```ts
interface ContractChartSurfaceView3D {
  rotation: number;
  elevation: number;
  perspective: number;
}
```
 ### ContractChartTemplateSelection [Заголовок раздела «ContractChartTemplateSelection»](#contractcharttemplateselection) 
```ts
interface ContractChartTemplateSelection {
  templateId: string;
  source: ContractChartTemplateSource;
  chartStyleId: number;
  colorStyleId: number;
  theme: ContractChartThemeReference;
}
```
 ### ContractChartTemplateSource [Заголовок раздела «ContractChartTemplateSource»](#contractcharttemplatesource) 
```ts
type ContractChartTemplateSource = "built-in" | "crtx";
```
 ### ContractChartThemeColorSlot [Заголовок раздела «ContractChartThemeColorSlot»](#contractchartthemecolorslot) 
```ts
type ContractChartThemeColorSlot =
  | "dark1"
  | "light1"
  | "dark2"
  | "light2"
  | "accent1"
  | "accent2"
  | "accent3"
  | "accent4"
  | "accent5"
  | "accent6"
  | "hyperlink"
  | "followed-hyperlink";
```
 ### ContractChartThemeReference [Заголовок раздела «ContractChartThemeReference»](#contractchartthemereference) 
```ts
interface ContractChartThemeReference {
  themeId: string;
  colorSlot: ContractChartThemeColorSlot;
}
```
 ### ContractChartTrendlineFacts [Заголовок раздела «ContractChartTrendlineFacts»](#contractcharttrendlinefacts) 
```ts
interface ContractChartTrendlineFacts {
  equation?: string | null;
  rSquared?: number | null;
  coefficients: number[];
  movingAveragePoints: ContractChartTrendlinePoint[];
  sourcePointCount: number;
}
```
 ### ContractChartTrendlineFormatting [Заголовок раздела «ContractChartTrendlineFormatting»](#contractcharttrendlineformatting) 
```ts
interface ContractChartTrendlineFormatting {
  trendlineIndex: number;
  kind: ContractChartTrendlineKind;
  name?: string | null;
  polynomialOrder?: number | null;
  movingAveragePeriod?: number | null;
  displayEquation: boolean;
  displayRSquared: boolean;


  readonly facts?: ContractChartTrendlineFacts | null;
}
```
 ### ContractChartTrendlineKind [Заголовок раздела «ContractChartTrendlineKind»](#contractcharttrendlinekind) 
```ts
type ContractChartTrendlineKind = "linear" | "exponential" | "logarithmic" | "polynomial" | "moving-average";
```
 ### ContractChartTrendlinePoint [Заголовок раздела «ContractChartTrendlinePoint»](#contractcharttrendlinepoint) 
```ts
interface ContractChartTrendlinePoint {
  x: number;
  y: number;
}
```
 ### ContractChartType [Заголовок раздела «ContractChartType»](#contractcharttype) 
```ts
type ContractChartType =
  | "column"
  | "bar"
  | "line"
  | "area"
  | "pie"
  | "doughnut"
  | "scatter"
  | "combo"
  | "radar"
  | "map"
  | "waterfall"
  | "funnel"
  | "histogram"
  | "bubble"
  | "pareto"
  | "treemap"
  | "sunburst"
  | "stock"
  | "boxwhisker"
  | "scatter-smooth"
  | "scatter-smooth-line"
  | "scatter-straight"
  | "scatter-straight-line"
  | "radar-markers"
  | "radar-filled"
  | "surface"
  | "area-column"
  | "stock-hlc"
  | "stacked-column"
  | "percent-stacked-column"
  | "stacked-bar"
  | "percent-stacked-bar"
  | "stacked-line"
  | "percent-stacked-line"
  | "stacked-area"
  | "percent-stacked-area";
```
 ### ContractChartWaterfallPoint [Заголовок раздела «ContractChartWaterfallPoint»](#contractchartwaterfallpoint) 
```ts
interface ContractChartWaterfallPoint {
  readonly pointIndex: number;
  readonly value: number;
  readonly runningTotal: number;
  readonly isTotal: boolean;
}
```
 ### ContractChartWaterfallSettings [Заголовок раздела «ContractChartWaterfallSettings»](#contractchartwaterfallsettings) 
```ts
interface ContractChartWaterfallSettings {
  totalPointIndices: number[];
  showConnectorLines: boolean;
  readonly points: ContractChartWaterfallPoint[];
}
```
 ### ContractDataAnalysisChartPlan [Заголовок раздела «ContractDataAnalysisChartPlan»](#contractdataanalysischartplan) 
```ts
interface ContractDataAnalysisChartPlan {
  available: boolean;
  lifecycle: "create" | "remove";
  chartType: "column" | "line";
  title: string;
  categoryRange: CellRange;
  valueRange: CellRange;
}
```
 ### ContractDrawingObjectAction [Заголовок раздела «ContractDrawingObjectAction»](#contractdrawingobjectaction) 
```ts
type ContractDrawingObjectAction =
  | { kind: "create"; sheetId: string; creation: ContractOpenDocumentObjectCreation; }
  | { kind: "command"; sheetId: string; objectStableIds: string[]; primaryStableId?: string
  | null; command: ContractObjectSelectionPaneCommand; geometryAnchor?: ContractObjectAnchor
  | null; groupId?: string
  | null; orderedStableIds?: string[]; memberStableIds?: string[]; };
```
 ### ContractDrawingObjectImageCrop [Заголовок раздела «ContractDrawingObjectImageCrop»](#contractdrawingobjectimagecrop) 
```ts
interface ContractDrawingObjectImageCrop {
  leftPct: number;
  topPct: number;
  rightPct: number;
  bottomPct: number;
}
```
 ### ContractDrawingTextEditSemantics [Заголовок раздела «ContractDrawingTextEditSemantics»](#contractdrawingtexteditsemantics) 
```ts
interface ContractDrawingTextEditSemantics {
  sheetId: string;
  objectId: string;
  text: string;
  paragraphs: ContractTextParagraph[];
  verticalAlign?: ContractTextVerticalAlign | null;
  wrapText?: boolean | null;
  rotationDegrees?: number | null;
  marginsCm: [number | null, number | null, number | null, number | null];
}
```
 ### ContractImagePayload [Заголовок раздела «ContractImagePayload»](#contractimagepayload) 
```ts
interface ContractImagePayload {
  mimeType: string;
  dataUrl: string;
  widthPx?: number | null;
  heightPx?: number | null;
  byteCount?: number | null;
  editingStatus?:
    "live-supported" | "unsupported" | "malformed" | "oversized" | null;
  editingError?: string | null;


  svgText?: string | null;


  svgTextOriginal?: string | null;
}
```
 ### ContractOpenDocumentChartSeries [Заголовок раздела «ContractOpenDocumentChartSeries»](#contractopendocumentchartseries) 
```ts
interface ContractOpenDocumentChartSeries {
  name: string;
  categoryFormula: string;
  valueFormula: string;
  categoryCache: string[];
  valueCache: number[];
}
```
 ### ContractSparklineAction [Заголовок раздела «ContractSparklineAction»](#contractsparklineaction) 
```ts
type ContractSparklineAction =
  | { kind: "inventory" }
  | { kind: "create";
    sheetPath: string;
    sourceRange: CellRange;
    targetRow: number;
    targetCol: number;
    sparklineType: ContractSparklineType;
    style: ContractSparklineStyle;
    flags?: ContractSparklineFlags;
  }
  | { kind: "modify"; stableId: string; sourceRange?: CellRange
  | null; sparklineType?: ContractSparklineType
  | null; style?: ContractSparklineStyle
  | null; flags?: ContractSparklineFlags
  | null; }
  | { kind: "delete"; stableId: string };
```
 ### ContractSparklineFlags [Заголовок раздела «ContractSparklineFlags»](#contractsparklineflags) 
```ts
interface ContractSparklineFlags {
  showMarkers?: boolean;
  showAxis?: boolean;
  showHighPoint?: boolean;
  showLowPoint?: boolean;
  showFirstPoint?: boolean;
  showLastPoint?: boolean;
  showNegativePoints?: boolean;
}
```
 ### ContractSparklinePlanMode [Заголовок раздела «ContractSparklinePlanMode»](#contractsparklineplanmode) 
```ts
type ContractSparklinePlanMode = "inventory" | "preview" | "apply";
```
 ### ContractSparklineProjectionEntry [Заголовок раздела «ContractSparklineProjectionEntry»](#contractsparklineprojectionentry) 
```ts
interface ContractSparklineProjectionEntry {
  stableId: string;
  sheetPath: string;
  sourceRef: string;
  targetRef: string;
  targetRow: number;
  targetCol: number;
  sparklineType: ContractSparklineType;
  style: ContractSparklineStyle;
  flags: Required<ContractSparklineFlags>;
  renderText: string;
}
```
 ### ContractSparklineStyle [Заголовок раздела «ContractSparklineStyle»](#contractsparklinestyle) 
```ts
type ContractSparklineStyle = "default" | "accent" | "calm";
```
 ### ContractSparklineType [Заголовок раздела «ContractSparklineType»](#contractsparklinetype) 
```ts
type ContractSparklineType = "line" | "column" | "winLoss";
```
 ### ContractXlsxChartCreationPatch [Заголовок раздела «ContractXlsxChartCreationPatch»](#contractxlsxchartcreationpatch) 
```ts
interface ContractXlsxChartCreationPatch {
  activeSheetPath: string;
  sheetName: string;
  objectId?: string | null;
  objectName?: string | null;
  zOrder?: number | null;
  chartType: ContractChartType;
  stackMode?: ContractChartStackMode | null;
  title?: string | null;
  categoryAxisTitle?: string | null;
  valueAxisTitle?: string | null;
  stylePreset?: ContractChartStylePreset | null;
  legendPosition?: ContractChartLegendPosition | null;
  chartAreaFillColor?: string | null;
  chartAreaLineColor?: string | null;
  plotAreaFillColor?: string | null;
  plotAreaLineColor?: string | null;
  seriesFillColor?: string | null;
  firstDataPointFillColor?: string | null;
  showDataLabels?: boolean | null;
  dataLabelNumberFormat?: string | null;
  valueAxisLineColor?: string | null;
  valueAxisMinimum?: number | null;
  valueAxisMaximum?: number | null;
  valueAxisNumberFormat?: string | null;
  showGridlines?: boolean | null;
  showAxes?: boolean | null;
  showTrendline?: boolean | null;
  showErrorBars?: boolean | null;
  showSecondaryAxis?: boolean | null;
  emptyCellBehavior?: "gaps" | "zero" | "connect" | null;
  pivotSourceName?: string | null;
  from: ContractObjectAnchorCell;
  to: ContractObjectAnchorCell;
  series: ContractChartSeries[];
}
```
 ### ContractXlsxChartMutationPatch [Заголовок раздела «ContractXlsxChartMutationPatch»](#contractxlsxchartmutationpatch) 
```ts
interface ContractXlsxChartMutationPatch {
  activeSheetPath: string;
  objectId: string;
  relId: string;
  chartType: ContractChartType;
  stackMode?: ContractChartStackMode | null;
  title?: string | null;
  categoryAxisTitle?: string | null;
  valueAxisTitle?: string | null;
  stylePreset?: ContractChartStylePreset | null;
  legendPosition?: ContractChartLegendPosition | null;
  showDataLabels?: boolean | null;
  dataLabelNumberFormat?: string | null;
  valueAxisMinimum?: number | null;
  valueAxisMaximum?: number | null;
  valueAxisNumberFormat?: string | null;
  showGridlines?: boolean | null;
  showAxes?: boolean | null;
  showSecondaryAxis?: boolean | null;
  emptyCellBehavior?: "gaps" | "zero" | "connect" | null;


  refreshCaches?: boolean | null;
  series: ContractChartSeries[];
}
```
 ### ContractXlsxChartObjectMovePatch [Заголовок раздела «ContractXlsxChartObjectMovePatch»](#contractxlsxchartobjectmovepatch) 
```ts
interface ContractXlsxChartObjectMovePatch {
  activeSheetPath: string;
  objectId: string;
  relId: string;
  from: ContractObjectAnchorCell;
  ext: ContractObjectExtent;
}
```
 ### ContractXlsxChartSeriesUpdatePatch [Заголовок раздела «ContractXlsxChartSeriesUpdatePatch»](#contractxlsxchartseriesupdatepatch) 
```ts
interface ContractXlsxChartSeriesUpdatePatch {
  activeSheetPath: string;
  objectId: string;
  relId: string;
  seriesIndex: number;
  nameRef?: string | null;
  nameLiteral?: string | null;
  categoryAxisTitle?: string | null;
  valueAxisTitle?: string | null;
  categoryRef: string;
  valueRef: string;
  categories?: string[] | null;
  values?: number[] | null;
}
```
 ### ContractXlsxDrawingImageCreationPatch [Заголовок раздела «ContractXlsxDrawingImageCreationPatch»](#contractxlsxdrawingimagecreationpatch) 
```ts
interface ContractXlsxDrawingImageCreationPatch {
  activeSheetPath: string;
  sheetName: string;
  objectId: string;
  objectName?: string | null;
  mimeType: "image/png" | "image/jpeg";
  dataUrl: string;
  from: ContractObjectAnchorCell;
  ext: ContractObjectExtent;
  altText?: string | null;
  linkedSourceRange?: string | null;


  svgText?: string | null;
}
```
 ### ContractXlsxDrawingObjectDeletionPatch [Заголовок раздела «ContractXlsxDrawingObjectDeletionPatch»](#contractxlsxdrawingobjectdeletionpatch) 
```ts
interface ContractXlsxDrawingObjectDeletionPatch {
  activeSheetPath: string;
  objectId: string;
  objectFamily: "chart" | "image";
  relId: string;
}
```
 ### ContractXlsxDrawingObjectGroupMemberPatch [Заголовок раздела «ContractXlsxDrawingObjectGroupMemberPatch»](#contractxlsxdrawingobjectgroupmemberpatch) 
```ts
interface ContractXlsxDrawingObjectGroupMemberPatch {
  objectId: string;
  objectFamily: "chart" | "image";
  relId: string;
}
```
 ### ContractXlsxDrawingObjectGroupPatch [Заголовок раздела «ContractXlsxDrawingObjectGroupPatch»](#contractxlsxdrawingobjectgrouppatch) 
```ts
interface ContractXlsxDrawingObjectGroupPatch {
  activeSheetPath: string;
  groupId: string;
  groupName?: string | null;
  members: ContractXlsxDrawingObjectGroupMemberPatch[];
}
```
 ### ContractXlsxDrawingObjectImageTransformPatch [Заголовок раздела «ContractXlsxDrawingObjectImageTransformPatch»](#contractxlsxdrawingobjectimagetransformpatch) 
```ts
interface ContractXlsxDrawingObjectImageTransformPatch {
  activeSheetPath: string;
  objectId: string;
  objectFamily: "image";
  relId: string;
  rotationDeg?: number | null;
  imageCrop?: ContractDrawingObjectImageCrop | null;
  flipH?: boolean | null;
  flipV?: boolean | null;
  hidden?: boolean | null;
}
```
 ### ContractXlsxDrawingObjectMetadataPatch [Заголовок раздела «ContractXlsxDrawingObjectMetadataPatch»](#contractxlsxdrawingobjectmetadatapatch) 
```ts
interface ContractXlsxDrawingObjectMetadataPatch {
  activeSheetPath: string;
  objectId: string;
  objectFamily: "chart" | "image";
  relId: string;
  objectName?: string | null;
  altText?: string | null;
  title?: string | null;
  description?: string | null;
  decorative?: boolean | null;
  hidden?: boolean | null;
  printObject?: boolean | null;
  locksWithSheet?: boolean | null;
}
```
 ### ContractXlsxDrawingObjectMovePatch [Заголовок раздела «ContractXlsxDrawingObjectMovePatch»](#contractxlsxdrawingobjectmovepatch) 
```ts
interface ContractXlsxDrawingObjectMovePatch {
  activeSheetPath: string;
  objectId: string;
  objectFamily: "chart" | "image";
  relId: string;
  from: ContractObjectAnchorCell;
  ext: ContractObjectExtent;
}
```
 ### ContractXlsxDrawingObjectUngroupPatch [Заголовок раздела «ContractXlsxDrawingObjectUngroupPatch»](#contractxlsxdrawingobjectungrouppatch) 
```ts
interface ContractXlsxDrawingObjectUngroupPatch {
  activeSheetPath: string;
  groupId: string;
}
```
 ### ContractXlsxDrawingObjectZOrderPatch [Заголовок раздела «ContractXlsxDrawingObjectZOrderPatch»](#contractxlsxdrawingobjectzorderpatch) 
```ts
interface ContractXlsxDrawingObjectZOrderPatch {
  activeSheetPath: string;
  objectId: string;
  objectFamily: "chart" | "image";
  relId: string;
  action: "forward" | "backward" | "front" | "back";
}
```
 ### ContractXlsxShapeObjectPatch [Заголовок раздела «ContractXlsxShapeObjectPatch»](#contractxlsxshapeobjectpatch) 
```ts
interface ContractXlsxShapeObjectPatch {
  objectId: string;
  objectName?: string | null;
  altText?: string | null;
  hidden?: boolean | null;
  prst: string;


  savePrst?: string | null;
  from: ContractObjectAnchorCell;


  to?: ContractObjectAnchorCell | null;
  ext: ContractObjectExtent;
  zOrder?: number | null;
  fillHex?: string | null;


  fillOpacity?: number | null;
  gradientFill?: boolean | null;
  gradientAngle?: number | null;
  gradientColor1?: string | null;
  gradientColor2?: string | null;
  lineHex?: string | null;


  strokeOnly?: boolean | null;
  lineWidthEmu?: number | null;


  rotationDegrees?: number | null;


  textRotationDegrees?: number | null;


  adj?: number | null;


  isLine?: boolean | null;
  flipH?: boolean | null;
  flipV?: boolean | null;
  headEnd?: string | null;
  tailEnd?: string | null;


  shadowPreset?: string | 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;
  reflectionOpacity?: number | null;
  reflectionBlur?: number | null;
  reflectionDistance?: number | null;
  reflectionSize?: number | null;


  textOutlineHex?: string | null;
  textFillType?: string | null;
  textFillOpacity?: number | 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;


  bevelTopPreset?: string | null;
  bevelTopWidth?: number | null;
  bevelTopHeight?: number | null;
  bevelBottomPreset?: string | null;
  bevelBottomWidth?: number | null;
  bevelBottomHeight?: number | null;
  depthColor?: string | null;
  depth?: number | null;
  contourColor?: string | null;
  contourWidth?: number | null;
  material?: string | null;
  lightingRig?: string | null;
  lightingAngle?: number | null;
  cameraPreset?: string | null;
  rotationX?: number | null;
  rotationY?: number | null;
  rotationZ?: number | null;
  perspective?: 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;


  underline?: boolean | null;


  stCxnObjectId?: string | null;
  stCxnIdx?: number | null;
  endCxnObjectId?: string | null;
  endCxnIdx?: number | null;


  nativeNvId?: number | null;


  text?: string | null;
  paragraphs?: ContractTextParagraph[] | null;
  fontFamily?: string | null;
  fontSize?: number | null;
  bold?: boolean | null;
  italic?: boolean | null;
  textColor?: string | null;
  horizontalAlign?: ContractTextHorizontalAlign | null;
  verticalAlign?: ContractTextVerticalAlign | null;


  freeformPoints?: ReadonlyArray<{
    x: number;
    y: number;
    c1x?: number | null;
    c1y?: number | null;
    c2x?: number | null;
    c2y?: number | null;
  }> | null;
  isClosed?: boolean | null;


  rawAnchorXml?: string | null;


  geometryEdited?: boolean | null;


  adjustments?: ReadonlyArray<{ name: string; val: number }> | null;


  strokeDash?: string | null;
}
```
 ### ContractXlsxShapeSheetPatch [Заголовок раздела «ContractXlsxShapeSheetPatch»](#contractxlsxshapesheetpatch) 
```ts
interface ContractXlsxShapeSheetPatch {
  activeSheetPath: string;
  objects: ContractXlsxShapeObjectPatch[];
}
```

# Типы: общие и служебные

> Определения типов Compute Contract — всё, что не относится к одной теме: транспорт, отказы, общие перечисления. Имён: 170.

Определения имён из колонки «Тип TypeScript» на страницах операций. Другие темы словаря: [сеанс, книга и листы](/reference/f1/types-session/) · [ячейки и диапазоны](/reference/f1/types-cells/) · [формулы и вычисления](/reference/f1/types-formulas/) · [форматирование](/reference/f1/types-format/) · [данные и объекты листа](/reference/f1/types-data/) · [сводные таблицы](/reference/f1/types-pivot/) · [диаграммы и графика](/reference/f1/types-charts/) · [печать и разметка страницы](/reference/f1/types-print/) · [Power Query](/reference/f1/types-powerquery/) · [VBA и макросы](/reference/f1/types-vba/) · [защита и рецензирование](/reference/f1/types-protection/) · **общие и служебные**. ### ComputeBackendKind [Заголовок раздела «ComputeBackendKind»](#computebackendkind) 
```ts
type ComputeBackendKind = "wasm" | "native-desktop" | "service-host";
```
 ### ContractCreatedDocumentObject [Заголовок раздела «ContractCreatedDocumentObject»](#contractcreateddocumentobject) 
```ts
interface ContractCreatedDocumentObject {
  stableId: string;
  nonVisualId: number;
  sheetPath: string;
  drawingPath: string;
  family: "image" | "shape" | "text-box" | "chart" | "pivot-table";
  name: string;
  anchor: ContractObjectAnchor;
  relationshipId?: string | null;
}
```
 ### ContractCurrentSourceSaveReadiness [Заголовок раздела «ContractCurrentSourceSaveReadiness»](#contractcurrentsourcesavereadiness) 
```ts
interface ContractCurrentSourceSaveReadiness {
  scope: ContractCurrentSourceSaveReadinessScope;
  failureCode?: string | null;
  failureMessage?: string | null;
  failureDetails?: string | null;
}
```
 ### ContractCurrentSourceSaveReadinessScope [Заголовок раздела «ContractCurrentSourceSaveReadinessScope»](#contractcurrentsourcesavereadinessscope) 
```ts
type ContractCurrentSourceSaveReadinessScope = (typeof CONTRACT_CURRENT_SOURCE_SAVE_READINESS_SCOPE_IDS)[number];
```
 ### ContractCustomViewApplyTransaction [Заголовок раздела «ContractCustomViewApplyTransaction»](#contractcustomviewapplytransaction) 
```ts
interface ContractCustomViewApplyTransaction {
  transactionId: string;
  viewId: string;
  windowId: string;
  registryRevision: number;
  previousWindow?: ContractCustomViewWindowSnapshot;
  nextWindow: ContractCustomViewWindowSnapshot;
  sheetStates: ContractCustomViewSheetSnapshot[];
  includePrintSettings: boolean;
  includeHiddenRowCol: boolean;
  workbookChanged: boolean;
  contentFingerprintBefore: string;
  contentFingerprintAfter: string;
}
```
 ### ContractCustomViewDefinition [Заголовок раздела «ContractCustomViewDefinition»](#contractcustomviewdefinition) 
```ts
interface ContractCustomViewDefinition {
  id: string;
  name: string;
  includePrintSettings: boolean;
  includeHiddenRowCol: boolean;
  snapshot: ContractCustomViewSnapshot;
}
```
 ### ContractCustomViewSnapshot [Заголовок раздела «ContractCustomViewSnapshot»](#contractcustomviewsnapshot) 
```ts
interface ContractCustomViewSnapshot {
  window: ContractCustomViewWindowSnapshot;
  sheets: ContractCustomViewSheetSnapshot[];
}
```
 ### ContractCustomViewsIntent [Заголовок раздела «ContractCustomViewsIntent»](#contractcustomviewsintent) 
```ts
type ContractCustomViewsIntent =
  | { action: "list"; windowId: string }
  | { action: "add";
    windowId: string;
    name: string;
    window: ContractCustomViewWindowSnapshot;
    includePrintSettings: boolean;
    includeHiddenRowCol: boolean;
    expectedRegistryRevision?: number;
    expectedRevision?: number;
    readOnly?: boolean;
  }
  | { action: "show";
    windowId: string;
    viewId: string;
    expectedRegistryRevision?: number;
    expectedRevision?: number;
    readOnly?: boolean;
  }
  | { action: "delete";
    windowId: string;
    viewId: string;
    expectedRegistryRevision?: number;
    expectedRevision?: number;
    readOnly?: boolean;
  };
```
 ### ContractCustomViewsResult [Заголовок раздела «ContractCustomViewsResult»](#contractcustomviewsresult) 
```ts
interface ContractCustomViewsResult {
  status: ContractCustomViewsStatus;
  registryRevision: number;
  views: ContractCustomViewDefinition[];
  activeViewId?: string;
  applyTransaction?: ContractCustomViewApplyTransaction;
  reason?: string;
  workbookChanged: boolean;
  workbookHistory?: ContractWorkbookHistoryProjection;
}
```
 ### ContractCustomViewsStatus [Заголовок раздела «ContractCustomViewsStatus»](#contractcustomviewsstatus) 
```ts
type ContractCustomViewsStatus = "listed" | "added" | "shown" | "deleted" | "undone" | "redone" | "blocked";
```
 ### ContractDataAnalysisAction [Заголовок раздела «ContractDataAnalysisAction»](#contractdataanalysisaction) 
```ts
type ContractDataAnalysisAction =
  | { action: "preview"; analysis: ContractDataAnalysisTool; }
  | { action: "run"; analysis: ContractDataAnalysisTool; destination: ContractDataAnalysisDestination; }
  | { action: "undo" }
  | { action: "redo" }
  | { action: "cancel" };
```
 ### ContractDataAnalysisDestination [Заголовок раздела «ContractDataAnalysisDestination»](#contractdataanalysisdestination) 
```ts
type ContractDataAnalysisDestination =
  | { mode: "existing_range"; anchor: CellRange }
  | { mode: "new_worksheet"; name?: string
  | null }
  | { mode: "new_workbook"; name?: string
  | null };
```
 ### ContractDataAnalysisRandomDistribution [Заголовок раздела «ContractDataAnalysisRandomDistribution»](#contractdataanalysisrandomdistribution) 
```ts
type ContractDataAnalysisRandomDistribution =
  | { distribution: "uniform"; lowerBound: number; upperBound: number }
  | { distribution: "normal"; mean: number; standardDeviation: number }
  | { distribution: "bernoulli"; probability: number }
  | { distribution: "binomial"; numberOfTrials: number; probability: number }
  | { distribution: "poisson"; lambda: number }
  | { distribution: "patterned";
    fromValue: number;
    toValue: number;
    step: number;
    repeatEach: number;
    repeatSequence: number;
  }
  | { distribution: "discrete"; valueProbabilityRange: CellRange };
```
 ### ContractDataAnalysisSamplingMethod [Заголовок раздела «ContractDataAnalysisSamplingMethod»](#contractdataanalysissamplingmethod) 
```ts
type ContractDataAnalysisSamplingMethod = | { method: "periodic";
  period: number } | { method: "random";
sampleCount: number };
```
 ### ContractDataAnalysisTool [Заголовок раздела «ContractDataAnalysisTool»](#contractdataanalysistool) 
```ts
type ContractDataAnalysisTool =
  | { tool: "analyze_insights";
    inputRange: CellRange;
    question?: string;
    insertion?: ContractAnalyzeInsightsInsertion;
  selectedInsightId?: string
  | null; locale?: string
  | null; expectedRevision?: number
  | null; requestGeneration?: number
  | null; }
  | { tool: "forecast_sheet";
    timelineRange: CellRange;
    valuesRange: CellRange;
    forecastEnd?: string;
    seasonality?: number;
    confidenceLevel?: number;
  dataCompletion?: 0
  | 1; aggregation?: number; labels?: boolean; includeStatistics?: boolean; chartType?: "line"
  | "column"; locale?: string
  | null; expectedRevision?: number
  | null; requestGeneration?: number
  | null; }
  | { tool: "regression";
    yRange: CellRange;
    xRange: CellRange;
    labels?: boolean;
    constantIsZero?: boolean;
    confidenceLevel?: number;
    residuals?: boolean;
    standardizedResiduals?: boolean;
    predictedValues?: boolean;
  }
  | { tool: "descriptive_statistics";
    inputRange: CellRange;
    groupedBy?: ContractDataAnalysisGrouping;
    labels?: boolean;
    summaryStatistics?: boolean;
  confidenceLevelForMean?: number
  | null; }
  | { tool: "correlation"
  | "covariance"; inputRange: CellRange; groupedBy?: ContractDataAnalysisGrouping; labels?: boolean; }
  | { tool: "histogram";
    inputRange: CellRange;
    binRange: CellRange;
    labels?: boolean;
    cumulativePercentage?: boolean;
    pareto?: boolean;
    chartOutput?: boolean;
  }
  | { tool: "moving_average";
    inputRange: CellRange;
    interval: number;
    labels?: boolean;
    standardErrors?: boolean;
  }
  | { tool: "anova_single_factor";
    inputRange: CellRange;
    groupedBy?: ContractDataAnalysisGrouping;
    labels?: boolean;
    alpha?: number;
  }
  | { tool:
  | "anova_two_factor_without_replication"
  | "anova_two_factor_with_replication"; inputRange: CellRange; rowsPerSample?: number; labels?: boolean; alpha?: number; }
  | { tool:
  | "t_test_paired_two_sample_for_means"
  | "t_test_two_sample_equal_variances"
  | "t_test_two_sample_unequal_variances"; variable1Range: CellRange; variable2Range: CellRange; labels?: boolean; hypothesizedMeanDifference?: number; alpha?: number; }
  | { tool: "z_test_two_sample_for_means";
    variable1Range: CellRange;
    variable2Range: CellRange;
    knownVariance1: number;
    knownVariance2: number;
    labels?: boolean;
    hypothesizedMeanDifference?: number;
    alpha?: number;
  }
  | { tool: "f_test_two_sample_for_variances";
    variable1Range: CellRange;
    variable2Range: CellRange;
    labels?: boolean;
    alpha?: number;
  }
  | { tool: "exponential_smoothing";
    inputRange: CellRange;
    groupedBy?: ContractDataAnalysisGrouping;
    labels?: boolean;
    dampingFactor: number;
    standardErrors?: boolean;
    chartOutput?: boolean;
  }
  | { tool: "fourier_analysis"; inputRange: CellRange; labels?: boolean; inverse?: boolean; }
  | { tool: "random_number_generation";
    numberOfVariables: number;
    numberOfRandomNumbers: number;
    distribution: ContractDataAnalysisRandomDistribution;
  randomSeed?: number
  | null; }
  | { tool: "rank_and_percentile";
    inputRange: CellRange;
    groupedBy?: ContractDataAnalysisGrouping;
    labels?: boolean;
  }
  | { tool: "sampling";
    inputRange: CellRange;
    labels?: boolean;
    sampling: ContractDataAnalysisSamplingMethod;
  };
```
 ### ContractDataCleanupAction [Заголовок раздела «ContractDataCleanupAction»](#contractdatacleanupaction) 
```ts
type ContractDataCleanupAction = "preview" | "apply";
```
 ### ContractDataCleanupIntent [Заголовок раздела «ContractDataCleanupIntent»](#contractdatacleanupintent) 
```ts
type ContractDataCleanupIntent =
  | { kind: "text_to_columns_delimited"; source: CellRange; destinationRow?: number
  | null; destinationCol?: number
  | null; delimiter: string; textQualifier?: boolean; columnFormats?: ContractTextToColumnsColumnFormat[]; decimalSeparator?: string
  | null; thousandsSeparator?: string
  | null; overwriteDestination?: boolean; }
  | { kind: "text_to_columns_fixed_width"; source: CellRange; destinationRow?: number
  | null; destinationCol?: number
  | null; breakLines: number[]; columnFormats?: ContractTextToColumnsColumnFormat[]; decimalSeparator?: string
  | null; thousandsSeparator?: string
  | null; overwriteDestination?: boolean; }
  | { kind: "text_to_columns_delimited_advanced"; source: CellRange; destinationRow?: number
  | null; destinationCol?: number
  | null; delimiter: string; textQualifier?: boolean; columnFormats?: ContractTextToColumnsColumnFormat[]; overwriteDestination?: boolean; advancedOptions: ContractTextToColumnsAdvancedOptions; }
  | { kind: "text_to_columns_fixed_width_advanced"; source: CellRange; destinationRow?: number
  | null; destinationCol?: number
  | null; breakLines: number[]; columnFormats?: ContractTextToColumnsColumnFormat[]; overwriteDestination?: boolean; advancedOptions: ContractTextToColumnsAdvancedOptions; }
  | { kind: "remove_duplicates";
    source: CellRange;
    headerPolicy?: ContractRemoveDuplicatesHeaderPolicy;
    keyColumns?: number[];
  tableName?: string
  | null; }
  | { kind: "remove_duplicates_copy";
    source: CellRange;
    destinationRow: number;
    destinationCol: number;
    headerPolicy?: ContractRemoveDuplicatesHeaderPolicy;
    keyColumns?: number[];
  tableName?: string
  | null; };
```
 ### ContractDataCleanupPreviewValue [Заголовок раздела «ContractDataCleanupPreviewValue»](#contractdatacleanuppreviewvalue) 
```ts
interface ContractDataCleanupPreviewValue {
  kind:
    "blank" | "empty_string" | "boolean" | "date" | "number" | "error" | "text";
  value: string;
}
```
 ### ContractDelimitedInterpretation [Заголовок раздела «ContractDelimitedInterpretation»](#contractdelimitedinterpretation) 
```ts
type ContractDelimitedInterpretation = (typeof CONTRACT_DELIMITED_INTERPRETATION_IDS)[number];
```
 ### ContractDelimitedLineEnding [Заголовок раздела «ContractDelimitedLineEnding»](#contractdelimitedlineending) 
```ts
type ContractDelimitedLineEnding = (typeof CONTRACT_DELIMITED_LINE_ENDING_IDS)[number];
```
 ### ContractDelimitedLocale [Заголовок раздела «ContractDelimitedLocale»](#contractdelimitedlocale) 
```ts
type ContractDelimitedLocale = string;
```
 ### ContractDelimitedOpenDelimiter [Заголовок раздела «ContractDelimitedOpenDelimiter»](#contractdelimitedopendelimiter) 
```ts
type ContractDelimitedOpenDelimiter = ContractDelimitedSaveDelimiter;
```
 ### ContractDelimitedOpenLayout [Заголовок раздела «ContractDelimitedOpenLayout»](#contractdelimitedopenlayout) 
```ts
type ContractDelimitedOpenLayout = (typeof CONTRACT_DELIMITED_OPEN_LAYOUT_IDS)[number];
```
 ### ContractDelimitedOpenOptions [Заголовок раздела «ContractDelimitedOpenOptions»](#contractdelimitedopenoptions) 
```ts
interface ContractDelimitedOpenOptions {
  layout?: ContractDelimitedOpenLayout | null;
  fixedWidthBreaks?: number[] | null;
  delimiter?: ContractDelimitedOpenDelimiter | null;
  customDelimiter?: string | null;


  delimiterSet?: string | null;
  textQualifier?: ContractDelimitedTextQualifier | null;
  consecutiveDelimitersAsOne?: boolean | null;
  encoding?: ContractDelimitedSaveEncoding | null;
  interpretation?: ContractDelimitedInterpretation | null;


  locale?: ContractDelimitedLocale | null;


  decimalSeparator?: string | null;


  thousandsSeparator?: string | null;


  columnFormats?: ContractDelimitedColumnFormat[] | null;


  startRow?: number | null;
}
```
 ### ContractDelimitedQuotePolicy [Заголовок раздела «ContractDelimitedQuotePolicy»](#contractdelimitedquotepolicy) 
```ts
type ContractDelimitedQuotePolicy = (typeof CONTRACT_DELIMITED_QUOTE_POLICY_IDS)[number];
```
 ### ContractDelimitedSaveDelimiter [Заголовок раздела «ContractDelimitedSaveDelimiter»](#contractdelimitedsavedelimiter) 
```ts
type ContractDelimitedSaveDelimiter = (typeof CONTRACT_DELIMITED_SAVE_DELIMITER_IDS)[number];
```
 ### ContractDelimitedSaveEncoding [Заголовок раздела «ContractDelimitedSaveEncoding»](#contractdelimitedsaveencoding) 
```ts
type ContractDelimitedSaveEncoding = (typeof CONTRACT_DELIMITED_SAVE_ENCODING_IDS)[number];
```
 ### ContractDelimitedSaveOptions [Заголовок раздела «ContractDelimitedSaveOptions»](#contractdelimitedsaveoptions) 
```ts
interface ContractDelimitedSaveOptions {
  delimiter?: ContractDelimitedSaveDelimiter | null;
  customDelimiter?: string | null;
  encoding?: ContractDelimitedSaveEncoding | null;
  quotePolicy?: ContractDelimitedQuotePolicy | null;
  lineEnding?: ContractDelimitedLineEnding | null;


  formattingLossConfirmed?: boolean;
}
```
 ### ContractDirectionPlaceholderKind [Заголовок раздела «ContractDirectionPlaceholderKind»](#contractdirectionplaceholderkind) 
```ts
type ContractDirectionPlaceholderKind = "default-ltr-session-placeholder";
```
 ### ContractDocumentPropertiesIntent [Заголовок раздела «ContractDocumentPropertiesIntent»](#contractdocumentpropertiesintent) 
```ts
type ContractDocumentPropertiesIntent =
  | { action: "list" }
  | { action: "apply"; expectedRevision?: number
  | null; mutations: ContractDocumentPropertyMutation[]; readOnly?: boolean; protected?: boolean; }
  | { action: "undo"
  | "redo"; expectedRevision: number; readOnly?: boolean; protected?: boolean; };
```
 ### ContractDocumentPropertiesResult [Заголовок раздела «ContractDocumentPropertiesResult»](#contractdocumentpropertiesresult) 
```ts
interface ContractDocumentPropertiesResult {
  status: "listed" | "applied" | "undone" | "redone" | "unchanged";
  didChange: boolean;
  hasUnsavedSessionEdits: boolean;
  revision: number;
  undoAvailable: boolean;
  redoAvailable: boolean;
  capability: ContractDocumentPropertiesCapability;
  reasonCode?: string | null;
  core: ContractDocumentPropertyRecord[];
  extended: ContractDocumentPropertyRecord[];
  custom: ContractDocumentPropertyRecord[];
  statistics: ContractDocumentPropertyStatistic[];
}
```
 ### ContractDocumentPropertyMutation [Заголовок раздела «ContractDocumentPropertyMutation»](#contractdocumentpropertymutation) 
```ts
type ContractDocumentPropertyMutation =
  | { kind: "set_known"; propertyId: string; value: ContractDocumentPropertyValue
  | null; }
  | { kind: "upsert_custom"; propertyId?: string
  | null; name: string; value: Exclude<ContractDocumentPropertyValue, { kind: "opaque" }>; }
  | { kind: "delete_custom"; propertyId: string };
```
 ### ContractDocumentPropertyRecord [Заголовок раздела «ContractDocumentPropertyRecord»](#contractdocumentpropertyrecord) 
```ts
interface ContractDocumentPropertyRecord {
  propertyId: string;
  scope: ContractDocumentPropertyScope;
  name: string;
  editable: boolean;
  value: ContractDocumentPropertyValue | null;
}
```
 ### ContractDocumentPropertyScope [Заголовок раздела «ContractDocumentPropertyScope»](#contractdocumentpropertyscope) 
```ts
type ContractDocumentPropertyScope = "core" | "extended" | "custom";
```
 ### ContractDocumentPropertyStatistic [Заголовок раздела «ContractDocumentPropertyStatistic»](#contractdocumentpropertystatistic) 
```ts
interface ContractDocumentPropertyStatistic {
  statisticId: string;
  value: number;
}
```
 ### ContractDocumentPropertyValue [Заголовок раздела «ContractDocumentPropertyValue»](#contractdocumentpropertyvalue) 
```ts
type ContractDocumentPropertyValue =
  | { kind: "text"; value: string }
  | { kind: "integer"; decimal: string }
  | { kind: "real"; value: number }
  | { kind: "boolean"; value: boolean }
  | { kind: "date_time"; utc: string }
  | { kind: "opaque"; typeName: string };
```
 ### ContractEntityConversionDisposition [Заголовок раздела «ContractEntityConversionDisposition»](#contractentityconversiondisposition) 
```ts
type ContractEntityConversionDisposition = "resolved" | "refused";
```
 ### ContractEntityConversionRefusal [Заголовок раздела «ContractEntityConversionRefusal»](#contractentityconversionrefusal) 
```ts
interface ContractEntityConversionRefusal {
  code: ContractEntityConversionRefusalCode;
  message: string;
}
```
 ### ContractEntityConversionRefusalCode [Заголовок раздела «ContractEntityConversionRefusalCode»](#contractentityconversionrefusalcode) 
```ts
type ContractEntityConversionRefusalCode = "entity-provider-unavailable";
```
 ### ContractEntityDataTypeKind [Заголовок раздела «ContractEntityDataTypeKind»](#contractentitydatatypekind) 
```ts
type ContractEntityDataTypeKind = "stocks" | "currencies" | "geography";
```
 ### ContractEntityFieldValue [Заголовок раздела «ContractEntityFieldValue»](#contractentityfieldvalue) 
```ts
interface ContractEntityFieldValue {
  fieldId: string;
  label: string;
  displayValue: string;
}
```
 ### ContractEntityProviderIdentity [Заголовок раздела «ContractEntityProviderIdentity»](#contractentityprovideridentity) 
```ts
interface ContractEntityProviderIdentity {
  providerId: string;
  attribution: string;
}
```
 ### ContractEntityResolutionState [Заголовок раздела «ContractEntityResolutionState»](#contractentityresolutionstate) 
```ts
type ContractEntityResolutionState = "resolved" | "unresolved" | "stale";
```
 ### ContractErrorCode [Заголовок раздела «ContractErrorCode»](#contracterrorcode) 
```ts
type ContractErrorCode = "DIV0" | "NA" | string;
```
 ### ContractFidelityClass [Заголовок раздела «ContractFidelityClass»](#contractfidelityclass) 
```ts
type ContractFidelityClass = (typeof CONTRACT_FIDELITY_CLASS_IDS)[number];
```
 ### ContractFileRecoveryAction [Заголовок раздела «ContractFileRecoveryAction»](#contractfilerecoveryaction) 
```ts
interface ContractFileRecoveryAction {
  kind: ContractFileRecoveryActionKind;
  part: string;
  relationshipId?: string;
  message: string;
}
```
 ### ContractFileRecoveryActionKind [Заголовок раздела «ContractFileRecoveryActionKind»](#contractfilerecoveryactionkind) 
```ts
type ContractFileRecoveryActionKind =
  | "rebuild_content_types"
  | "synthesize_root_relationships"
  | "drop_missing_relationship"
  | "deduplicate_relationships"
  | "remove_calc_chain"
  | "synthesize_styles"
  | "rebuild_shared_strings"
  | "normalize_sheet_ids"
  | "repair_worksheet";
```
 ### ContractFileRecoveryBounds [Заголовок раздела «ContractFileRecoveryBounds»](#contractfilerecoverybounds) 
```ts
interface ContractFileRecoveryBounds {
  maxArchiveBytes: number;
  maxEntryCount: number;
  maxPartBytes: number;
  maxTotalUncompressedBytes: number;
  maxXmlBytes: number;
  maxCompressionRatio: number;
  maxPlanActions: number;
  maxSheets: number;
  maxSalvagedCellsPerSheet: number;
}
```
 ### ContractFileRecoveryDiagnostic [Заголовок раздела «ContractFileRecoveryDiagnostic»](#contractfilerecoverydiagnostic) 
```ts
interface ContractFileRecoveryDiagnostic {
  code: ContractFileRecoveryDiagnosticCode;
  severity: ContractFileRecoverySeverity;
  part: string;
  message: string;
}
```
 ### ContractFileRecoveryDiagnosticCode [Заголовок раздела «ContractFileRecoveryDiagnosticCode»](#contractfilerecoverydiagnosticcode) 
```ts
type ContractFileRecoveryDiagnosticCode =
  | "zip_path_traversal"
  | "zip_duplicate_entry"
  | "zip_bomb_limit"
  | "zip_malformed"
  | "xml_oversized"
  | "unsafe_xml_construct"
  | "macro_or_active_content"
  | "digital_signature"
  | "external_relationship"
  | "ambiguous_topology"
  | "missing_content_types"
  | "malformed_content_types"
  | "missing_root_relationships"
  | "malformed_relationships"
  | "duplicate_relationship_id"
  | "missing_relationship_target"
  | "duplicate_sheet_id"
  | "missing_optional_part"
  | "malformed_optional_part"
  | "malformed_worksheet"
  | "salvage_limit"
  | "no_repair_needed";
```
 ### ContractFileRecoveryMode [Заголовок раздела «ContractFileRecoveryMode»](#contractfilerecoverymode) 
```ts
type ContractFileRecoveryMode = "repair" | "extract_data";
```
 ### ContractFileRecoveryPlan [Заголовок раздела «ContractFileRecoveryPlan»](#contractfilerecoveryplan) 
```ts
interface ContractFileRecoveryPlan {
  planId: string;
  sourceSha256: string;
  sourceByteCount: number;
  status: ContractFileRecoveryPlanStatus;
  canRepair: boolean;
  canExtractData: boolean;
  diagnostics: ContractFileRecoveryDiagnostic[];
  actions: ContractFileRecoveryAction[];
  bounds: ContractFileRecoveryBounds;
}
```
 ### ContractFileRecoveryPlanStatus [Заголовок раздела «ContractFileRecoveryPlanStatus»](#contractfilerecoveryplanstatus) 
```ts
type ContractFileRecoveryPlanStatus = "repairable" | "extract_only" | "blocked" | "no_repair_needed";
```
 ### ContractFileRecoveryPublication [Заголовок раздела «ContractFileRecoveryPublication»](#contractfilerecoverypublication) 
```ts
interface ContractFileRecoveryPublication {
  planId: string;
  sourceSha256: string;
  outputSha256: string;
  outputByteCount: number;
  outputPath: string;
  mode: ContractFileRecoveryMode;
  actionCount: number;
}
```
 ### ContractFileRecoverySeverity [Заголовок раздела «ContractFileRecoverySeverity»](#contractfilerecoveryseverity) 
```ts
type ContractFileRecoverySeverity = "info" | "warning" | "error" | "blocked";
```
 ### ContractFormControlInteraction [Заголовок раздела «ContractFormControlInteraction»](#contractformcontrolinteraction) 
```ts
type ContractFormControlInteraction =
  | "toggle"
  | "select-index"
  | "increment"
  | "decrement"
  | "page-increment"
  | "page-decrement"
  | "set-value";
```
 ### ContractFormControlKind [Заголовок раздела «ContractFormControlKind»](#contractformcontrolkind) 
```ts
type ContractFormControlKind = | "check-box" | "option-button" | "list-box" | "combo-box" | "spin-button" | "scroll-bar";
```
 ### ContractFormControlView [Заголовок раздела «ContractFormControlView»](#contractformcontrolview) 
```ts
interface ContractFormControlView {
  stableId: string;
  sheetKey: string;
  sheetName: string;
  kind: ContractFormControlKind;
  name: string;
  anchor: ContractObjectAnchor;
  linkedCell?: string | null;
  inputRange?: string | null;
  optionGroup?: string | null;
  selectedIndex?: number | null;
  inputCount: number;
  checked?: boolean | null;
  value: number;
  min: number;
  max: number;
  step: number;
  pageStep: number;
  visible: boolean;
  locked: boolean;
  printObject: boolean;
  revision: number;
  authored: boolean;
}
```
 ### ContractFormControlsAction [Заголовок раздела «ContractFormControlsAction»](#contractformcontrolsaction) 
```ts
type ContractFormControlsAction =
  | { action: "list" }
  | { action: "create";
    kind: ContractFormControlKind;
    sheetKey: string;
    name: string;
    anchor: ContractObjectAnchor;
  linkedCell?: string
  | null; inputRange?: string
  | null; optionGroup?: string
  | null; min?: number; max?: number; step?: number; pageStep?: number; }
  | { action: "update_properties";
    stableId: string;
    expectedRevision: number;
    name: string;
  linkedCell?: string
  | null; inputRange?: string
  | null; optionGroup?: string
  | null; min: number; max: number; step: number; pageStep: number; }
  | { action: "interact";
    stableId: string;
    expectedRevision: number;
    interaction: ContractFormControlInteraction;
  value?: number
  | null; }
  | { action: "set_geometry"; stableId: string; expectedRevision: number; anchor: ContractObjectAnchor; }
  | { action: "set_visibility"; stableId: string; expectedRevision: number; visible: boolean; }
  | { action: "set_flags";
    stableId: string;
    expectedRevision: number;
    locked: boolean;
    printObject: boolean;
  }
  | { action: "undo" }
  | { action: "redo" };
```
 ### ContractHyperlinkMetadataEntry [Заголовок раздела «ContractHyperlinkMetadataEntry»](#contracthyperlinkmetadataentry) 
```ts
interface ContractHyperlinkMetadataEntry {
  stableId: string;
  sheetName: string;
  sheetPath: string;
  row: number;
  col: number;
  target: string;
  location?: string | null;
  display?: string | null;
  tooltip?: string | null;
  targetMode?: string | null;
}
```
 ### ContractHyperlinkMetadataProjection [Заголовок раздела «ContractHyperlinkMetadataProjection»](#contracthyperlinkmetadataprojection) 
```ts
interface ContractHyperlinkMetadataProjection {
  scope: "active-sheet" | "workbook";
  source: "rust-authoritative-hyperlink-model";
  activeSheetPath: string;
  hyperlinkCount: number;
  hyperlinks: ContractHyperlinkMetadataEntry[];
}
```
 ### ContractLegacyNotePayload [Заголовок раздела «ContractLegacyNotePayload»](#contractlegacynotepayload) 
```ts
interface ContractLegacyNotePayload {
  source: ContractLegacyNotePayloadSource;
  cellRef: string;
  annotationId?: string | null;
  author?: string | null;
  visible?: boolean | null;
  text: string;
  richTextRuns?: ContractCommentRichTextRun[] | null;
}
```
 ### ContractLegacyNotePayloadSource [Заголовок раздела «ContractLegacyNotePayloadSource»](#contractlegacynotepayloadsource) 
```ts
type ContractLegacyNotePayloadSource = "legacy-comments-vml";
```
 ### ContractLinkedPicturePayload [Заголовок раздела «ContractLinkedPicturePayload»](#contractlinkedpicturepayload) 
```ts
interface ContractLinkedPicturePayload {
  sourceRange: string;
  sourceSheetKey?: string | null;
  mode?: "bounded-camera-tool" | string | null;
}
```
 ### ContractObjectAnchor [Заголовок раздела «ContractObjectAnchor»](#contractobjectanchor) 
```ts
interface ContractObjectAnchor {
  kind: ContractObjectAnchorKind;
  from?: ContractObjectAnchorCell | null;
  to?: ContractObjectAnchorCell | null;
  origin?: ContractObjectAnchorOrigin | null;
  ext?: ContractObjectExtent | null;


  groupRel?: { x: number; y: number; w: number; h: number } | null;
}
```
 ### ContractObjectAnchorKind [Заголовок раздела «ContractObjectAnchorKind»](#contractobjectanchorkind) 
```ts
type ContractObjectAnchorKind = "two-cell" | "one-cell" | "absolute";
```
 ### ContractObjectAnchorOrigin [Заголовок раздела «ContractObjectAnchorOrigin»](#contractobjectanchororigin) 
```ts
interface ContractObjectAnchorOrigin {
  xEmu: number;
  yEmu: number;
}
```
 ### ContractObjectExtent [Заголовок раздела «ContractObjectExtent»](#contractobjectextent) 
```ts
interface ContractObjectExtent {
  cxEmu: number;
  cyEmu: number;
}
```
 ### ContractObjectFamilyStatusPlaceholder [Заголовок раздела «ContractObjectFamilyStatusPlaceholder»](#contractobjectfamilystatusplaceholder) 
```ts
interface ContractObjectFamilyStatusPlaceholder {
  family: ContractObjectPlaceholderFamily;
  presence: ContractObjectPlaceholderPresence;
  status: ContractObjectPlaceholderStatus;
}
```
 ### ContractObjectPlaceholderFamily [Заголовок раздела «ContractObjectPlaceholderFamily»](#contractobjectplaceholderfamily) 
```ts
type ContractObjectPlaceholderFamily = "comments-notes";
```
 ### ContractObjectPlaceholderPresence [Заголовок раздела «ContractObjectPlaceholderPresence»](#contractobjectplaceholderpresence) 
```ts
type ContractObjectPlaceholderPresence = "present";
```
 ### ContractObjectPlaceholderScope [Заголовок раздела «ContractObjectPlaceholderScope»](#contractobjectplaceholderscope) 
```ts
type ContractObjectPlaceholderScope = "active-sheet";
```
 ### ContractObjectPlaceholderStatus [Заголовок раздела «ContractObjectPlaceholderStatus»](#contractobjectplaceholderstatus) 
```ts
type ContractObjectPlaceholderStatus = "legacy-vml-preserved-only";
```
 ### ContractObjectSelectionPaneCommand [Заголовок раздела «ContractObjectSelectionPaneCommand»](#contractobjectselectionpanecommand) 
```ts
type ContractObjectSelectionPaneCommand =
  | { kind: "rename"; name: string }
  | { kind: "set-accessibility"; title: string
  | null; description: string
  | null; decorative: boolean; }
  | { kind: "set-visibility"; visible: boolean }
  | { kind: "set-print-object"; printObject: boolean }
  | { kind: "set-chart-format"; formatting: ContractChartFormatting }
  | { kind: "arrange"; action: "front"
  | "back"
  | "forward"
  | "backward" }
  | { kind: "align"; action: "left"
  | "center"
  | "right"
  | "top"
  | "middle"
  | "bottom" }
  | { kind: "distribute"; action: "horizontally"
  | "vertically" }
  | { kind: "group"; groupId: string }
  | { kind: "ungroup" }
  | { kind: "regroup" }
  | { kind: "geometry"; x: number
  | null; y: number
  | null; width: number
  | null; height: number
  | null; aspectLocked: boolean
  | null; }
  | { kind: "rotate"; deltaDeg: number }
  | { kind: "flip"; action: "horizontal"
  | "vertical" }
  | { kind: "crop"; crop: { leftPct: number; topPct: number; rightPct: number; bottomPct: number; }; }
  | { kind: "fit-picture" }
  | { kind: "fill-picture" }
  | { kind: "reset-picture" }
  | { kind: "replace-picture"; media: { mimeType: "image/png"
  | "image/jpeg"
  | "image/gif"; dataBase64: string; byteCount: number; widthPx: number; heightPx: number; sha256: string; }; }
  | { kind: "delete" }
  | { kind: "copy-within-workbook";
    newStableId: string;
    newNonVisualId: string;
    newName: string;
    rowDelta: number;
    colDelta: number;
  };
```
 ### ContractObjectSelectionPanePackageCommand [Заголовок раздела «ContractObjectSelectionPanePackageCommand»](#contractobjectselectionpanepackagecommand) 
```ts
interface ContractObjectSelectionPanePackageCommand {
  sheetId: string;
  objectStableIds: string[];
  primaryStableId?: string | null;
  expectedRevision: number;
  command: ContractObjectSelectionPaneCommand;
  geometryAnchor?: ContractObjectAnchor | null;
  groupId?: string | null;
  orderedStableIds?: string[];
  memberStableIds?: string[];
}
```
 ### ContractOpenDocumentObjectCreation [Заголовок раздела «ContractOpenDocumentObjectCreation»](#contractopendocumentobjectcreation) 
```ts
type ContractOpenDocumentObjectCreation =
  | { family: "image"; name: string; description?: string; mimeType: "image/png"
  | "image/jpeg"
  | "image/gif"; dataBase64: string; sha256: string; linkedSourceRange?: string
  | null; replacementRange?: ContractOpenDocumentReplacementRange
  | null; anchor: ContractObjectAnchor; }
  | { family: "shape"; name: string; preset: "rect"
  | "roundRect"
  | "ellipse"; text?: string; fillRgb: string; lineRgb: string; anchor: ContractObjectAnchor; }
  | { family: "text-box";
    name: string;
    text?: string;
    fillRgb: string;
    lineRgb: string;
    anchor: ContractObjectAnchor;
  }
  | { family: "chart"; name: string; title?: string; chartType: "column"
  | "bar"
  | "line"; series: ContractOpenDocumentChartSeries[]; anchor: ContractObjectAnchor; }
  | { family: "geometry-update"; stableId: string; name: string; objectFamily: "image"
  | "shape"
  | "text-box"
  | "chart"; anchor: ContractObjectAnchor; }
  | { family: "pivot-table";
    name: string;
    ref: string;
    sourceSheetName: string;
    sourceTableName: string;
    sourceRef: string;
    rowField: string;
    columnField: string;
    valueField: string;
    summaryFunction: "sum";
  };
```
 ### ContractParallelRecalcInstrumentation [Заголовок раздела «ContractParallelRecalcInstrumentation»](#contractparallelrecalcinstrumentation) 
```ts
interface ContractParallelRecalcInstrumentation {
  requestedWorkerCount: number;
  usedWorkerCount: number;
  readyFrontierCount: number;
  parallelFrontierCount: number;
  evaluatedComponentCount: number;
  parallelComponentCount: number;
  serializedComponentCount: number;
  sccComponentCount: number;
  volatileBoundaryCount: number;
  dynamicBoundaryCount: number;
  externalBoundaryCount: number;
  maximumConcurrentWorkers: number;
  cancelledFrontierCount: number;
  supersededFrontierCount: number;
  scheduleHash: string;
}
```
 ### ContractParamEdge [Заголовок раздела «ContractParamEdge»](#contractparamedge) 
```ts
interface ContractParamEdge {
  queryStableId: string;
  paramId: string;
}
```
 ### ContractParamValueRepr [Заголовок раздела «ContractParamValueRepr»](#contractparamvaluerepr) 
```ts
interface ContractParamValueRepr {
  kind: ContractParameterKind;
  canonicalM: string;
}
```
 ### ContractParameterDTO [Заголовок раздела «ContractParameterDTO»](#contractparameterdto) 
```ts
interface ContractParameterDTO {
  id: string;
  name: string;
  kind: ContractParameterKind;
  currentValue: ContractParamValueRepr;
  required: boolean;
  allowedValues?: ContractParamValueRepr[] | null;
  numericRange?: ContractParameterNumericRange | null;
}
```
 ### ContractParameterKind [Заголовок раздела «ContractParameterKind»](#contractparameterkind) 
```ts
type ContractParameterKind = "text" | "number" | "logical" | "date" | "null";
```
 ### ContractPasteMode [Заголовок раздела «ContractPasteMode»](#contractpastemode) 
```ts
type ContractPasteMode = "all" | "values" | "formulas" | "formats";
```
 ### ContractPersistedParamOptionsBinding [Заголовок раздела «ContractPersistedParamOptionsBinding»](#contractpersistedparamoptionsbinding) 
```ts
interface ContractPersistedParamOptionsBinding {
  delimiterParam?: string | null;
  headerParam?: string | null;
  rowCountParam?: string | null;
  filterLiteralParam?: string | null;
  filterColumn?: string | null;
}
```
 ### ContractPreviewDataBar [Заголовок раздела «ContractPreviewDataBar»](#contractpreviewdatabar) 
```ts
interface ContractPreviewDataBar {
  color: string;
  ratio: number;
}
```
 ### ContractPreviewGradientStop [Заголовок раздела «ContractPreviewGradientStop»](#contractpreviewgradientstop) 
```ts
interface ContractPreviewGradientStop {
  position: number;
  color: string;
}
```
 ### ContractPreviewHorizontalAlign [Заголовок раздела «ContractPreviewHorizontalAlign»](#contractpreviewhorizontalalign) 
```ts
type ContractPreviewHorizontalAlign = | "left" | "center" | "right" | "fill" | "justify" | "centerAcrossSelection" | "distributed";
```
 ### ContractPreviewHyperlink [Заголовок раздела «ContractPreviewHyperlink»](#contractpreviewhyperlink) 
```ts
interface ContractPreviewHyperlink {
  target: string;
  location?: string | null;
  display?: string | null;
  tooltip?: string | null;
  targetMode?: string | null;
}
```
 ### ContractPreviewUnderlineKind [Заголовок раздела «ContractPreviewUnderlineKind»](#contractpreviewunderlinekind) 
```ts
type ContractPreviewUnderlineKind = "single" | "double" | "singleAccounting" | "doubleAccounting";
```
 ### ContractPreviewValueKind [Заголовок раздела «ContractPreviewValueKind»](#contractpreviewvaluekind) 
```ts
type ContractPreviewValueKind = "displayText" | "emptyString" | "boolean" | "error";
```
 ### ContractPreviewVerticalAlign [Заголовок раздела «ContractPreviewVerticalAlign»](#contractpreviewverticalalign) 
```ts
type ContractPreviewVerticalAlign = "top" | "center" | "bottom" | "justify" | "distributed";
```
 ### ContractRecalcRequiredReason [Заголовок раздела «ContractRecalcRequiredReason»](#contractrecalcrequiredreason) 
```ts
type ContractRecalcRequiredReason =
  | "source_cell_changed"
  | "sheet_lifecycle_changed"
  | "unsupported_dependency"
  | "volatile_formula"
  | "manual_calc_mode"
  | "imported_cache_without_trust_evidence"
  | "calc_chain_missing_or_advisory_only"
  | "external_workbook_not_loaded"
  | "external_link_missing"
  | "external_link_policy_blocked"
  | "external_ref_shape_unsupported"
  | "external_cached_value_without_freshness_evidence";
```
 ### ContractReplaceEdit [Заголовок раздела «ContractReplaceEdit»](#contractreplaceedit) 
```ts
interface ContractReplaceEdit {
  cellKey: string;
  sheetName: string;
  address: string;
  oldValue: string;
  newValue: string;
}
```
 ### ContractSaveKind [Заголовок раздела «ContractSaveKind»](#contractsavekind) 
```ts
type ContractSaveKind = (typeof CONTRACT_SAVE_KIND_IDS)[number];
```
 ### ContractSmartArtPayload [Заголовок раздела «ContractSmartArtPayload»](#contractsmartartpayload) 
```ts
interface ContractSmartArtPayload {
  status: ContractSmartArtRenderStatus;
  layout?: string | null;
  nodes: Array<{ id: string; text: string }>;
  themeReferences: string[];
}
```
 ### ContractSmartArtRenderStatus [Заголовок раздела «ContractSmartArtRenderStatus»](#contractsmartartrenderstatus) 
```ts
type ContractSmartArtRenderStatus = "live-supported" | "unsupported-layout" | "broken-topology";
```
 ### ContractSourceTrustAction [Заголовок раздела «ContractSourceTrustAction»](#contractsourcetrustaction) 
```ts
type ContractSourceTrustAction =
  | "evaluate_open"
  | "view"
  | "edit"
  | "paste"
  | "fill"
  | "refresh"
  | "macros"
  | "ole"
  | "active_x"
  | "save_original"
  | "save_copy"
  | "enable_editing"
  | "trust_document"
  | "external_links"
  | "data_connections";
```
 ### ContractSourceTrustAuthority [Заголовок раздела «ContractSourceTrustAuthority»](#contractsourcetrustauthority) 
```ts
type ContractSourceTrustAuthority =
  | "none"
  | "local_source"
  | "session_grant"
  | "editing_session"
  | "trusted_location"
  | "trusted_document"
  | "trust_center_policy";
```
 ### ContractSourceTrustDecision [Заголовок раздела «ContractSourceTrustDecision»](#contractsourcetrustdecision) 
```ts
interface ContractSourceTrustDecision {
  mode: ContractSourceTrustMode;
  authority: ContractSourceTrustAuthority;
  reason?: ContractSourceTrustReason;
  action: ContractSourceTrustAction;
  allowed: boolean;
  mutationAllowed: boolean;
  grant?: ContractSourceTrustGrantBinding;
  session?: ContractSourceTrustSessionBinding;
  matchedGrantId?: string;
  trustStoreState: ContractSourceTrustStoreState;
  trustStoreRevision: number;
  trustStoreHash: string;
  allowedActions: ContractSourceTrustAction[];
  blockedActions: ContractSourceTrustAction[];
  policy: ContractTrustCenterPolicy;
  policyState: ContractTrustCenterPolicyState;
  audit: ContractTrustCenterAuditEntry;
}
```
 ### ContractSourceTrustDirectoryIdentity [Заголовок раздела «ContractSourceTrustDirectoryIdentity»](#contractsourcetrustdirectoryidentity) 
```ts
interface ContractSourceTrustDirectoryIdentity {
  deviceId: string;
  fileId: string;
}
```
 ### ContractSourceTrustDocumentGrant [Заголовок раздела «ContractSourceTrustDocumentGrant»](#contractsourcetrustdocumentgrant) 
```ts
interface ContractSourceTrustDocumentGrant {
  grantId: string;
  sourceIdentity: string;
  byteSha256: string;
  revisionToken: string;
}
```
 ### ContractSourceTrustFileState [Заголовок раздела «ContractSourceTrustFileState»](#contractsourcetrustfilestate) 
```ts
type ContractSourceTrustFileState =
  | "current"
  | "read_only"
  | "missing"
  | "moved"
  | "symlink"
  | "corrupt"
  | "zero_byte"
  | "stale_revision"
  | "identity_changed";
```
 ### ContractSourceTrustGrantBinding [Заголовок раздела «ContractSourceTrustGrantBinding»](#contractsourcetrustgrantbinding) 
```ts
interface ContractSourceTrustGrantBinding {
  sourceIdentity: string;
  byteSha256: string;
  revisionToken: string;
}
```
 ### ContractSourceTrustLocationGrant [Заголовок раздела «ContractSourceTrustLocationGrant»](#contractsourcetrustlocationgrant) 
```ts
interface ContractSourceTrustLocationGrant {
  grantId: string;
  directoryIdentity: ContractSourceTrustDirectoryIdentity;
  includeSubfolders: boolean;
}
```
 ### ContractSourceTrustMode [Заголовок раздела «ContractSourceTrustMode»](#contractsourcetrustmode) 
```ts
type ContractSourceTrustMode = "trusted_edit" | "protected_view" | "read_only" | "blocked";
```
 ### ContractSourceTrustObservation [Заголовок раздела «ContractSourceTrustObservation»](#contractsourcetrustobservation) 
```ts
interface ContractSourceTrustObservation {
  sourceIdentity: string;
  byteSha256: string;
  revisionToken: string;
  provenance: ContractSourceTrustProvenance;
  fileState: ContractSourceTrustFileState;
  parentDirectories?: ContractSourceTrustDirectoryIdentity[];
  locationGrants?: ContractSourceTrustLocationGrant[];
  documentGrants?: ContractSourceTrustDocumentGrant[];
  trustStoreState?: ContractSourceTrustStoreState;
  trustStoreRevision?: number;
  trustStoreHash?: string;
  policyState?: ContractTrustCenterPolicyState;
  policy?: ContractTrustCenterPolicy;
}
```
 ### ContractSourceTrustProvenance [Заголовок раздела «ContractSourceTrustProvenance»](#contractsourcetrustprovenance) 
```ts
type ContractSourceTrustProvenance = "local_trusted" | "downloaded" | "quarantined" | "recovery" | "unknown";
```
 ### ContractSourceTrustReason [Заголовок раздела «ContractSourceTrustReason»](#contractsourcetrustreason) 
```ts
type ContractSourceTrustReason =
  | "downloaded_source_untrusted"
  | "quarantined_source_untrusted"
  | "recovery_source_requires_trust"
  | "unknown_source_untrusted"
  | "explicit_grant_required"
  | "source_read_only"
  | "source_missing"
  | "source_moved"
  | "source_symlink"
  | "source_corrupt"
  | "source_zero_byte"
  | "source_stale_revision"
  | "source_identity_changed"
  | "source_external_replacement_observed"
  | "grant_source_identity_mismatch"
  | "grant_byte_hash_mismatch"
  | "grant_revision_mismatch"
  | "action_blocked_by_mode"
  | "trust_policy_malformed"
  | "trust_policy_permission_denied"
  | "trust_policy_concurrent_writer"
  | "trust_policy_stale_response"
  | "trust_policy_unavailable"
  | "vba_execution_unavailable"
  | "active_content_execution_unavailable"
  | "external_links_policy_blocked"
  | "data_connections_policy_blocked"
  | "protected_view_policy_disabled"
  | "trusted_locations_policy_disabled"
  | "source_trust_allowed"
  | "external_links_manual_policy_allowed"
  | "data_connections_manual_policy_allowed";
```
 ### ContractSourceTrustStoreState [Заголовок раздела «ContractSourceTrustStoreState»](#contractsourcetruststorestate) 
```ts
type ContractSourceTrustStoreState =
  | "current"
  | "permission_denied"
  | "corrupt"
  | "concurrent_writer"
  | "stale_response"
  | "unavailable";
```
 ### ContractStructuredReferenceTrustMetadata [Заголовок раздела «ContractStructuredReferenceTrustMetadata»](#contractstructuredreferencetrustmetadata) 
```ts
interface ContractStructuredReferenceTrustMetadata {
  label: string;
  tableName?: string | null;
  shape: string;
  columnName?: string | null;
  targetSheetKey?: string | null;
  targetRange?: string | null;
  resolutionState: string;
}
```
 ### ContractTrustCenterPolicy [Заголовок раздела «ContractTrustCenterPolicy»](#contracttrustcenterpolicy) 
```ts
interface ContractTrustCenterPolicy {
  schemaVersion: 1;
  macroPolicy: ContractTrustCenterMacroPolicy;
  externalLinksPolicy: ContractTrustCenterExternalPolicy;
  dataConnectionsPolicy: ContractTrustCenterExternalPolicy;
  trustedLocationsEnabled: boolean;
  protectDownloaded: boolean;
  protectQuarantined: boolean;
  protectRecovery: boolean;
  protectUnknown: boolean;
}
```
 ### ContractTrustCenterPolicyState [Заголовок раздела «ContractTrustCenterPolicyState»](#contracttrustcenterpolicystate) 
```ts
type ContractTrustCenterPolicyState =
  | "current"
  | "malformed"
  | "permission_denied"
  | "concurrent_writer"
  | "stale_response"
  | "unavailable";
```
 ### ContractWhatIfAction [Заголовок раздела «ContractWhatIfAction»](#contractwhatifaction) 
```ts
type ContractWhatIfAction =
  | ({ action: "goal_seek_preview" } & GoalSeekFields)
  | ({ action: "goal_seek_apply"; previewToken: string } & GoalSeekFields)
  | { action: "cancel"; previewToken: string }
  | { action: "scenario_list"; sheetKey: string }
  | { action: "scenario_merge";
    sourceSheetKey: string;
    targetSheetKey: string;
  expectedWorkbookRevision?: number
  | null; readOnly?: boolean; }
  | { action: "scenario_summary";
    sheetKey: string;
    resultCells?: ContractWhatIfCellRef[];
  reportKind?: "summary"
  | "pivot_table"; reportLocale?: string; expectedWorkbookRevision?: number
  | null; readOnly?: boolean; }
  | { action: "scenario_upsert"; sheetKey: string; name: string; comment?: string
  | null; locked?: boolean; hidden?: boolean; inputs: ContractWhatIfScenarioInput[]; expectedWorkbookRevision?: number
  | null; readOnly?: boolean; }
  | { action: "scenario_delete"; sheetKey: string; name: string; expectedWorkbookRevision?: number
  | null; readOnly?: boolean; }
  | { action: "scenario_show"; sheetKey: string; name: string; expectedWorkbookRevision?: number
  | null; readOnly?: boolean; }
  | ({ action: "data_table_preview" } & DataTableFields)
  | ({ action: "data_table_apply"; previewToken: string } & DataTableFields);
```
 ### ContractWhatIfValue [Заголовок раздела «ContractWhatIfValue»](#contractwhatifvalue) 
```ts
type ContractWhatIfValue =
  | { kind: "blank" }
  | { kind: "empty_string" }
  | { kind: "number"; value: number }
  | { kind: "text"; value: string }
  | { kind: "boolean"; value: boolean }
  | { kind: "error"; value: string };
```
 ### ContractWordArtPayload [Заголовок раздела «ContractWordArtPayload»](#contractwordartpayload) 
```ts
interface ContractWordArtPayload {
  status: ContractWordArtRenderStatus;
  textTransform: string;
  themeReferences: string[];
}
```
 ### ContractWordArtRenderStatus [Заголовок раздела «ContractWordArtRenderStatus»](#contractwordartrenderstatus) 
```ts
type ContractWordArtRenderStatus = "live-supported" | "unsupported-transform";
```
 ### ContractWritingModePlaceholder [Заголовок раздела «ContractWritingModePlaceholder»](#contractwritingmodeplaceholder) 
```ts
type ContractWritingModePlaceholder = "horizontal-tb";
```
 ### ContractXlsbDirtySaveProfile [Заголовок раздела «ContractXlsbDirtySaveProfile»](#contractxlsbdirtysaveprofile) 
```ts
type ContractXlsbDirtySaveProfile = (typeof CONTRACT_XLSB_DIRTY_SAVE_PROFILE_IDS)[number];
```
 ### ContractXlsxDataViewStatePatch [Заголовок раздела «ContractXlsxDataViewStatePatch»](#contractxlsxdataviewstatepatch) 
```ts
interface ContractXlsxDataViewStatePatch {
  activeSheetPath: string;
  activeViewId?: "A" | "B" | "none" | null;
  views: ContractXlsxDataViewStateViewPatch[];
  source?: "fastsheet-data-view-manager-v1" | string | null;
}
```
 ### ContractXlsxDataViewStateViewPatch [Заголовок раздела «ContractXlsxDataViewStateViewPatch»](#contractxlsxdataviewstateviewpatch) 
```ts
interface ContractXlsxDataViewStateViewPatch {
  viewId: "A" | "B";
  selectedRangeLabel: string;
  filterRegion?: string | null;
  sortKey?: "amount" | "score" | "none" | null;
  sortDescending?: boolean | null;
  active?: boolean | null;
  status?: string | null;
}
```
 ### ContractXlsxDelimitedDataConnectionDeletePatch [Заголовок раздела «ContractXlsxDelimitedDataConnectionDeletePatch»](#contractxlsxdelimiteddataconnectiondeletepatch) 
```ts
interface ContractXlsxDelimitedDataConnectionDeletePatch {
  sourcePath: string;
  targetSheetPath: string;
  targetRef?: string | null;
  targetTableName?: string | null;
}
```
 ### ContractXlsxDelimitedDataConnectionPatch [Заголовок раздела «ContractXlsxDelimitedDataConnectionPatch»](#contractxlsxdelimiteddataconnectionpatch) 
```ts
interface ContractXlsxDelimitedDataConnectionPatch {
  kind?:
    | "text-csv-connection"
    | "web-csv-connection"
    | "database-json-query"
    | "power-query-transform"
    | string
    | null;
  name?: string | null;
  sourcePath: string;
  sourceUri?: string | null;
  fileName?: string | null;
  loadKind?: "table" | "connection-only" | string | null;
  layout?: ContractDelimitedOpenLayout | null;
  fixedWidthBreaks?: number[] | null;
  delimiters?: string[] | null;
  customDelimiter?: string | null;
  textQualifier?: ContractDelimitedTextQualifier | null;
  consecutiveDelimitersAsOne?: boolean | null;
  delimiter?: string | null;
  encoding?: ContractDelimitedSaveEncoding | null;
  interpretation?: ContractDelimitedInterpretation | null;
  locale?: ContractDelimitedLocale | null;
  decimalSeparator?: string | null;
  thousandsSeparator?: string | null;
  columnRules?: ContractXlsxDelimitedColumnRulePatch[] | null;
  importStartRow?: number | null;
  header?: "auto" | "present" | "absent" | null;
  destination?: "selected-anchor" | "new-sheet" | null;
  destinationAnchor?: string | null;
  targetSheetPath: string;
  targetRef: string;
  targetTableName?: string | null;
  tablePath?: string | null;
  startRow: number;
  startCol: number;
  rowCount: number;
  columnCount: number;
  delimiterLabel?: string | null;
  query?: string | null;
  sourceRange?: string | null;
  transform?: string | null;
  refreshOnOpen?: boolean | null;
  importedAt?: string | null;
  refreshedAt?: string | null;
  refreshState?: "imported" | "refreshed" | string | null;
}
```
 ### ContractXlsxLegacyNoteMutationPatch [Заголовок раздела «ContractXlsxLegacyNoteMutationPatch»](#contractxlsxlegacynotemutationpatch) 
```ts
interface ContractXlsxLegacyNoteMutationPatch {
  activeSheetPath: string;
  cellRef: string;
  action: "upsert" | "delete";
  annotationId?: string | null;
  text?: string | null;
  author?: string | null;
  visible?: boolean | null;
  richTextRuns?: ContractCommentRichTextRun[] | null;
}
```
 ### ContractXlsxSavePatch [Заголовок раздела «ContractXlsxSavePatch»](#contractxlsxsavepatch) 
```ts
interface ContractXlsxSavePatch {
  objectSelectionPaneCommands?:
    ContractObjectSelectionPanePackageCommand[] | null;


  workbookAccessibilityFixes?: ContractWorkbookAccessibilityPackageFix[] | null;


  fileSharingReadOnlyRecommended?: boolean | null;
  dataValidationListRules?: ContractXlsxDataValidationListRulePatch[] | null;
  dataValidationRules?: ContractXlsxDataValidationRulePatch[] | null;
  dataValidationClearRules?: ContractXlsxDataValidationClearRulePatch[] | null;
  dataValidationMessageRules?:
    ContractXlsxDataValidationMessageRulePatch[] | null;
  chartCreations?: ContractXlsxChartCreationPatch[] | null;
  drawingImageCreations?: ContractXlsxDrawingImageCreationPatch[] | null;
  sheetBackground?: ContractXlsxSheetBackgroundPatch | null;
  chartObjectMoves?: ContractXlsxChartObjectMovePatch[] | null;
  drawingObjectMoves?: ContractXlsxDrawingObjectMovePatch[] | null;
  drawingObjectDeletions?: ContractXlsxDrawingObjectDeletionPatch[] | null;
  drawingObjectMetadataUpdates?:
    ContractXlsxDrawingObjectMetadataPatch[] | null;
  drawingObjectZOrderUpdates?: ContractXlsxDrawingObjectZOrderPatch[] | null;
  drawingObjectImageTransforms?:
    ContractXlsxDrawingObjectImageTransformPatch[] | null;
  drawingObjectGroups?: ContractXlsxDrawingObjectGroupPatch[] | null;
  drawingObjectUngroups?: ContractXlsxDrawingObjectUngroupPatch[] | null;
  textBoxSheets?: ContractXlsxTextBoxSheetPatch[] | null;
  shapeSheets?: ContractXlsxShapeSheetPatch[] | null;
  chartSeriesUpdates?: ContractXlsxChartSeriesUpdatePatch[] | null;
  chartMutations?: ContractXlsxChartMutationPatch[] | null;
  workbookActiveSheets?: ContractXlsxWorkbookActiveSheetPatch[] | null;
  workbookViewSelections?: ContractXlsxWorkbookViewSelectionPatch[] | null;
  dataViewStates?: ContractXlsxDataViewStatePatch[] | null;
  delimitedDataConnections?: ContractXlsxDelimitedDataConnectionPatch[] | null;
  delimitedDataConnectionDeletes?:
    ContractXlsxDelimitedDataConnectionDeletePatch[] | null;
  worksheetViews?: ContractXlsxWorksheetViewPatch[] | null;
  worksheetPrintOptions?: ContractXlsxWorksheetPrintOptionsPatch[] | null;
  worksheetPageSetups?: ContractXlsxWorksheetPageSetupPatch[] | null;
  worksheetHeaderFooters?: ContractXlsxWorksheetHeaderFooterPatch[] | null;
  worksheetHeaderFooterClears?:
    ContractXlsxWorksheetHeaderFooterClearPatch[] | null;
  worksheetPageBreaks?: ContractXlsxWorksheetPageBreakPatch[] | null;
  worksheetPageBreakResets?: ContractXlsxWorksheetPageBreakResetPatch[] | null;
  definedNames?: ContractXlsxDefinedNamePatch[] | null;
  definedNameDeletes?: ContractXlsxDefinedNameDeletePatch[] | null;
  printAreas?: ContractXlsxPrintAreaPatch[] | null;
  printAreaClears?: ContractXlsxPrintAreaClearPatch[] | null;
  printAreaAdds?: ContractXlsxPrintAreaPatch[] | null;
  printTitles?: ContractXlsxPrintTitlesPatch[] | null;
  printTitleClears?: ContractXlsxPrintTitlesClearPatch[] | null;
  workbookTheme?: ContractXlsxWorkbookThemePatch | null;
  workbookThemeColors?: ContractXlsxWorkbookThemeColorsPatch | null;
  rowOutlineGroups?: ContractXlsxRowOutlineGroupPatch[] | null;
  rowOutlineUngroups?: ContractXlsxRowOutlineUngroupPatch[] | null;
  rowOutlineRanges?: ContractXlsxRowOutlineRangePatch[] | null;
  columnOutlineGroups?: ContractXlsxColumnOutlineGroupPatch[] | null;
  columnOutlineUngroups?: ContractXlsxColumnOutlineUngroupPatch[] | null;
  columnOutlineRanges?: ContractXlsxColumnOutlineRangePatch[] | null;
  cellShifts?: ContractXlsxCellShiftPatch[] | null;
  cellCopies?: ContractXlsxCellCopyPatch[] | null;
  cellFormatPatches?: ContractXlsxCellFormatPatch[] | null;
  trackTransfers?: ContractXlsxTrackTransferPatch[] | null;
  sheetFormats?: ContractXlsxSheetFormatPatch[] | null;
  richTextRunUpdates?: ContractXlsxRichTextRunPatch[] | null;
  legacyNoteMutations?: ContractXlsxLegacyNoteMutationPatch[] | null;
  threadedCommentMutations?: ContractXlsxThreadedCommentMutationPatch[] | null;
  pivotTableCreations?: ContractXlsxPivotTableCreationPatch[] | null;
  pivotTableDeletions?: ContractXlsxPivotTableDeletionPatch[] | null;
  pivotTableRefreshes?: ContractXlsxPivotTableRefreshPatch[] | null;
  pivotTableValueSummaries?: ContractXlsxPivotTableValueSummaryPatch[] | null;
  pivotTableShowValuesAs?: ContractXlsxPivotTableShowValuesAsPatch[] | null;
  pivotTableFieldSorts?: ContractXlsxPivotTableFieldSortPatch[] | null;
  pivotTableFieldFilters?: ContractXlsxPivotTableFieldFilterPatch[] | null;
  pivotTableClearFilters?: ContractXlsxPivotTableClearFiltersPatch[] | null;
  pivotTableClearAll?: ContractXlsxPivotTableClearAllPatch[] | null;
  pivotTableMoves?: ContractXlsxPivotTableMovePatch[] | null;
  pivotTableFieldRemovals?: ContractXlsxPivotTableFieldRemovalPatch[] | null;
  pivotTableFieldMoves?: ContractXlsxPivotTableFieldMovePatch[] | null;
  pivotTableFieldAdditions?: ContractXlsxPivotTableFieldAdditionPatch[] | null;
  pivotTableValueFieldAdditions?:
    ContractXlsxPivotTableValueFieldAdditionPatch[] | null;
  pivotTableCalculatedFields?:
    ContractXlsxPivotTableCalculatedFieldPatch[] | null;
  pivotTableItemGroups?: ContractXlsxPivotTableItemGroupPatch[] | null;
  pivotTableSourceChanges?: ContractXlsxPivotTableSourceChangePatch[] | null;
  pivotTableItemDetails?: ContractXlsxPivotTableItemDetailPatch[] | null;
  pivotTableReportLayouts?: ContractXlsxPivotTableReportLayoutPatch[] | null;
  pivotTableStyles?: ContractXlsxPivotTableStylePatch[] | null;
  pivotTableFieldSettings?: ContractXlsxPivotTableFieldSettingsPatch[] | null;
  workbookProtection?: ContractXlsxWorkbookProtectionPatch | null;
}
```
 ### ContractXlsxWorksheetViewPatch [Заголовок раздела «ContractXlsxWorksheetViewPatch»](#contractxlsxworksheetviewpatch) 
```ts
interface ContractXlsxWorksheetViewPatch {
  activeSheetPath: string;
  gridLinesVisible?: boolean | null;
  headingsVisible?: boolean | null;
  workbookViewMode?: "normal" | "page-layout" | "page-break-preview" | null;
  scrollTopLeftCell?: string | null;
  zoomScale?: number | null;
  sheetViews?: ContractWorkbookNamedView[] | null;
  sheetViewActiveId?: string | null;
  customViews?: ContractWorkbookNamedView[] | null;
  customViewActiveId?: string | null;
}
```
 ### FileIdentityDescriptor [Заголовок раздела «FileIdentityDescriptor»](#fileidentitydescriptor) 
```ts
interface FileIdentityDescriptor {
  canonicalPath: string;
  byteLen: number;
  contentStamp: string;
}
```
 ### FileKindDescriptor [Заголовок раздела «FileKindDescriptor»](#filekinddescriptor) 
```ts
type FileKindDescriptor = "csv" | "workbook";
```
 ### FileRefreshDescriptor [Заголовок раздела «FileRefreshDescriptor»](#filerefreshdescriptor) 
```ts
interface FileRefreshDescriptor {
  savedIdentity: FileIdentityDescriptor;
}
```
 ### FileSourceDescriptor [Заголовок раздела «FileSourceDescriptor»](#filesourcedescriptor) 
```ts
interface FileSourceDescriptor {
  workbookId: string;
  queryId: string;
  fileKind: FileKindDescriptor;
  pickPath: string;
  selector?: WorkbookSelectorDescriptor;
  maxBytes?: number;
  expectedIdentity?: FileIdentityDescriptor;
  refresh?: FileRefreshDescriptor;
  revoked?: boolean;
}
```
 ### FoldExplainPlan [Заголовок раздела «FoldExplainPlan»](#foldexplainplan) 
```ts
interface FoldExplainPlan {
  stages: FoldExplainStage[];


  foldBoundaryIndex: number;


  remote?: FoldExplainRemote;


  planHash: string;


  nativeSql?: string;
}
```
 ### FoldExplainRemote [Заголовок раздела «FoldExplainRemote»](#foldexplainremote) 
```ts
interface FoldExplainRemote {
  transport: "odata";
  options: FoldExplainRemoteOptions;
}
```
 ### FoldExplainRemoteOptions [Заголовок раздела «FoldExplainRemoteOptions»](#foldexplainremoteoptions) 
```ts
interface FoldExplainRemoteOptions {
  select?: string;
  filter?: string;
  orderby?: string;
  top?: number;
  skip?: number;
}
```
 ### FoldExplainStage [Заголовок раздела «FoldExplainStage»](#foldexplainstage) 
```ts
interface FoldExplainStage {
  op: string;
  placement: FoldPlacement;


  reason?: string;


  detail: string;
}
```
 ### FoldPlacement [Заголовок раздела «FoldPlacement»](#foldplacement) 
```ts
type FoldPlacement = "folded" | "local-remainder" | "blocked";
```
 ### FolderNavigatorEntryWire [Заголовок раздела «FolderNavigatorEntryWire»](#foldernavigatorentrywire) 
```ts
interface FolderNavigatorEntryWire {
  id: string;
  name: string;
  extension: string;
  size: number;
  fingerprint: number;
}
```
 ### FolderNavigatorFileDiagnosticWire [Заголовок раздела «FolderNavigatorFileDiagnosticWire»](#foldernavigatorfilediagnosticwire) 
```ts
interface FolderNavigatorFileDiagnosticWire {
  file_id: string;
  reason_code: string;
}
```
 ### FolderNavigatorOutcome [Заголовок раздела «FolderNavigatorOutcome»](#foldernavigatoroutcome) 
```ts
type FolderNavigatorOutcome =
  | { status: "entries"; entries: FolderNavigatorEntryWire[] }
  | { status: "preview"; table: Extract< ContractPowerQueryTransformOutcome, { status: "evaluated" } >; }
  | { status: "combined";
    table: Extract< ContractPowerQueryTransformOutcome, { status: "evaluated" } >;
    diagnostics: FolderNavigatorFileDiagnosticWire[];
  }
  | { status: "refresh_plan";
    added: string[];
    changed: string[];
    deleted: string[];
    restored: string[];
    unchanged_count: number;
    lineage_json: string;
    digest: number;
  }
  | { status: "package_ledger_digest"; digest: number }
  | { status: "blocked"; reason: string; detail: string };
```
 ### FolderSourceDescriptor [Заголовок раздела «FolderSourceDescriptor»](#foldersourcedescriptor) 
```ts
interface FolderSourceDescriptor {
  workbookId: string;
  queryId: string;
  rootPath: string;
  includeGlob?: string;
  excludeGlob?: string;
  recursive?: boolean;
  maxFiles?: number;
  maxTotalBytes?: number;
  revoked?: boolean;
}
```
 ### FoldingVerdict [Заголовок раздела «FoldingVerdict»](#foldingverdict) 
```ts
interface FoldingVerdict {
  state: "folded" | "partially-folded" | "local";
  viewNativeQueryEnabled: boolean;
  nativeQuery?: FoldingNativeQuery;
}
```
 ### InspectorAstNode [Заголовок раздела «InspectorAstNode»](#inspectorastnode) 
```ts
interface InspectorAstNode {
  nodeId: number;
  kind: string;
  detail?: string;
  span: MWireSpan;
  sourceSlice: string;
  children: InspectorAstNode[];
}
```
 ### InspectorBinding [Заголовок раздела «InspectorBinding»](#inspectorbinding) 
```ts
interface InspectorBinding {
  name: string;
  span: MWireSpan;


  scopeDepth: number;


  shadowsOuter: boolean;


  isClosureCaptured: boolean;


  references: string[];


  kind: string;
}
```
 ### InspectorBuiltinRef [Заголовок раздела «InspectorBuiltinRef»](#inspectorbuiltinref) 
```ts
interface InspectorBuiltinRef {
  name: string;
  isRegistered: boolean;


  migrationClass: string;
}
```
 ### InspectorDiagnostic [Заголовок раздела «InspectorDiagnostic»](#inspectordiagnostic) 
```ts
interface InspectorDiagnostic {
  phase: string;
  severity: string;
  code: string;
  message: string;
  span: MWireSpan;


  astNodeId?: number;
}
```
 ### InspectorLineage [Заголовок раздела «InspectorLineage»](#inspectorlineage) 
```ts
interface InspectorLineage {
  referencedBuiltins: InspectorBuiltinRef[];


  referencedIdentifiers: string[];


  capability: string;
}
```
 ### InspectorOutcome [Заголовок раздела «InspectorOutcome»](#inspectoroutcome) 
```ts
interface InspectorOutcome {


  status: string;
  value?: MWireValue;
  error?: MWireError;


  valueKind?: string;
}
```
 ### LookupIndexHandleInfo [Заголовок раздела «LookupIndexHandleInfo»](#lookupindexhandleinfo) 
```ts
interface LookupIndexHandleInfo {
  handle: number;
  mode: LookupIndexMode;
  range: CellRange;
  rowCount: number;
  colCount: number;
}
```
 ### LookupIndexMode [Заголовок раздела «LookupIndexMode»](#lookupindexmode) 
```ts
type LookupIndexMode = "table-first-column" | "one-dimensional-scan";
```
 ### MExpressionOutcome [Заголовок раздела «MExpressionOutcome»](#mexpressionoutcome) 
```ts
type MExpressionOutcome =
  | { status: "ok"; value: MWireValue; diagnostics: MWireDiagnostic[]; ast?: MWireAstNode; }
  | { status: "diagnostics"; diagnostics: MWireDiagnostic[]; ast?: MWireAstNode; }
  | { status: "eval-error"; error: MWireError; diagnostics: MWireDiagnostic[]; ast?: MWireAstNode; };
```
 ### MWireAstNode [Заголовок раздела «MWireAstNode»](#mwireastnode) 
```ts
interface MWireAstNode {
  kind: string;
  detail?: string;
  span: MWireSpan;
  children: MWireAstNode[];
}
```
 ### MWireDiagnostic [Заголовок раздела «MWireDiagnostic»](#mwirediagnostic) 
```ts
interface MWireDiagnostic {
  phase: "lex" | "parse" | "bind" | "eval";
  severity: "error" | "warning";
  code: string;
  message: string;
  span: MWireSpan;
}
```
 ### MWireError [Заголовок раздела «MWireError»](#mwireerror) 
```ts
interface MWireError {
  reason: string;
  message: string;
  span: MWireSpan;
}
```
 ### MWireField [Заголовок раздела «MWireField»](#mwirefield) 
```ts
interface MWireField {
  name: string;
  value: MWireValue;
}
```
 ### MWireFunctionType [Заголовок раздела «MWireFunctionType»](#mwirefunctiontype) 
```ts
interface MWireFunctionType {
  required: MWireType[];
  optional: MWireType[];
  returns: MWireType;
}
```
 ### MWireListType [Заголовок раздела «MWireListType»](#mwirelisttype) 
```ts
interface MWireListType {
  item: MWireType;
}
```
 ### MWireMetadataField [Заголовок раздела «MWireMetadataField»](#mwiremetadatafield) 
```ts
interface MWireMetadataField {
  name: string;
  value: MWireValue;
}
```
 ### MWireMetadataRecord [Заголовок раздела «MWireMetadataRecord»](#mwiremetadatarecord) 
```ts
interface MWireMetadataRecord {
  fields: MWireMetadataField[];
}
```
 ### MWirePosition [Заголовок раздела «MWirePosition»](#mwireposition) 
```ts
interface MWirePosition {
  line: number;
  column: number;
}
```
 ### MWireRecordType [Заголовок раздела «MWireRecordType»](#mwirerecordtype) 
```ts
interface MWireRecordType {
  fields: MWireTypeField[];
  open: boolean;
}
```
 ### MWireSpan [Заголовок раздела «MWireSpan»](#mwirespan) 
```ts
interface MWireSpan {
  startByte: number;
  endByte: number;
  start: MWirePosition;
  end: MWirePosition;
}
```
 ### MWireType [Заголовок раздела «MWireType»](#mwiretype) 
```ts
interface MWireType {
  kind: "type";
  name: MWireTypeName;
  nullable: boolean;
  display: string;


  record?: MWireRecordType;


  table?: MWireTableRowType;


  function?: MWireFunctionType;


  list?: MWireListType;
}
```
 ### MWireTypeField [Заголовок раздела «MWireTypeField»](#mwiretypefield) 
```ts
interface MWireTypeField {
  name: string;
  optional: boolean;
  type: MWireType;
}
```
 ### MWireValue [Заголовок раздела «MWireValue»](#mwirevalue) 
```ts
type MWireValue = MWireValueVariant & { meta?: MWireMetadataRecord; };
```
 ### MWireValueVariant [Заголовок раздела «MWireValueVariant»](#mwirevaluevariant) 
```ts
type MWireValueVariant =
  | { kind: "null" }
  | { kind: "logical"; value: boolean }
  | { kind: "number"; value: string; isInteger: boolean }
  | { kind: "text"; value: string }
  | { kind: "list"; items: MWireValue[] }
  | { kind: "record"; fields: MWireField[] }
  | { kind: "function"; builtinName?: string; isClosure: boolean }
  | { kind: "error"; reason: string; message: string; span: MWireSpan }
  | { kind: "table"; columns: string[]; rows: MWireValue[][]; schema: MWireTableSchema; }
  | MWireType
  | { kind: "integer"; value: string }
  | { kind: "date"; year: number; month: number; day: number }
  | { kind: "datetime";
    year: number;
    month: number;
    day: number;
    hour: number;
    minute: number;
    second: number;
    nano: number;
  }
  | { kind: "datetimezone";
    year: number;
    month: number;
    day: number;
    hour: number;
    minute: number;
    second: number;
    nano: number;
    offsetMinutes: number;
  }
  | { kind: "time"; hour: number; minute: number; second: number; nano: number }
  | { kind: "duration";
    negative: boolean;
    days: number;
    hours: number;
    minutes: number;
    seconds: number;
    nano: number;
  }
  | { kind: "binary"; byteLength: number; base64: string };
```
 ### RequestedBackendField [Заголовок раздела «RequestedBackendField»](#requestedbackendfield) 
```ts
interface RequestedBackendField {
  requestedBackend?: ComputeBackendKind | null;
}
```
 ### SourceGridDescriptor [Заголовок раздела «SourceGridDescriptor»](#sourcegriddescriptor) 
```ts
interface SourceGridDescriptor {
  rows: SourceCellDescriptor[][];
}
```
 ### SourceRequestDescriptor [Заголовок раздела «SourceRequestDescriptor»](#sourcerequestdescriptor) 
```ts
interface SourceRequestDescriptor {
  sheetName: string;
  sheetExists: boolean;
  rangeRows: number;
  rangeColumns: number;
  promoteHeaders: boolean;
}
```
 ### StepMutation [Заголовок раздела «StepMutation»](#stepmutation) 
```ts
type StepMutation =
  | { kind: "insert"; afterStepId?: string; displayName: string; canonicalM: string; }
  | { kind: "edit"; stepId: string; canonicalM: string; }
  | { kind: "delete"; stepId: string; }
  | { kind: "rename"; stepId: string; newName: string; }
  | { kind: "reorder"; stepId: string; targetIndex: number; };
```
 ### StepMutationOutcome [Заголовок раздела «StepMutationOutcome»](#stepmutationoutcome) 
```ts
interface StepMutationOutcome {


  status: "ok" | "blocked";


  steps: AppliedStep[];


  selectedStepId?: string;


  reason?: string;


  detail?: string;
}
```
 ### StepMutationResult [Заголовок раздела «StepMutationResult»](#stepmutationresult) 
```ts
interface StepMutationResult {


  projection: AppliedStepsProjection;


  outcome: StepMutationOutcome;
}
```
 ### WebSourceResolverEntry [Заголовок раздела «WebSourceResolverEntry»](#websourceresolverentry) 
```ts
interface WebSourceResolverEntry {
  host: string;
  ips: string[];
}
```
 ### WebSourceTestAllowlist [Заголовок раздела «WebSourceTestAllowlist»](#websourcetestallowlist) 
```ts
interface WebSourceTestAllowlist {
  allowHttp?: boolean;
  extraAllowedHosts?: string[];
  extraAllowedPorts?: number[];
  resolver?: WebSourceResolverEntry[];
}
```

# Типы: данные и объекты листа

> Определения типов Compute Contract — фильтры, таблицы, проверка данных, срезы, импорт и анализ. Имён: 74.

Определения имён из колонки «Тип TypeScript» на страницах операций. Другие темы словаря: [сеанс, книга и листы](/reference/f1/types-session/) · [ячейки и диапазоны](/reference/f1/types-cells/) · [формулы и вычисления](/reference/f1/types-formulas/) · [форматирование](/reference/f1/types-format/) · **данные и объекты листа** · [сводные таблицы](/reference/f1/types-pivot/) · [диаграммы и графика](/reference/f1/types-charts/) · [печать и разметка страницы](/reference/f1/types-print/) · [Power Query](/reference/f1/types-powerquery/) · [VBA и макросы](/reference/f1/types-vba/) · [защита и рецензирование](/reference/f1/types-protection/) · [общие и служебные](/reference/f1/types-common/). ### ContractAdvancedFilterAction [Заголовок раздела «ContractAdvancedFilterAction»](#contractadvancedfilteraction) 
```ts
type ContractAdvancedFilterAction = "filter_in_place" | "copy_to_range";
```
 ### ContractAdvancedFilterProjectedCell [Заголовок раздела «ContractAdvancedFilterProjectedCell»](#contractadvancedfilterprojectedcell) 
```ts
interface ContractAdvancedFilterProjectedCell {
  row: number;
  col: number;
  value: string;
  valueKind?: string | null;
}
```
 ### ContractAnalyzeInsightCard [Заголовок раздела «ContractAnalyzeInsightCard»](#contractanalyzeinsightcard) 
```ts
interface ContractAnalyzeInsightCard {
  stableId: string;
  kind: ContractAnalyzeInsightKind;
  titleCode: string;
  summary: string;
  score: number;
  insertion: ContractAnalyzeInsightsInsertion;
  chartType?: string | null;
  insertable: boolean;
}
```
 ### ContractAnalyzeInsightKind [Заголовок раздела «ContractAnalyzeInsightKind»](#contractanalyzeinsightkind) 
```ts
type ContractAnalyzeInsightKind = | "summary" | "trend" | "outliers" | "grouping" | "correlation" | "suitable_chart";
```
 ### ContractAnalyzeInsightsInsertion [Заголовок раздела «ContractAnalyzeInsightsInsertion»](#contractanalyzeinsightsinsertion) 
```ts
type ContractAnalyzeInsightsInsertion = "table" | "chart" | "pivot_table";
```
 ### ContractAnalyzeInsightsPlan [Заголовок раздела «ContractAnalyzeInsightsPlan»](#contractanalyzeinsightsplan) 
```ts
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 [Заголовок раздела «ContractAutoFilterDateGroupMetadata»](#contractautofilterdategroupmetadata) 
```ts
interface ContractAutoFilterDateGroupMetadata {
  year?: number | null;
  month?: number | null;
  day?: number | null;
  hour?: number | null;
  minute?: number | null;
  second?: number | null;
  dateTimeGrouping: string;
}
```
 ### ContractConsolidateFunction [Заголовок раздела «ContractConsolidateFunction»](#contractconsolidatefunction) 
```ts
type ContractConsolidateFunction =
  | "sum"
  | "count"
  | "average"
  | "max"
  | "min"
  | "product"
  | "countNumbers"
  | "stdDev"
  | "stdDevp"
  | "var"
  | "varp";
```
 ### ContractConsolidationMutation [Заголовок раздела «ContractConsolidationMutation»](#contractconsolidationmutation) 
```ts
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 [Заголовок раздела «ContractCustomViewFilterSnapshot»](#contractcustomviewfiltersnapshot) 
```ts
interface ContractCustomViewFilterSnapshot {
  sheetKey: string;
  targetKind: ContractCustomViewFilterTargetKind;
  targetId: string;
  stateXml?: string;
}
```
 ### ContractCustomViewFilterTargetKind [Заголовок раздела «ContractCustomViewFilterTargetKind»](#contractcustomviewfiltertargetkind) 
```ts
type ContractCustomViewFilterTargetKind = "worksheet" | "table";
```
 ### ContractCustomViewOutlineAxis [Заголовок раздела «ContractCustomViewOutlineAxis»](#contractcustomviewoutlineaxis) 
```ts
type ContractCustomViewOutlineAxis = "row" | "column";
```
 ### ContractDataAnalysisGrouping [Заголовок раздела «ContractDataAnalysisGrouping»](#contractdataanalysisgrouping) 
```ts
type ContractDataAnalysisGrouping = "columns" | "rows";
```
 ### ContractDataValidationContinuation [Заголовок раздела «ContractDataValidationContinuation»](#contractdatavalidationcontinuation) 
```ts
interface ContractDataValidationContinuation {
  token: string;
  decision: ContractDataValidationDecision;
}
```
 ### ContractDataValidationDecision [Заголовок раздела «ContractDataValidationDecision»](#contractdatavalidationdecision) 
```ts
type ContractDataValidationDecision = "retry" | "cancel" | "yes" | "no" | "ok";
```
 ### ContractDataValidationMetadata [Заголовок раздела «ContractDataValidationMetadata»](#contractdatavalidationmetadata) 
```ts
interface ContractDataValidationMetadata {
  rules: ContractDataValidationRule[];
}
```
 ### ContractDataValidationRawInput [Заголовок раздела «ContractDataValidationRawInput»](#contractdatavalidationrawinput) 
```ts
interface ContractDataValidationRawInput {
  sheetKey: string;
  row: number;
  col: number;
  input: string;


  locale?: string | null;


  candidateEdit?: CellInputEdit | null;
}
```
 ### ContractDataValidationRule [Заголовок раздела «ContractDataValidationRule»](#contractdatavalidationrule) 
```ts
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 [Заголовок раздела «ContractDataValidationRuleIntent»](#contractdatavalidationruleintent) 
```ts
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 [Заголовок раздела «ContractDataValidationVerdict»](#contractdatavalidationverdict) 
```ts
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 [Заголовок раздела «ContractDataValidationVerdictKind»](#contractdatavalidationverdictkind) 
```ts
type ContractDataValidationVerdictKind = "accepted" | "rejected" | "decision-required";
```
 ### ContractDelimitedImportDestination [Заголовок раздела «ContractDelimitedImportDestination»](#contractdelimitedimportdestination) 
```ts
interface ContractDelimitedImportDestination {
  kind: ContractDelimitedImportDestinationKind;
  sheetKey?: string | null;
  sheetName?: string | null;
}
```
 ### ContractDelimitedImportDestinationKind [Заголовок раздела «ContractDelimitedImportDestinationKind»](#contractdelimitedimportdestinationkind) 
```ts
type ContractDelimitedImportDestinationKind = "existing-worksheet" | "new-worksheet";
```
 ### ContractDelimitedTextQualifier [Заголовок раздела «ContractDelimitedTextQualifier»](#contractdelimitedtextqualifier) 
```ts
type ContractDelimitedTextQualifier = (typeof CONTRACT_DELIMITED_TEXT_QUALIFIER_IDS)[number];
```
 ### ContractExternalRangeEntry [Заголовок раздела «ContractExternalRangeEntry»](#contractexternalrangeentry) 
```ts
interface ContractExternalRangeEntry {
  identity: ContractExternalRangeIdentity;
  properties: ContractExternalRangeProperties;


  readOnlyFields?: string[];
}
```
 ### ContractExternalRangeIdentity [Заголовок раздела «ContractExternalRangeIdentity»](#contractexternalrangeidentity) 
```ts
interface ContractExternalRangeIdentity {
  name: string;


  queryTablePart: string;


  connectionId: string;
}
```
 ### ContractExternalRangeProperties [Заголовок раздела «ContractExternalRangeProperties»](#contractexternalrangeproperties) 
```ts
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 [Заголовок раздела «ContractExternalReferenceTrustMetadata»](#contractexternalreferencetrustmetadata) 
```ts
interface ContractExternalReferenceTrustMetadata {
  label: string;
  workbookName?: string | null;
  targetSheetName?: string | null;
  targetAddress?: string | null;
  resolutionState: string;
  reason?: string | null;
  cachedDisplayValue?: string | null;
}
```
 ### ContractOutlineAxis [Заголовок раздела «ContractOutlineAxis»](#contractoutlineaxis) 
```ts
type ContractOutlineAxis = "row" | "column";
```
 ### ContractOutlineSubtotalAction [Заголовок раздела «ContractOutlineSubtotalAction»](#contractoutlinesubtotalaction) 
```ts
type ContractOutlineSubtotalAction =
  | "read_state"
  | "group"
  | "ungroup"
  | "collapse"
  | "expand"
  | "show_level"
  | "auto_outline"
  | "clear_outline"
  | "subtotal"
  | "remove_all";
```
 ### ContractOutlineSubtotalState [Заголовок раздела «ContractOutlineSubtotalState»](#contractoutlinesubtotalstate) 
```ts
interface ContractOutlineSubtotalState {
  rowLevels: ContractOutlineTrackState[];
  columnLevels: ContractOutlineTrackState[];
  maxRowLevel: number;
  maxColumnLevel: number;
  summaryBelow: boolean;
  subtotalFormulaKeys: string[];
}
```
 ### ContractRangeFilterAction [Заголовок раздела «ContractRangeFilterAction»](#contractrangefilteraction) 
```ts
type ContractRangeFilterAction = "apply" | "clear_column" | "clear_all" | "reapply";
```
 ### ContractRangeFilterDateGroup [Заголовок раздела «ContractRangeFilterDateGroup»](#contractrangefilterdategroup) 
```ts
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 [Заголовок раздела «ContractRangeFilterNumberOp»](#contractrangefilternumberop) 
```ts
type ContractRangeFilterNumberOp = "eq" | "ne" | "gt" | "ge" | "lt" | "le" | "between";
```
 ### ContractRangeFilterPredicate [Заголовок раздела «ContractRangeFilterPredicate»](#contractrangefilterpredicate) 
```ts
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 [Заголовок раздела «ContractRangeFilterRelativePeriod»](#contractrangefilterrelativeperiod) 
```ts
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 [Заголовок раздела «ContractRangeFilterTextOp»](#contractrangefiltertextop) 
```ts
type ContractRangeFilterTextOp =
  | "equals"
  | "not_equals"
  | "contains"
  | "not_contains"
  | "begins_with"
  | "not_begins_with"
  | "ends_with"
  | "not_ends_with";
```
 ### ContractRichTextRun [Заголовок раздела «ContractRichTextRun»](#contractrichtextrun) 
```ts
interface ContractRichTextRun {
  index: number;
  text: string;
  bold?: boolean;
  italic?: boolean;
  underline?: boolean;
}
```
 ### ContractSlicerTimelineAction [Заголовок раздела «ContractSlicerTimelineAction»](#contractslicertimelineaction) 
```ts
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 [Заголовок раздела «ContractSlicerTimelineControlKind»](#contractslicertimelinecontrolkind) 
```ts
type ContractSlicerTimelineControlKind = "slicer" | "timeline";
```
 ### ContractSlicerTimelineControlView [Заголовок раздела «ContractSlicerTimelineControlView»](#contractslicertimelinecontrolview) 
```ts
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 [Заголовок раздела «ContractSlicerTimelineLevel»](#contractslicertimelinelevel) 
```ts
type ContractSlicerTimelineLevel = "years" | "quarters" | "months" | "days";
```
 ### ContractSlicerTimelineSortOrder [Заголовок раздела «ContractSlicerTimelineSortOrder»](#contractslicertimelinesortorder) 
```ts
type ContractSlicerTimelineSortOrder = "ascending" | "descending" | "source";
```
 ### ContractSlicerTimelineSource [Заголовок раздела «ContractSlicerTimelineSource»](#contractslicertimelinesource) 
```ts
type ContractSlicerTimelineSource =
  | { kind: "table"; tableName: string; sheetKey: string }
  | { kind: "pivot"; pivotCacheId: string; pivotTableNames: string[]; fieldValues: string[]; };
```
 ### ContractSlicerTimelineTargetView [Заголовок раздела «ContractSlicerTimelineTargetView»](#contractslicertimelinetargetview) 
```ts
interface ContractSlicerTimelineTargetView {
  pivotCacheId: string;
  pivotTableName: string;
  cacheGeneration: number;
  matchedRowCount: number;
}
```
 ### ContractSubtotalAggregate [Заголовок раздела «ContractSubtotalAggregate»](#contractsubtotalaggregate) 
```ts
type ContractSubtotalAggregate = "sum" | "count" | "counta" | "average" | "min" | "max" | "product";
```
 ### ContractSubtotalOptions [Заголовок раздела «ContractSubtotalOptions»](#contractsubtotaloptions) 
```ts
interface ContractSubtotalOptions {
  groupByCol: number;
  targetCols: number[];
  aggregate: ContractSubtotalAggregate;
  replaceCurrent?: boolean;
  summaryBelow?: boolean;
  pageBreakBetweenGroups?: boolean;
}
```
 ### ContractTableFilterMetadata [Заголовок раздела «ContractTableFilterMetadata»](#contracttablefiltermetadata) 
```ts
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 [Заголовок раздела «ContractTableHyperlinkAction»](#contracttablehyperlinkaction) 
```ts
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 [Заголовок раздела «ContractTableLifecycleAction»](#contracttablelifecycleaction) 
```ts
type ContractTableLifecycleAction = | "insert" | "rename" | "style" | "filter_metadata" | "refresh" | "convert_to_range" | "delete";
```
 ### ContractTableMetadataEntry [Заголовок раздела «ContractTableMetadataEntry»](#contracttablemetadataentry) 
```ts
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 [Заголовок раздела «ContractTableMetadataProjection»](#contracttablemetadataprojection) 
```ts
interface ContractTableMetadataProjection {
  scope: "active-sheet" | "workbook";
  source: "rust-authoritative-table-model";
  activeSheetPath: string;
  tableCount: number;
  tables: ContractTableMetadataEntry[];
  note: string;
}
```
 ### ContractTableModelMutation [Заголовок раздела «ContractTableModelMutation»](#contracttablemodelmutation) 
```ts
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 [Заголовок раздела «ContractTableSortMetadata»](#contracttablesortmetadata) 
```ts
interface ContractTableSortMetadata {
  ref: string;
  columnRef: string;
  colId: number;
  descending: boolean;
  caseSensitive: boolean;
  columnSort: boolean;
}
```
 ### ContractTextHorizontalAlign [Заголовок раздела «ContractTextHorizontalAlign»](#contracttexthorizontalalign) 
```ts
type ContractTextHorizontalAlign = "left" | "center" | "right";
```
 ### ContractTextParagraph [Заголовок раздела «ContractTextParagraph»](#contracttextparagraph) 
```ts
interface ContractTextParagraph {
  runs: ContractTextRun[];
  horizontalAlign?: ContractTextHorizontalAlign | null;
  rtl?: boolean | null;
  bullet?: string | null;
  level?: number | null;
  preservedPropertiesXml?: string | null;
}
```
 ### ContractTextPayload [Заголовок раздела «ContractTextPayload»](#contracttextpayload) 
```ts
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 [Заголовок раздела «ContractTextPayloadStatus»](#contracttextpayloadstatus) 
```ts
type ContractTextPayloadStatus = "live-editable";
```
 ### ContractTextRun [Заголовок раздела «ContractTextRun»](#contracttextrun) 
```ts
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 [Заголовок раздела «ContractTextVerticalAlign»](#contracttextverticalalign) 
```ts
type ContractTextVerticalAlign = "top" | "middle" | "bottom";
```
 ### ContractTrustCenterExternalPolicy [Заголовок раздела «ContractTrustCenterExternalPolicy»](#contracttrustcenterexternalpolicy) 
```ts
type ContractTrustCenterExternalPolicy = "manual_only" | "block_all";
```
 ### ContractWorksheetAutoFilterMetadata [Заголовок раздела «ContractWorksheetAutoFilterMetadata»](#contractworksheetautofiltermetadata) 
```ts
interface ContractWorksheetAutoFilterMetadata {
  scope: "active-sheet";
  source: "rust-authoritative-worksheet-auto-filter-model";
  activeSheetPath: string;
  ref: string;
  activeFilterColumnIds: number[];
  activeFilters: ContractTableFilterMetadata[];


  filterMode?: boolean | null;
}
```
 ### ContractXlsxDataValidationClearRulePatch [Заголовок раздела «ContractXlsxDataValidationClearRulePatch»](#contractxlsxdatavalidationclearrulepatch) 
```ts
interface ContractXlsxDataValidationClearRulePatch {
  activeSheetPath: string;
  cellRef: string;
}
```
 ### ContractXlsxDataValidationListRulePatch [Заголовок раздела «ContractXlsxDataValidationListRulePatch»](#contractxlsxdatavalidationlistrulepatch) 
```ts
interface ContractXlsxDataValidationListRulePatch {
  activeSheetPath: string;
  sqref: string;
  formula1: string;
  literalListValues: string[];
  sourceLabel?: string | null;
  targetLabel?: string | null;
}
```
 ### ContractXlsxDataValidationMessageRulePatch [Заголовок раздела «ContractXlsxDataValidationMessageRulePatch»](#contractxlsxdatavalidationmessagerulepatch) 
```ts
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 [Заголовок раздела «ContractXlsxDataValidationRulePatch»](#contractxlsxdatavalidationrulepatch) 
```ts
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 [Заголовок раздела «ContractXlsxRichTextRunPatch»](#contractxlsxrichtextrunpatch) 
```ts
interface ContractXlsxRichTextRunPatch {
  activeSheetPath: string;
  cellRef: string;
  runIndex: number;
  text?: string | null;
  bold?: boolean | null;
  italic?: boolean | null;
  underline?: boolean | null;
}
```
 ### ContractXlsxTextBoxObjectPatch [Заголовок раздела «ContractXlsxTextBoxObjectPatch»](#contractxlsxtextboxobjectpatch) 
```ts
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 [Заголовок раздела «MWireTableSchema»](#mwiretableschema) 
```ts
interface MWireTableSchema {
  columnTypes: string[];
}
```
 ### ProductTableRangeLoadToOutcome [Заголовок раздела «ProductTableRangeLoadToOutcome»](#producttablerangeloadtooutcome) 
```ts
interface ProductTableRangeLoadToOutcome {
  placed: boolean;
  loadPlan?: PowerQueryLoadPlan;


  persistedQuery?: unknown;
  blockReason?: string;
  blockDetail?: string;
}
```
 ### ProductTableRangeRefreshOutcome [Заголовок раздела «ProductTableRangeRefreshOutcome»](#producttablerangerefreshoutcome) 
```ts
interface ProductTableRangeRefreshOutcome {
  generation: number;
  phase: "queued" | "running" | "ready" | "finished" | "cancelled" | "blocked";
  completed: number;
  total: number;
  deniedReason?: string;
  deniedMessage?: string;
  outcomes: ProductTableRangeRefreshQueryOutcome[];
}
```
 ### TableRangeOutputPlacement [Заголовок раздела «TableRangeOutputPlacement»](#tablerangeoutputplacement) 
```ts
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 [Заголовок раздела «TableRangeSelector»](#tablerangeselector) 
```ts
type TableRangeSelector = { kind: "table"; tableName: string } | { kind: "range"; rangeRef: string };
```
 ### TableRangeSourceIdentity [Заголовок раздела «TableRangeSourceIdentity»](#tablerangesourceidentity) 
```ts
interface TableRangeSourceIdentity {
  workbookScope: string;
  sheetName: string;
  selector: TableRangeSelector;
}
```

# Типы: форматирование

> Определения типов Compute Contract — стили, шрифты, темы, границы, условное форматирование, строки и столбцы. Имён: 69.

Определения имён из колонки «Тип TypeScript» на страницах операций. Другие темы словаря: [сеанс, книга и листы](/reference/f1/types-session/) · [ячейки и диапазоны](/reference/f1/types-cells/) · [формулы и вычисления](/reference/f1/types-formulas/) · **форматирование** · [данные и объекты листа](/reference/f1/types-data/) · [сводные таблицы](/reference/f1/types-pivot/) · [диаграммы и графика](/reference/f1/types-charts/) · [печать и разметка страницы](/reference/f1/types-print/) · [Power Query](/reference/f1/types-powerquery/) · [VBA и макросы](/reference/f1/types-vba/) · [защита и рецензирование](/reference/f1/types-protection/) · [общие и служебные](/reference/f1/types-common/). ### ColumnProfile [Заголовок раздела «ColumnProfile»](#columnprofile) 
```ts
interface ColumnProfile {


  name: string;


  typeName: ContractPowerQueryCellKind | "mixed" | "null";


  nullCount: number;


  errorCount: number;


  emptyCount: number;


  validCount: number;


  distinctCount: number;


  distinctCapped: boolean;


  distribution: ColumnValueFrequency[];


  validRatio: number;


  errorRatio: number;


  emptyRatio: number;
}
```
 ### ColumnValueFrequency [Заголовок раздела «ColumnValueFrequency»](#columnvaluefrequency) 
```ts
interface ColumnValueFrequency {
  value: string;
  kind: ContractPowerQueryCellKind;
  count: number;
}
```
 ### ContractApplyThemeFontsPatch [Заголовок раздела «ContractApplyThemeFontsPatch»](#contractapplythemefontspatch) 
```ts
interface ContractApplyThemeFontsPatch {
  majorTypeface: string;
  minorTypeface: string;
}
```
 ### ContractCellStyleDefinition [Заголовок раздела «ContractCellStyleDefinition»](#contractcellstyledefinition) 
```ts
interface ContractCellStyleDefinition {
  identity: string;
  name: string;
  builtIn: boolean;
  builtinId?: number | null;
  editable: boolean;
  deletable: boolean;
  duplicable: boolean;
  category: string;
  formatting: ContractCellStyleFormatting;
  xfId: number;
  applicationStyleIndex: number;
  usageCount: number;
  opaque: boolean;
  rawXmlDigest: string;
}
```
 ### ContractCellStyleFormatting [Заголовок раздела «ContractCellStyleFormatting»](#contractcellstyleformatting) 
```ts
type ContractCellStyleFormatting = Omit< ContractPreviewFormatting, "dataBar" | "conditionalIcon" | "conditionalFillKind" >;
```
 ### ContractCellStyleMutation [Заголовок раздела «ContractCellStyleMutation»](#contractcellstylemutation) 
```ts
type ContractCellStyleMutation =
  | { kind: "create"; draftIdentity: string; name: string; basedOnIdentity?: string
  | null; formatting?: ContractCellStyleFormatting
  | null; }
  | { kind: "modify";
    identity: string;
    name: string;
    formatting: ContractCellStyleFormatting;
    expectedRawXmlDigest: string;
  }
  | { kind: "duplicate"; identity: string; draftIdentity: string; name: string; }
  | { kind: "delete"; identity: string; expectedRawXmlDigest: string; };
```
 ### ContractCellStylesManagerAction [Заголовок раздела «ContractCellStylesManagerAction»](#contractcellstylesmanageraction) 
```ts
type ContractCellStylesManagerAction =
  | { action: "inspect" }
  | { action: "commit"; mutations: ContractCellStyleMutation[]; expectedOpaqueStyleIdentities?: string[]; }
  | { action: "applyStyle"; identity: string; target: CellRange }
  | { action: "mergeFromWorkbook"; sourceSubsetId: string; identities?: string[]; };
```
 ### ContractCellStylesManagerAuthority [Заголовок раздела «ContractCellStylesManagerAuthority»](#contractcellstylesmanagerauthority) 
```ts
interface ContractCellStylesManagerAuthority {
  canApply: boolean;
  readOnly: boolean;
  protected: boolean;
  sourceKindLive: boolean;
  refusalCode?: string | null;
}
```
 ### ContractColumnWidth [Заголовок раздела «ContractColumnWidth»](#contractcolumnwidth) 
```ts
interface ContractColumnWidth {
  col: number;
  width: number;
}
```
 ### ContractConditionalComparison [Заголовок раздела «ContractConditionalComparison»](#contractconditionalcomparison) 
```ts
type ContractConditionalComparison = "greaterThan" | "lessThan" | "equalTo";
```
 ### ContractConditionalFormattingManagerAction [Заголовок раздела «ContractConditionalFormattingManagerAction»](#contractconditionalformattingmanageraction) 
```ts
type ContractConditionalFormattingManagerAction =
  | { action: "inspect" }
  | { action: "apply"; rules: ContractConditionalRule[]; expectedOpaqueRuleIdentities?: string[]; };
```
 ### ContractConditionalFormattingManagerAuthority [Заголовок раздела «ContractConditionalFormattingManagerAuthority»](#contractconditionalformattingmanagerauthority) 
```ts
interface ContractConditionalFormattingManagerAuthority {
  canApply: boolean;
  readOnly: boolean;
  protected: boolean;
  sourceKindLive: boolean;
  refusalCode?: string | null;
}
```
 ### ContractConditionalFormattingOpaqueRule [Заголовок раздела «ContractConditionalFormattingOpaqueRule»](#contractconditionalformattingopaquerule) 
```ts
interface ContractConditionalFormattingOpaqueRule {
  identity: string;
  ruleType: string;
  priority: number;
  stopIfTrue: boolean;
  appliesTo: string;
  formulas: string[];
  rawXmlDigest: string;
  editable: false;
  refusalCode: "conditional-formatting-opaque-rule-read-only" | string;
}
```
 ### ContractConditionalPopulationKind [Заголовок раздела «ContractConditionalPopulationKind»](#contractconditionalpopulationkind) 
```ts
type ContractConditionalPopulationKind = "duplicate" | "unique";
```
 ### ContractConditionalRange [Заголовок раздела «ContractConditionalRange»](#contractconditionalrange) 
```ts
interface ContractConditionalRange {
  rowStart: number;
  rowEnd: number;
  colStart: number;
  colEnd: number;
}
```
 ### ContractConditionalRankDirection [Заголовок раздела «ContractConditionalRankDirection»](#contractconditionalrankdirection) 
```ts
type ContractConditionalRankDirection = "top" | "bottom";
```
 ### ContractConditionalRule [Заголовок раздела «ContractConditionalRule»](#contractconditionalrule) 
```ts
interface ContractConditionalRule {
  id: string;
  priority: number;
  stopIfTrue: boolean;
  appliesTo: ContractConditionalRange[];
  kind: ContractConditionalRuleKind;
  visual: ContractConditionalRuleVisual;
  pivotScope?: ContractPivotConditionalRuleScope | null;
}
```
 ### ContractConditionalRuleKind [Заголовок раздела «ContractConditionalRuleKind»](#contractconditionalrulekind) 
```ts
type ContractConditionalRuleKind =
  | { type: "compare"; operator: ContractConditionalComparison; operand: ContractConditionalScalar; }
  | { type: "between"; lower: ContractConditionalScalar; upper: ContractConditionalScalar; }
  | { type: "textContains"; value: string }
  | { type: "population"; value: ContractConditionalPopulationKind }
  | { type: "rank"; direction: ContractConditionalRankDirection; amount: number; percent: boolean; }
  | { type: "average"; above: boolean }
  | { type: "twoColorScale" }
  | { type: "threeColorScale" }
  | { type: "dataBar" }
  | { type: "iconSet" }
  | { type: "formula"; value: string };
```
 ### ContractConditionalRuleVisual [Заголовок раздела «ContractConditionalRuleVisual»](#contractconditionalrulevisual) 
```ts
interface ContractConditionalRuleVisual {
  dxfId?: number | null;
  fillColor?: string | null;
  fontColor?: string | null;
  bold: boolean;
  dataBarColor?: string | null;
  colorScaleColors: string[];
  iconSet?: string | null;
}
```
 ### ContractConditionalScalar [Заголовок раздела «ContractConditionalScalar»](#contractconditionalscalar) 
```ts
type ContractConditionalScalar =
  | { kind: "blank" }
  | { kind: "emptyString" }
  | { kind: "number"; value: number }
  | { kind: "text"; value: string }
  | { kind: "boolean"; value: boolean }
  | { kind: "error"; value: string };
```
 ### ContractDataCleanupPreviewRow [Заголовок раздела «ContractDataCleanupPreviewRow»](#contractdatacleanuppreviewrow) 
```ts
interface ContractDataCleanupPreviewRow {
  sourceRow: number;
  values: ContractDataCleanupPreviewValue[];
  duplicate?: boolean;
}
```
 ### ContractDataCleanupRowSpan [Заголовок раздела «ContractDataCleanupRowSpan»](#contractdatacleanuprowspan) 
```ts
interface ContractDataCleanupRowSpan {
  rowStart: number;
  rowEnd: number;
}
```
 ### ContractDelimitedColumnFormat [Заголовок раздела «ContractDelimitedColumnFormat»](#contractdelimitedcolumnformat) 
```ts
interface ContractDelimitedColumnFormat {
  sourceIndex: number;
  format: ContractTextToColumnsColumnFormat;
}
```
 ### ContractFileFormat [Заголовок раздела «ContractFileFormat»](#contractfileformat) 
```ts
type ContractFileFormat = (typeof CONTRACT_FILE_FORMAT_IDS)[number];
```
 ### ContractFormatCapabilities [Заголовок раздела «ContractFormatCapabilities»](#contractformatcapabilities) 
```ts
interface ContractFormatCapabilities {
  fileFormat: ContractFileFormat;
  containerFamily: ContractContainerFamily;
  openCapability: ContractCapabilityLevel;
  editCapability: ContractCapabilityLevel;
  saveCapability: ContractSaveCapability;
  saveKind: ContractSaveKind;
  fidelityClass: ContractFidelityClass;
  nonGoals: ContractFormatNonGoal[];
}
```
 ### ContractMergeCellsMode [Заголовок раздела «ContractMergeCellsMode»](#contractmergecellsmode) 
```ts
type ContractMergeCellsMode = "merge" | "merge-and-center" | "merge-across";
```
 ### ContractPreviewBorderSide [Заголовок раздела «ContractPreviewBorderSide»](#contractpreviewborderside) 
```ts
interface ContractPreviewBorderSide {
  style: ContractPreviewBorderStyle;
  color?: string | null;
}
```
 ### ContractPreviewBorderStyle [Заголовок раздела «ContractPreviewBorderStyle»](#contractpreviewborderstyle) 
```ts
type ContractPreviewBorderStyle =
  | "thin"
  | "hair"
  | "dotted"
  | "dashed"
  | "dashDot"
  | "dashDotDot"
  | "medium"
  | "mediumDashed"
  | "mediumDashDot"
  | "mediumDashDotDot"
  | "slantDashDot"
  | "thick"
  | "double";
```
 ### ContractPreviewBorders [Заголовок раздела «ContractPreviewBorders»](#contractpreviewborders) 
```ts
interface ContractPreviewBorders {
  left?: ContractPreviewBorderSide | null;
  right?: ContractPreviewBorderSide | null;
  top?: ContractPreviewBorderSide | null;
  bottom?: ContractPreviewBorderSide | null;
  diagonalUp?: ContractPreviewBorderSide | null;
  diagonalDown?: ContractPreviewBorderSide | null;
}
```
 ### ContractPreviewConditionalFillKind [Заголовок раздела «ContractPreviewConditionalFillKind»](#contractpreviewconditionalfillkind) 
```ts
type ContractPreviewConditionalFillKind = "cellIs" | "containsText" | "colorScale";
```
 ### ContractPreviewConditionalIcon [Заголовок раздела «ContractPreviewConditionalIcon»](#contractpreviewconditionalicon) 
```ts
interface ContractPreviewConditionalIcon {
  glyph: string;
  color: string;
  label?: string | null;
}
```
 ### ContractPreviewFontVerticalAlign [Заголовок раздела «ContractPreviewFontVerticalAlign»](#contractpreviewfontverticalalign) 
```ts
type ContractPreviewFontVerticalAlign = "baseline" | "superscript" | "subscript";
```
 ### ContractPreviewFormatting [Заголовок раздела «ContractPreviewFormatting»](#contractpreviewformatting) 
```ts
interface ContractPreviewFormatting {
  fillColor?: string | null;
  gradientFill?: ContractPreviewGradientFill | null;
  patternFill?: ContractPreviewPatternFill | null;
  dataBar?: ContractPreviewDataBar | null;
  conditionalIcon?: ContractPreviewConditionalIcon | null;
  conditionalFillKind?: ContractPreviewConditionalFillKind | null;
  numberFormat?: string | null;
  fontColor?: string | null;
  fontFamily?: string | null;
  fontSize?: number | null;
  bold?: boolean;
  italic?: boolean;
  fontVerticalAlign?: ContractPreviewFontVerticalAlign | null;
  underlineKind?: ContractPreviewUnderlineKind | null;
  underline?: boolean;
  strike?: boolean;
  horizontalAlign?: ContractPreviewHorizontalAlign | null;
  verticalAlign?: ContractPreviewVerticalAlign | null;
  wrapText?: boolean;
  shrinkToFit?: boolean;
  textRotation?: number | null;
  indent?: number | null;
  borders?: ContractPreviewBorders | null;
  locked?: boolean | null;
  hidden?: boolean | null;
}
```
 ### ContractPreviewGradientFill [Заголовок раздела «ContractPreviewGradientFill»](#contractpreviewgradientfill) 
```ts
interface ContractPreviewGradientFill {
  degree?: number | null;
  stops: ContractPreviewGradientStop[];
}
```
 ### ContractPreviewPatternFill [Заголовок раздела «ContractPreviewPatternFill»](#contractpreviewpatternfill) 
```ts
interface ContractPreviewPatternFill {
  kind: ContractPreviewPatternFillKind;
  fgColor?: string | null;
  bgColor?: string | null;
}
```
 ### ContractPreviewPatternFillKind [Заголовок раздела «ContractPreviewPatternFillKind»](#contractpreviewpatternfillkind) 
```ts
type ContractPreviewPatternFillKind =
  | "solid"
  | "darkGray"
  | "mediumGray"
  | "lightGray"
  | "gray125"
  | "gray0625"
  | "darkHorizontal"
  | "darkVertical"
  | "darkDown"
  | "darkUp"
  | "darkGrid"
  | "darkTrellis"
  | "lightHorizontal"
  | "lightVertical"
  | "lightDown"
  | "lightUp"
  | "lightGrid"
  | "lightTrellis";
```
 ### ContractRangeFilterColumnCriteria [Заголовок раздела «ContractRangeFilterColumnCriteria»](#contractrangefiltercolumncriteria) 
```ts
type ContractRangeFilterColumnCriteria = { column: number; } & ContractRangeFilterPredicate;
```
 ### ContractRowHeight [Заголовок раздела «ContractRowHeight»](#contractrowheight) 
```ts
interface ContractRowHeight {
  row: number;
  height: number;
}
```
 ### ContractTableColumnMetadata [Заголовок раздела «ContractTableColumnMetadata»](#contracttablecolumnmetadata) 
```ts
interface ContractTableColumnMetadata {
  id: number | null;
  name: string;
  dataRange?: string | null;
  calculatedColumnFormula?: string | null;
  totalsRowFunction?: string | null;
  totalsRowFormula?: string | null;
}
```
 ### ContractTableStyleDefinition [Заголовок раздела «ContractTableStyleDefinition»](#contracttablestyledefinition) 
```ts
interface ContractTableStyleDefinition {
  identity: string;
  name: string;
  builtIn: boolean;
  category: "light" | "medium" | "dark" | "custom" | string;
  displayOrder: number;
  isDefault: boolean;
  supported: boolean;
  opaque: boolean;
  editable: boolean;
  deletable: boolean;
  duplicable: boolean;
  appliedTableCount: number;
  elements: ContractTableStyleElementDefinition[];
  rawXmlDigest: string;
}
```
 ### ContractTableStyleElementDefinition [Заголовок раздела «ContractTableStyleElementDefinition»](#contracttablestyleelementdefinition) 
```ts
interface ContractTableStyleElementDefinition {
  elementType: string;
  stripeSize?: number | null;
  dxfId?: number | null;
  formatting?: ContractCellStyleFormatting | null;
  opaque: boolean;
  rawXmlDigest: string;
}
```
 ### ContractTableStyleMutation [Заголовок раздела «ContractTableStyleMutation»](#contracttablestylemutation) 
```ts
type ContractTableStyleMutation =
  | { kind: "create"; draftIdentity: string; name: string; basedOnIdentity?: string
  | null; elements?: ContractTableStyleElementDefinition[] }
  | { kind: "modify";
    identity: string;
    name: string;
    elements: ContractTableStyleElementDefinition[];
  expectedRawXmlDigest: string }
  | { kind: "duplicate"; identity: string; draftIdentity: string; name: string }
  | { kind: "delete"; identity: string; expectedRawXmlDigest: string }
  | { kind: "setDefault"; identity: string };
```
 ### ContractTableStyleOptions [Заголовок раздела «ContractTableStyleOptions»](#contracttablestyleoptions) 
```ts
interface ContractTableStyleOptions {
  showHeaderRow: boolean;
  showTotalRow: boolean;
  showFirstColumn: boolean;
  showLastColumn: boolean;
  showRowStripes: boolean;
  showColumnStripes: boolean;
}
```
 ### ContractTableStylesManagerAction [Заголовок раздела «ContractTableStylesManagerAction»](#contracttablestylesmanageraction) 
```ts
type ContractTableStylesManagerAction =
  | { action: "inspect"; tableStableId?: string
  | null }
  | { action: "commit"; mutations: ContractTableStyleMutation[]; expectedOpaqueStyleIdentities?: string[] }
  | { action: "applyStyle"; tableStableId: string; identity: string; options: ContractTableStyleOptions };
```
 ### ContractTableStylesManagerAuthority [Заголовок раздела «ContractTableStylesManagerAuthority»](#contracttablestylesmanagerauthority) 
```ts
interface ContractTableStylesManagerAuthority {
  canApply: boolean;
  readOnly: boolean;
  protected: boolean;
  sourceKindLive: boolean;
  tableMissing: boolean;
  refusalCode?: string | null;
}
```
 ### ContractTableTotalColumn [Заголовок раздела «ContractTableTotalColumn»](#contracttabletotalcolumn) 
```ts
interface ContractTableTotalColumn {
  columnName: string;
  function?: string | null;
  formula?: string | null;
  label?: string | null;
}
```
 ### ContractTextToColumnsAdvancedOptions [Заголовок раздела «ContractTextToColumnsAdvancedOptions»](#contracttexttocolumnsadvancedoptions) 
```ts
interface ContractTextToColumnsAdvancedOptions {
  decimalSeparator?: string | null;
  thousandsSeparator?: string | null;
}
```
 ### ContractTextToColumnsColumnFormat [Заголовок раздела «ContractTextToColumnsColumnFormat»](#contracttexttocolumnscolumnformat) 
```ts
type ContractTextToColumnsColumnFormat = "general" | "text" | "skip" | "date_mdy" | "date_dmy" | "date_ymd";
```
 ### ContractXlsxCellFormatPatch [Заголовок раздела «ContractXlsxCellFormatPatch»](#contractxlsxcellformatpatch) 
```ts
interface ContractXlsxCellFormatPatch {
  activeSheetPath: string;
  cellRef: string;
  fillColor?: string | null;
  patternFill?: ContractPreviewPatternFill | null;
  fontColor?: string | null;
  fontFamily?: string | null;
  fontSize?: number | null;
  numberFormat?: string | null;
  bold?: boolean | null;
  italic?: boolean | null;
  fontVerticalAlign?: ContractPreviewFontVerticalAlign | null;
  underline?: boolean | null;
  strike?: boolean | null;
  horizontalAlign?: string | null;
  verticalAlign?: string | null;
  wrapText?: boolean | null;
  shrinkToFit?: boolean | null;
  locked?: boolean | null;
  hidden?: boolean | null;
  borders?: ContractPreviewBorders | null;
  textRotation?: number | null;
  borderPreset?: string | null;
  diagonalUp?: boolean | null;
  diagonalDown?: boolean | null;
}
```
 ### ContractXlsxColumnOutlineGroupPatch [Заголовок раздела «ContractXlsxColumnOutlineGroupPatch»](#contractxlsxcolumnoutlinegrouppatch) 
```ts
interface ContractXlsxColumnOutlineGroupPatch {
  activeSheetPath: string;
  colStart: number;
  colEnd: number;
  outlineLevel?: number | null;
  hidden?: boolean | null;
}
```
 ### ContractXlsxColumnOutlineRangePatch [Заголовок раздела «ContractXlsxColumnOutlineRangePatch»](#contractxlsxcolumnoutlinerangepatch) 
```ts
interface ContractXlsxColumnOutlineRangePatch {
  activeSheetPath: string;
  colStart: number;
  colEnd: number;
  outlineLevel?: number | null;
  hidden?: boolean | null;
  summaryBelow?: boolean | null;
  summaryRight?: boolean | null;
}
```
 ### ContractXlsxColumnOutlineUngroupPatch [Заголовок раздела «ContractXlsxColumnOutlineUngroupPatch»](#contractxlsxcolumnoutlineungrouppatch) 
```ts
interface ContractXlsxColumnOutlineUngroupPatch {
  activeSheetPath: string;
  colStart: number;
  colEnd: number;
}
```
 ### ContractXlsxDelimitedColumnRulePatch [Заголовок раздела «ContractXlsxDelimitedColumnRulePatch»](#contractxlsxdelimitedcolumnrulepatch) 
```ts
interface ContractXlsxDelimitedColumnRulePatch {
  sourceIndex: number;
  type: "auto" | "general" | "text" | "date" | "skip";
  dateOrder?: "mdy" | "dmy" | "ymd" | null;
}
```
 ### ContractXlsxRowOutlineGroupPatch [Заголовок раздела «ContractXlsxRowOutlineGroupPatch»](#contractxlsxrowoutlinegrouppatch) 
```ts
interface ContractXlsxRowOutlineGroupPatch {
  activeSheetPath: string;
  rowStart: number;
  rowEnd: number;
  outlineLevel?: number | null;
  hidden?: boolean | null;
}
```
 ### ContractXlsxRowOutlineRangePatch [Заголовок раздела «ContractXlsxRowOutlineRangePatch»](#contractxlsxrowoutlinerangepatch) 
```ts
interface ContractXlsxRowOutlineRangePatch {
  activeSheetPath: string;
  rowStart: number;
  rowEnd: number;
  outlineLevel?: number | null;
  hidden?: boolean | null;
  summaryBelow?: boolean | null;
  summaryRight?: boolean | null;
}
```
 ### ContractXlsxRowOutlineUngroupPatch [Заголовок раздела «ContractXlsxRowOutlineUngroupPatch»](#contractxlsxrowoutlineungrouppatch) 
```ts
interface ContractXlsxRowOutlineUngroupPatch {
  activeSheetPath: string;
  rowStart: number;
  rowEnd: number;
}
```
 ### FlashFillCandidateView [Заголовок раздела «FlashFillCandidateView»](#flashfillcandidateview) 
```ts
interface FlashFillCandidateView { id: string; label: string; pattern: Record<string, unknown> }
```
 ### FlashFillExample [Заголовок раздела «FlashFillExample»](#flashfillexample) 
```ts
interface FlashFillExample { sources: FlashFillValue[]; output: FlashFillValue }
```
 ### FlashFillInference [Заголовок раздела «FlashFillInference»](#flashfillinference) 
```ts
interface FlashFillInference {
  candidates: FlashFillCandidateView[];
  selectedCandidateId?: string | null;
  ambiguous: boolean;
  previews: FlashFillPreviewCell[];
  deterministicHash: string;
}
```
 ### FlashFillMode [Заголовок раздела «FlashFillMode»](#flashfillmode) 
```ts
type FlashFillMode = "infer" | "preview" | "apply";
```
 ### FlashFillPreviewCell [Заголовок раздела «FlashFillPreviewCell»](#flashfillpreviewcell) 
```ts
interface FlashFillPreviewCell {
  sheetKey: string;
  row: number;
  col: number;
  value: FlashFillValue;
  skipped: boolean;
}
```
 ### FlashFillRefusalContext [Заголовок раздела «FlashFillRefusalContext»](#flashfillrefusalcontext) 
```ts
interface FlashFillRefusalContext {
  readOnly?: boolean;
  protected?: boolean;
  tableBoundary?: boolean;
  spill?: boolean;
  merged?: boolean;
  cancelled?: boolean;
}
```
 ### FlashFillTargetRow [Заголовок раздела «FlashFillTargetRow»](#flashfilltargetrow) 
```ts
interface FlashFillTargetRow {
  sheetKey: string;
  row: number;
  col: number;
  sources: FlashFillValue[];
  targetHasFormula?: boolean;
  targetIsNonblank?: boolean;
  filteredOut?: boolean;
}
```
 ### FlashFillValue [Заголовок раздела «FlashFillValue»](#flashfillvalue) 
```ts
interface FlashFillValue { kind: FlashFillValueKind; text: string }
```
 ### FlashFillValueKind [Заголовок раздела «FlashFillValueKind»](#flashfillvaluekind) 
```ts
type FlashFillValueKind = | "blank" | "empty-string" | "text" | "number" | "date" | "time" | "error" | "formula";
```
 ### MWireTableRowType [Заголовок раздела «MWireTableRowType»](#mwiretablerowtype) 
```ts
interface MWireTableRowType {
  columns: MWireTypeField[];
}
```
 ### SortRangeRowsDirection [Заголовок раздела «SortRangeRowsDirection»](#sortrangerowsdirection) 
```ts
type SortRangeRowsDirection = "ascending" | "descending";
```
 ### SortRangeRowsLevel [Заголовок раздела «SortRangeRowsLevel»](#sortrangerowslevel) 
```ts
interface SortRangeRowsLevel {
  col: number;
  direction: SortRangeRowsDirection;
  customOrder?: string[];
}
```
 ### SortRangeRowsNumericTextMode [Заголовок раздела «SortRangeRowsNumericTextMode»](#sortrangerowsnumerictextmode) 
```ts
type SortRangeRowsNumericTextMode = "as_text" | "as_number";
```

# Типы: формулы и вычисления

> Определения типов Compute Contract — пересчёт, зависимости, аудит, имена и анализ «что если». Имён: 68.

Определения имён из колонки «Тип TypeScript» на страницах операций. Другие темы словаря: [сеанс, книга и листы](/reference/f1/types-session/) · [ячейки и диапазоны](/reference/f1/types-cells/) · **формулы и вычисления** · [форматирование](/reference/f1/types-format/) · [данные и объекты листа](/reference/f1/types-data/) · [сводные таблицы](/reference/f1/types-pivot/) · [диаграммы и графика](/reference/f1/types-charts/) · [печать и разметка страницы](/reference/f1/types-print/) · [Power Query](/reference/f1/types-powerquery/) · [VBA и макросы](/reference/f1/types-vba/) · [защита и рецензирование](/reference/f1/types-protection/) · [общие и служебные](/reference/f1/types-common/). ### ContractArrayFormulaTrustMetadata [Заголовок раздела «ContractArrayFormulaTrustMetadata»](#contractarrayformulatrustmetadata) 
```ts
interface ContractArrayFormulaTrustMetadata {
  kind: "legacy_array_formula" | "dynamic_array_formula" | string;
  role: "anchor" | "follower" | string;
  refRange?: string | null;
  formulaTextAvailable: boolean;
}
```
 ### ContractCalcChainTrustMetadata [Заголовок раздела «ContractCalcChainTrustMetadata»](#contractcalcchaintrustmetadata) 
```ts
interface ContractCalcChainTrustMetadata {
  order: number;
  cellRef: string;
  sheetId?: string | null;
}
```
 ### ContractCalculationCommandState [Заголовок раздела «ContractCalculationCommandState»](#contractcalculationcommandstate) 
```ts
interface ContractCalculationCommandState {
  enabled: boolean;
  active: boolean;
  reasonCode?: string | null;
}
```
 ### ContractCalculationCommandStates [Заголовок раздела «ContractCalculationCommandStates»](#contractcalculationcommandstates) 
```ts
interface ContractCalculationCommandStates {
  automatic: ContractCalculationCommandState;
  automaticExceptDataTables: ContractCalculationCommandState;
  manual: ContractCalculationCommandState;
  calculateNow: ContractCalculationCommandState;
  calculateSheet: ContractCalculationCommandState;
}
```
 ### ContractCalculationDataTablePolicy [Заголовок раздела «ContractCalculationDataTablePolicy»](#contractcalculationdatatablepolicy) 
```ts
type ContractCalculationDataTablePolicy = "excluded_unsupported";
```
 ### ContractCalculationOptionsHistoryAction [Заголовок раздела «ContractCalculationOptionsHistoryAction»](#contractcalculationoptionshistoryaction) 
```ts
type ContractCalculationOptionsHistoryAction = "set" | "undo" | "redo";
```
 ### ContractCalculationPolicySnapshot [Заголовок раздела «ContractCalculationPolicySnapshot»](#contractcalculationpolicysnapshot) 
```ts
interface ContractCalculationPolicySnapshot {
  status: ContractCalculationStatus;
  calculationMode: ContractWorkbookCalculationMode;
  dataTablePolicy: ContractCalculationDataTablePolicy;
  recalcNeeded: boolean;
  supportedFormulaCount: number;
  dirtyFormulaCount: number;
  staleCachedFormulaCount: number;
  unsupportedFormulaCount: number;
  commandStates: ContractCalculationCommandStates;
  note: string;
}
```
 ### ContractCalculationPropertiesSnapshot [Заголовок раздела «ContractCalculationPropertiesSnapshot»](#contractcalculationpropertiessnapshot) 
```ts
interface ContractCalculationPropertiesSnapshot {
  calculationMode: ContractWorkbookCalculationMode;
  recalculateBeforeSave?: boolean | null;
  fullCalculationOnLoad?: boolean | null;
  forceFullCalculation?: boolean | null;
  iterativeSettings: ContractIterativeCalculationSettings;


  calculationId?: number | null;
  calculationCompleted?: boolean | null;
  fullPrecision?: boolean | null;
}
```
 ### ContractCalculationScope [Заголовок раздела «ContractCalculationScope»](#contractcalculationscope) 
```ts
type ContractCalculationScope = { kind: "workbook" } | { kind: "sheet"; sheetKey: string };
```
 ### ContractCalculationStatus [Заголовок раздела «ContractCalculationStatus»](#contractcalculationstatus) 
```ts
type ContractCalculationStatus = "clean" | "dirty" | "calculating" | "canceled" | "blocked" | "unsupported";
```
 ### ContractCalculationTrust [Заголовок раздела «ContractCalculationTrust»](#contractcalculationtrust) 
```ts
interface ContractCalculationTrust {
  state: ContractCalculationTrustState;
  formulaText: string;
  cachedDisplayValue: string | null;
  workbookCalcMode: ContractWorkbookCalculationMode;
  cachedValueFreshness: ContractFormulaCachedValueFreshness;
  recalcRequiredReasons: ContractRecalcRequiredReason[];
  directPrecedentKeys: string[];
  unsupportedReferences: string[];
  spillObstructionKind?:
    | "occupied_cell"
    | "out_of_bounds"
    | "merged_range"
    | "table"
    | "protected_cell"
    | string
    | null;
  spillObstructionCellKey?: string | null;
  spillObstructionDetail?: string | null;
  structuredReferences?: ContractStructuredReferenceTrustMetadata[];
  externalReferences?: Array<
    | ContractExternalWorkbookReferenceTrustMetadata
    | ContractExternalReferenceTrustMetadata
  >;
  note: string;
}
```
 ### ContractCalculationTrustState [Заголовок раздела «ContractCalculationTrustState»](#contractcalculationtruststate) 
```ts
type ContractCalculationTrustState =
  | "live_calculated"
  | "imported_cached"
  | "dirty_recalc_needed"
  | "stale_cache_recalc_required"
  | "unsupported_function"
  | "unsupported_reference_shape"
  | "unsupported_shared_formula_shape"
  | "unsupported_array_shape"
  | "unsupported_dynamic_array_shape"
  | "unsupported_defined_name_shape"
  | "unsupported_structured_ref_shape"
  | "unsupported_shape"
  | "depends_on_unsupported"
  | "volatile_boundary"
  | "external_cached_unresolved"
  | "external_link_missing"
  | "external_link_blocked"
  | "external_ref_unsupported_shape"
  | "external_ref_cached_stale"
  | "depends_on_external_unresolved";
```
 ### ContractDataCleanupAudit [Заголовок раздела «ContractDataCleanupAudit»](#contractdatacleanupaudit) 
```ts
interface ContractDataCleanupAudit {
  schemaVersion: 1;
  operationKind:
    "text_to_columns" | "remove_duplicates" | "remove_duplicates_copy";
  mutationMode: "in_place" | "copy_output";
  sourceRange: CellRange;
  outputRange: CellRange;
  sourceRowCount: number;
  sourceColCount: number;
  resultRowCount: number;
  resultColCount: number;
  duplicateCount: number;
  remainingCount: number;
  headerRowCount: number;
  totalsRowCount: number;
  plannedChangeCount: number;
  duplicateRowSpans: ContractDataCleanupRowSpan[];
  cellPayloadPolicy: string;
  coordinateArtifactPolicy: string;
}
```
 ### ContractDefinedNameKind [Заголовок раздела «ContractDefinedNameKind»](#contractdefinednamekind) 
```ts
type ContractDefinedNameKind = "range" | "constant" | "formula" | "lambda" | "invalid";
```
 ### ContractDefinedNameReferenceBase [Заголовок раздела «ContractDefinedNameReferenceBase»](#contractdefinednamereferencebase) 
```ts
interface ContractDefinedNameReferenceBase {
  sheetKey: string;
  row: number;
  col: number;
}
```
 ### ContractDefinedNameScope [Заголовок раздела «ContractDefinedNameScope»](#contractdefinednamescope) 
```ts
type ContractDefinedNameScope = "workbook" | "sheet";
```
 ### ContractDefinedNameSelectionEdges [Заголовок раздела «ContractDefinedNameSelectionEdges»](#contractdefinednameselectionedges) 
```ts
interface ContractDefinedNameSelectionEdges {
  top?: boolean;
  left?: boolean;
  bottom?: boolean;
  right?: boolean;
}
```
 ### ContractDefinedNameTrustMetadata [Заголовок раздела «ContractDefinedNameTrustMetadata»](#contractdefinednametrustmetadata) 
```ts
interface ContractDefinedNameTrustMetadata {
  name: string;
  scope: string;
  shape: string;
  targetSheetKey?: string | null;
  targetRange?: string | null;
  resolutionState: string;
}
```
 ### ContractDefinedNameValue [Заголовок раздела «ContractDefinedNameValue»](#contractdefinednamevalue) 
```ts
interface ContractDefinedNameValue {
  name: string;
  scope: string;
  ownerSheetKey?: string | null;
  value: string;
  ok: boolean;
  error?: string | null;
}
```
 ### ContractDefinedNameView [Заголовок раздела «ContractDefinedNameView»](#contractdefinednameview) 
```ts
interface ContractDefinedNameView {


  identity: string;
  name: string;
  scope: ContractDefinedNameScope;
  localSheetId?: number | null;
  scopeSheetKey?: string | null;
  scopeSheetName?: string | null;
  refersTo: string;
  comment?: string | null;
  kind: ContractDefinedNameKind;
  hidden: boolean;
  editable: boolean;
  editBlockReason?: string | null;
  resolvedRange?: CellRange | null;
  resolvedValue?: string | null;
  valueError?: string | null;
  visibleOnActiveSheet: boolean;
  shadowedOnActiveSheet: boolean;
}
```
 ### ContractDefinedNamesIntent [Заголовок раздела «ContractDefinedNamesIntent»](#contractdefinednamesintent) 
```ts
type ContractDefinedNamesIntent =
  | { action: "list"; activeSheetKey?: string
  | null }
  | ({ action: "create"; name: string; refersTo: string; relativeTo?: ContractDefinedNameReferenceBase
  | null; scope: ContractDefinedNameScope; scopeSheetKey?: string
  | null; comment?: string
  | null; } & DefinedNamesMutationGuard)
  | ({ action: "update";
    previousName: string;
    previousScope: ContractDefinedNameScope;
  previousScopeSheetKey?: string
  | null; name: string; refersTo: string; relativeTo?: ContractDefinedNameReferenceBase
  | null; scope: ContractDefinedNameScope; scopeSheetKey?: string
  | null; comment?: string
  | null; } & DefinedNamesMutationGuard)
  | ({ action: "delete"; name: string; scope: ContractDefinedNameScope; scopeSheetKey?: string
  | null; } & DefinedNamesMutationGuard)
  | ({ action: "create_from_selection";
    selection: CellRange;
    edges: ContractDefinedNameSelectionEdges;
    scope: ContractDefinedNameScope;
  } & DefinedNamesMutationGuard)
  | ({ action: "define_selection";
    name: string;
    selection: CellRange;
    scope: ContractDefinedNameScope;
  } & DefinedNamesMutationGuard)
  | ({ action: "undo" } & DefinedNamesMutationGuard)
  | ({ action: "redo" } & DefinedNamesMutationGuard);
```
 ### ContractDefinedNamesResult [Заголовок раздела «ContractDefinedNamesResult»](#contractdefinednamesresult) 
```ts
interface ContractDefinedNamesResult {
  status:
    | "listed"
    | "created"
    | "updated"
    | "deleted"
    | "created_from_selection"
    | "undone"
    | "redone";
  revision: number;
  entries: ContractDefinedNameView[];
  undoDepth: number;
  redoDepth: number;
  mutatedCount: number;
  activeSheetKey?: string | null;
}
```
 ### ContractDependencyGraphSnapshot [Заголовок раздела «ContractDependencyGraphSnapshot»](#contractdependencygraphsnapshot) 
```ts
interface ContractDependencyGraphSnapshot {
  queryNodes: string[];
  queryEdges: ContractQueryDependencyEdge[];
  paramNodes: string[];
  paramEdges: ContractParamEdge[];
  topoOrder?: string[] | null;
  topoBlockedReason?: string | null;
}
```
 ### ContractFormatNonGoal [Заголовок раздела «ContractFormatNonGoal»](#contractformatnongoal) 
```ts
type ContractFormatNonGoal = (typeof CONTRACT_FORMAT_NON_GOAL_IDS)[number];
```
 ### ContractFormulaAuditActions [Заголовок раздела «ContractFormulaAuditActions»](#contractformulaauditactions) 
```ts
interface ContractFormulaAuditActions {
  ignoreError: boolean;
  restoreIgnored: boolean;
  applyFix: boolean;
  resetIgnored: boolean;
  addWatch: boolean;
  removeWatch: boolean;
  clearWatches: boolean;
}
```
 ### ContractFormulaAuditCellProjection [Заголовок раздела «ContractFormulaAuditCellProjection»](#contractformulaauditcellprojection) 
```ts
interface ContractFormulaAuditCellProjection {


  workbookId?: string;


  workbookSessionId?: string;
  cellKey: string;
  sheetKey: string;
  sheetName: string;
  sheetOrder: number;
  row: number;
  col: number;
  address: string;
  formula: string | null;


  formulaHidden: boolean;
  value: ContractFormulaEvaluationValue;
  valueType: string;
  errorCode: string | null;
  calculationState: ContractCalculationTrustState;
  workbookCalcMode: ContractWorkbookCalculationMode;
  cachedValueFreshness: ContractFormulaCachedValueFreshness;
  recalcRequiredReasons: ContractRecalcRequiredReason[];
  spillRole: "owner" | "follower" | "none";
  spillOwnerKey: string | null;
  navigationTargetKey: string;
}
```
 ### ContractFormulaAuditCounts [Заголовок раздела «ContractFormulaAuditCounts»](#contractformulaauditcounts) 
```ts
interface ContractFormulaAuditCounts {
  findings: number;
  ignored: number;
  watches: number;
}
```
 ### ContractFormulaAuditFinding [Заголовок раздела «ContractFormulaAuditFinding»](#contractformulaauditfinding) 
```ts
interface ContractFormulaAuditFinding {


  identity?: string;


  revision?: number;
  kind: ContractFormulaAuditFindingKind;
  ignored: boolean;
  nativeIgnoredFlag: string;
  explanationCode: string;
  relatedKeys: string[];
  safeFix?: ContractFormulaAuditFix;
  cell: ContractFormulaAuditCellProjection;
}
```
 ### ContractFormulaAuditFindingKind [Заголовок раздела «ContractFormulaAuditFindingKind»](#contractformulaauditfindingkind) 
```ts
type ContractFormulaAuditFindingKind =
  | "div0"
  | "na"
  | "value"
  | "ref"
  | "name"
  | "num"
  | "circular_reference"
  | "inconsistent_formula"
  | "omitted_adjacent_cell"
  | "number_stored_as_text"
  | "stale_dependency"
  | "unsupported_formula_boundary";
```
 ### ContractFormulaAuditFix [Заголовок раздела «ContractFormulaAuditFix»](#contractformulaauditfix) 
```ts
interface ContractFormulaAuditFix {
  kind: ContractFormulaAuditFixKind;
  labelCode: string;
  replacementPreview: string;
}
```
 ### ContractFormulaAuditFixKind [Заголовок раздела «ContractFormulaAuditFixKind»](#contractformulaauditfixkind) 
```ts
type ContractFormulaAuditFixKind = | "convert_number_stored_as_text" | "copy_consistent_formula" | "extend_adjacent_range";
```
 ### ContractFormulaAuditOutcome [Заголовок раздела «ContractFormulaAuditOutcome»](#contractformulaauditoutcome) 
```ts
type ContractFormulaAuditOutcome = "ready" | "mutated" | "stale" | "blocked" | "unavailable";
```
 ### ContractFormulaAuditWatchAction [Заголовок раздела «ContractFormulaAuditWatchAction»](#contractformulaauditwatchaction) 
```ts
type ContractFormulaAuditWatchAction =
  | "read"
  | "ignore_error"
  | "restore_ignored"
  | "apply_fix"
  | "reset_ignored"
  | "add_watch"
  | "remove_watch"
  | "clear_watches";
```
 ### ContractFormulaAuditWatchRow [Заголовок раздела «ContractFormulaAuditWatchRow»](#contractformulaauditwatchrow) 
```ts
interface ContractFormulaAuditWatchRow {


  revision: number;
  cell: ContractFormulaAuditCellProjection;
}
```
 ### ContractFormulaAuditingStatePersistence [Заголовок раздела «ContractFormulaAuditingStatePersistence»](#contractformulaauditingstatepersistence) 
```ts
type ContractFormulaAuditingStatePersistence = "workbook_persistent" | "window_transient";
```
 ### ContractFormulaBuilderArgument [Заголовок раздела «ContractFormulaBuilderArgument»](#contractformulabuilderargument) 
```ts
interface ContractFormulaBuilderArgument {
  id: string;
  localizedName: string;
  description: string;
  kind: ContractFormulaBuilderArgumentKind;
  required: boolean;
  repeating: boolean;
  repeatGroupSize?: number;
}
```
 ### ContractFormulaBuilderArgumentKind [Заголовок раздела «ContractFormulaBuilderArgumentKind»](#contractformulabuilderargumentkind) 
```ts
type ContractFormulaBuilderArgumentKind = "scalar" | "range" | "multi-range" | "enum";
```
 ### ContractFormulaBuilderAvailability [Заголовок раздела «ContractFormulaBuilderAvailability»](#contractformulabuilderavailability) 
```ts
type ContractFormulaBuilderAvailability = "live" | "unsupported";
```
 ### ContractFormulaBuilderCatalog [Заголовок раздела «ContractFormulaBuilderCatalog»](#contractformulabuildercatalog) 
```ts
interface ContractFormulaBuilderCatalog {
  schemaVersion: number;
  locale: string;
  semanticOwner: "rust";
  functions: ContractFormulaBuilderFunction[];
}
```
 ### ContractFormulaBuilderFunction [Заголовок раздела «ContractFormulaBuilderFunction»](#contractformulabuilderfunction) 
```ts
interface ContractFormulaBuilderFunction {
  identity: string;
  canonicalName: string;
  localizedName: string;
  localizedDescription: string;
  category: string;
  availability: ContractFormulaBuilderAvailability;
  arguments: ContractFormulaBuilderArgument[];
}
```
 ### ContractFormulaCachedValueFreshness [Заголовок раздела «ContractFormulaCachedValueFreshness»](#contractformulacachedvaluefreshness) 
```ts
type ContractFormulaCachedValueFreshness =
  | "live_calculated"
  | "imported_cached"
  | "dirty_recalc_needed"
  | "stale_cache_recalc_required"
  | "no_cached_value";
```
 ### ContractFormulaEvaluationAction [Заголовок раздела «ContractFormulaEvaluationAction»](#contractformulaevaluationaction) 
```ts
type ContractFormulaEvaluationAction = "start" | "evaluate" | "step_in" | "step_out" | "restart" | "close";
```
 ### ContractFormulaEvaluationActions [Заголовок раздела «ContractFormulaEvaluationActions»](#contractformulaevaluationactions) 
```ts
interface ContractFormulaEvaluationActions {
  evaluate: boolean;
  stepIn: boolean;
  stepOut: boolean;
  restart: boolean;
  close: boolean;
}
```
 ### ContractFormulaEvaluationDiagnostic [Заголовок раздела «ContractFormulaEvaluationDiagnostic»](#contractformulaevaluationdiagnostic) 
```ts
interface ContractFormulaEvaluationDiagnostic {
  kind:
    | "typed_error"
    | "circular"
    | "manual"
    | "unsupported"
    | "stale"
    | "cancelled"
    | string;
  code: string;
  message: string;
  cellKey?: string | null;
  sourceSpan?: ContractFormulaEvaluationSourceSpan | null;
  path: string[];
}
```
 ### ContractFormulaEvaluationOutcome [Заголовок раздела «ContractFormulaEvaluationOutcome»](#contractformulaevaluationoutcome) 
```ts
type ContractFormulaEvaluationOutcome = | "ready" | "complete" | "closed" | "stale" | "manual_pending" | "circular" | "unavailable";
```
 ### ContractFormulaEvaluationSourceSpan [Заголовок раздела «ContractFormulaEvaluationSourceSpan»](#contractformulaevaluationsourcespan) 
```ts
interface ContractFormulaEvaluationSourceSpan {
  utf8ByteStart: number;
  utf8ByteEnd: number;
  utf16Start: number;
  utf16End: number;
  sourceSlice: string;
}
```
 ### ContractFormulaEvaluationStackFrame [Заголовок раздела «ContractFormulaEvaluationStackFrame»](#contractformulaevaluationstackframe) 
```ts
interface ContractFormulaEvaluationStackFrame {
  frameId: string;
  parentFrameId?: string | null;
  cellKey: string;
  formulaSource: string;
  callSiteSpan?: ContractFormulaEvaluationSourceSpan | null;
  depth: number;
}
```
 ### ContractFormulaEvaluationStep [Заголовок раздела «ContractFormulaEvaluationStep»](#contractformulaevaluationstep) 
```ts
interface ContractFormulaEvaluationStep {
  stepId: string;
  ordinal: number;
  parentStepId?: string | null;
  depth: number;
  sourceSpan: ContractFormulaEvaluationSourceSpan;
  canonicalExpression: string;
  substitutedExpression: string;
  value: ContractFormulaEvaluationValue;
  trust: ContractFormulaEvaluationTrust;
  referenceTargetKey?: string | null;
}
```
 ### ContractFormulaEvaluationTrust [Заголовок раздела «ContractFormulaEvaluationTrust»](#contractformulaevaluationtrust) 
```ts
interface ContractFormulaEvaluationTrust {
  calculationState: ContractCalculationTrustState | string;
  workbookCalculationMode: ContractWorkbookCalculationMode;
  cachedValueFreshness: ContractFormulaCachedValueFreshness | string;
  recalcRequiredReasons: string[];
  volatileContextId?: string | null;
  cyclePath: string[];
  spillRole: "owner" | "follower" | "none";
  spillOwnerKey?: string | null;
  diagnosticOnly: boolean;
}
```
 ### ContractFormulaEvaluationValue [Заголовок раздела «ContractFormulaEvaluationValue»](#contractformulaevaluationvalue) 
```ts
type ContractFormulaEvaluationValue =
  | { kind: "blank"; displayText: string }
  | { kind: "empty_string"; displayText: string }
  | { kind: "number"; value: number; displayText: string }
  | { kind: "boolean"; value: boolean; displayText: string }
  | { kind: "text"; value: string; displayText: string }
  | { kind: "computed_text"; value: string; displayText: string }
  | { kind: "live_error"; code: string; displayText: string }
  | { kind: "imported_error"; code: string; displayText: string }
  | { kind: "array";
    rowCount: number;
    colCount: number;
    values: ContractFormulaEvaluationValue[];
    displayText: string;
  }
  | { kind: "unavailable"; reason: string; displayText: string };
```
 ### ContractFormulaTraceDirection [Заголовок раздела «ContractFormulaTraceDirection»](#contractformulatracedirection) 
```ts
type ContractFormulaTraceDirection = "precedent" | "dependent";
```
 ### ContractFormulaTraceEdge [Заголовок раздела «ContractFormulaTraceEdge»](#contractformulatraceedge) 
```ts
interface ContractFormulaTraceEdge {
  edgeId: string;
  direction: ContractFormulaTraceDirection;
  depth: number;


  sourceKey: string;
  targetKey: string;
  status: ContractFormulaTraceEdgeStatus;
  crossSheet: boolean;
  referenceText?: string | null;
}
```
 ### ContractFormulaTraceEdgeStatus [Заголовок раздела «ContractFormulaTraceEdgeStatus»](#contractformulatraceedgestatus) 
```ts
type ContractFormulaTraceEdgeStatus = | "resolved" | "cycle" | "missing_or_deleted_reference" | "unsupported_boundary";
```
 ### ContractFormulaTrustCell [Заголовок раздела «ContractFormulaTrustCell»](#contractformulatrustcell) 
```ts
interface ContractFormulaTrustCell {
  cellKey: string;
  sheetKey: string;
  row: number;
  col: number;
  rawFormula: string;
  cachedValue?: string | null;
  publishedResultType?:
    "blank" | "emptyString" | "number" | "logical" | "text" | "error" | null;
  supportedStatus: FormulaSubsetStatus;
  unsupportedReason?: string | null;
  spillObstructionKind?:
    | "occupied_cell"
    | "out_of_bounds"
    | "merged_range"
    | "table"
    | "protected_cell"
    | string
    | null;
  spillObstructionCellKey?: string | null;
  spillObstructionDetail?: string | null;
  referenceShapes: string[];
  sharedFormula?: ContractSharedFormulaTrustMetadata | null;
  calcChain?: ContractCalcChainTrustMetadata | null;
  arrayFormula?: ContractArrayFormulaTrustMetadata | null;
  arrayDynamicShapes: string[];
  definedNames: ContractDefinedNameTrustMetadata[];
  structuredReferences: ContractStructuredReferenceTrustMetadata[];
  externalReferences: ContractExternalWorkbookReferenceTrustMetadata[];
  directDependenciesWhenKnown: string[];
  calculationState: ContractCalculationTrustState;
  workbookCalcMode: ContractWorkbookCalculationMode;
  cachedValueFreshness: ContractFormulaCachedValueFreshness;
  recalcRequiredReasons: ContractRecalcRequiredReason[];
}
```
 ### ContractFormulaTrustSnapshot [Заголовок раздела «ContractFormulaTrustSnapshot»](#contractformulatrustsnapshot) 
```ts
interface ContractFormulaTrustSnapshot {
  scope: string;
  supportedSubset: string;
  workbookCalcMode: ContractWorkbookCalculationMode;
  workbookCalcOnSave?: boolean | null;
  iterativeCalculationEnabled: boolean;
  iterativeCalculationMaximumIterations: number;
  iterativeCalculationMaximumChange: string;
  iterativeCalculationOutcomes: ContractIterativeCalculationOutcome[];
  parallelRecalc: ContractParallelRecalcInstrumentation;
  calculationPolicy: ContractCalculationPolicySnapshot;
  formulaCells: ContractFormulaTrustCell[];
}
```
 ### ContractIterativeCalculationOutcome [Заголовок раздела «ContractIterativeCalculationOutcome»](#contractiterativecalculationoutcome) 
```ts
interface ContractIterativeCalculationOutcome {
  cellKeys: string[];
  status: ContractIterativeCalculationStatus;
  iterations: number;
  maximumIterations: number;
  maximumChange: string;
  lastMaximumChange: string;
  errorCode?: string | null;
}
```
 ### ContractIterativeCalculationSettings [Заголовок раздела «ContractIterativeCalculationSettings»](#contractiterativecalculationsettings) 
```ts
interface ContractIterativeCalculationSettings {
  enabled: boolean;
  maximumIterations: number;
  maximumChange: number;
}
```
 ### ContractIterativeCalculationStatus [Заголовок раздела «ContractIterativeCalculationStatus»](#contractiterativecalculationstatus) 
```ts
type ContractIterativeCalculationStatus = "converged" | "non_converged" | "iteration_disabled" | "unsupported";
```
 ### ContractSharedFormulaTrustMetadata [Заголовок раздела «ContractSharedFormulaTrustMetadata»](#contractsharedformulatrustmetadata) 
```ts
interface ContractSharedFormulaTrustMetadata {
  role: string;
  sharedIndex: string;
  anchorCellKey?: string | null;
  refRange?: string | null;
  expandedFromAnchor: boolean;
  formulaTextAvailable: boolean;
}
```
 ### ContractTrustCenterAuditCategory [Заголовок раздела «ContractTrustCenterAuditCategory»](#contracttrustcenterauditcategory) 
```ts
type ContractTrustCenterAuditCategory =
  | "source_trust"
  | "macros"
  | "external_links"
  | "data_connections"
  | "trusted_locations"
  | "protected_files";
```
 ### ContractTrustCenterAuditEntry [Заголовок раздела «ContractTrustCenterAuditEntry»](#contracttrustcenterauditentry) 
```ts
interface ContractTrustCenterAuditEntry {
  schemaVersion: 1;
  category: ContractTrustCenterAuditCategory;
  action: ContractSourceTrustAction;
  allowed: boolean;
  reasonCode: ContractSourceTrustReason;
  policyState: ContractTrustCenterPolicyState;
  trustStoreRevision: number;
  trustStoreHash: string;
}
```
 ### ContractWhatIfScenarioInput [Заголовок раздела «ContractWhatIfScenarioInput»](#contractwhatifscenarioinput) 
```ts
interface ContractWhatIfScenarioInput {
  cell: ContractWhatIfCellRef;
  value: ContractWhatIfValue;
}
```
 ### ContractWhatIfScenarioView [Заголовок раздела «ContractWhatIfScenarioView»](#contractwhatifscenarioview) 
```ts
interface ContractWhatIfScenarioView {


  stableId: string;
  name: string;
  comment?: string | null;
  locked: boolean;
  hidden: boolean;
  permissions: {
    readable: boolean;
    showable: boolean;
    editable: boolean;
    deletable: boolean;
  };
  inputs: ContractWhatIfScenarioInput[];
}
```
 ### ContractXlsxDefinedNameDeletePatch [Заголовок раздела «ContractXlsxDefinedNameDeletePatch»](#contractxlsxdefinednamedeletepatch) 
```ts
interface ContractXlsxDefinedNameDeletePatch {
  name: string;
  scope?: ContractXlsxDefinedNameScope | null;
  activeSheetPath?: string | null;
  scopeSheetPath?: string | null;
  localSheetId?: number | null;
}
```
 ### ContractXlsxDefinedNamePatch [Заголовок раздела «ContractXlsxDefinedNamePatch»](#contractxlsxdefinednamepatch) 
```ts
interface ContractXlsxDefinedNamePatch {
  name: string;
  activeSheetPath: string;
  ref?: string | null;
  refersTo?: string | null;
  scope?: ContractXlsxDefinedNameScope | null;
  scopeSheetPath?: string | null;
  scopeSheetName?: string | null;
  localSheetId?: number | null;
  valueKind?: ContractXlsxDefinedNameValueKind | null;
  comment?: string | null;
}
```
 ### ContractXlsxDefinedNameScope [Заголовок раздела «ContractXlsxDefinedNameScope»](#contractxlsxdefinednamescope) 
```ts
type ContractXlsxDefinedNameScope = "workbook" | "sheet";
```
 ### ContractXlsxDefinedNameValueKind [Заголовок раздела «ContractXlsxDefinedNameValueKind»](#contractxlsxdefinednamevaluekind) 
```ts
type ContractXlsxDefinedNameValueKind = "range" | "number" | "text" | "formula" | "logical" | "date" | "error";
```
 ### MWireTypeName [Заголовок раздела «MWireTypeName»](#mwiretypename) 
```ts
type MWireTypeName =
  | "any"
  | "null"
  | "logical"
  | "number"
  | "text"
  | "date"
  | "integer"
  | "datetime"
  | "datetimezone"
  | "time"
  | "duration"
  | "binary"
  | "list"
  | "record"
  | "table"
  | "function"
  | "type";
```

# Типы: сводные таблицы

> Определения типов Compute Contract — кэш, поля, макет, группировка и параметры значений. Имён: 125.

Определения имён из колонки «Тип TypeScript» на страницах операций. Другие темы словаря: [сеанс, книга и листы](/reference/f1/types-session/) · [ячейки и диапазоны](/reference/f1/types-cells/) · [формулы и вычисления](/reference/f1/types-formulas/) · [форматирование](/reference/f1/types-format/) · [данные и объекты листа](/reference/f1/types-data/) · **сводные таблицы** · [диаграммы и графика](/reference/f1/types-charts/) · [печать и разметка страницы](/reference/f1/types-print/) · [Power Query](/reference/f1/types-powerquery/) · [VBA и макросы](/reference/f1/types-vba/) · [защита и рецензирование](/reference/f1/types-protection/) · [общие и служебные](/reference/f1/types-common/). ### ContractPivotCacheOptionsAction [Заголовок раздела «ContractPivotCacheOptionsAction»](#contractpivotcacheoptionsaction) 
```ts
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 [Заголовок раздела «ContractPivotCacheOptionsSettings»](#contractpivotcacheoptionssettings) 
```ts
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 [Заголовок раздела «ContractPivotCacheOptionsView»](#contractpivotcacheoptionsview) 
```ts
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 [Заголовок раздела «ContractPivotCacheSource»](#contractpivotcachesource) 
```ts
type ContractPivotCacheSource =
  | { kind: "table"; tableName: string }
  | { kind: "range"; sheetName: string; reference: string }
  | { kind: "multiple_ranges";
    ranges: ContractPivotConsolidationRangeInput[];
    pageFieldMode: ContractPivotConsolidationPageFieldMode;
    pageFieldNames?: string[];
  };
```
 ### ContractPivotCalculatedCacheView [Заголовок раздела «ContractPivotCalculatedCacheView»](#contractpivotcalculatedcacheview) 
```ts
interface ContractPivotCalculatedCacheView {
  cacheId: string;
  cacheIdentity: string;
  pivotTableNames: string[];
  sourceFields: ContractPivotCalculatedSourceFieldView[];
  refreshGeneration: number;
  refreshedRowCount: number;
  stale: boolean;
  readOnly: boolean;
  protected: boolean;
}
```
 ### ContractPivotCalculatedFieldView [Заголовок раздела «ContractPivotCalculatedFieldView»](#contractpivotcalculatedfieldview) 
```ts
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 [Заголовок раздела «ContractPivotCalculatedFieldsAction»](#contractpivotcalculatedfieldsaction) 
```ts
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 [Заголовок раздела «ContractPivotCalculatedItemAxis»](#contractpivotcalculateditemaxis) 
```ts
type ContractPivotCalculatedItemAxis = "row" | "column";
```
 ### ContractPivotCalculatedItemFieldView [Заголовок раздела «ContractPivotCalculatedItemFieldView»](#contractpivotcalculateditemfieldview) 
```ts
interface ContractPivotCalculatedItemFieldView {
  cacheId: string;
  fieldOrdinal: number;
  fieldName: string;
  axes: ContractPivotCalculatedItemAxis[];
  memberNames: string[];
  stale: boolean;
  readOnly: boolean;
  protected: boolean;
}
```
 ### ContractPivotCalculatedItemView [Заголовок раздела «ContractPivotCalculatedItemView»](#contractpivotcalculateditemview) 
```ts
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 [Заголовок раздела «ContractPivotCalculatedItemsAction»](#contractpivotcalculateditemsaction) 
```ts
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 [Заголовок раздела «ContractPivotCalculatedSourceFieldView»](#contractpivotcalculatedsourcefieldview) 
```ts
interface ContractPivotCalculatedSourceFieldView {
  ordinal: number;
  name: string;
  scalarKind: string;
  referenceText: string;
}
```
 ### ContractPivotCalculatedSummaryFunction [Заголовок раздела «ContractPivotCalculatedSummaryFunction»](#contractpivotcalculatedsummaryfunction) 
```ts
type ContractPivotCalculatedSummaryFunction = "sum" | "count" | "average";
```
 ### ContractPivotCalculationMoveDirection [Заголовок раздела «ContractPivotCalculationMoveDirection»](#contractpivotcalculationmovedirection) 
```ts
type ContractPivotCalculationMoveDirection = "up" | "down";
```
 ### ContractPivotConditionalArea [Заголовок раздела «ContractPivotConditionalArea»](#contractpivotconditionalarea) 
```ts
type ContractPivotConditionalArea = "data" | "subtotal" | "rowGrandTotal" | "columnGrandTotal" | "grandTotal";
```
 ### ContractPivotConditionalCellIdentity [Заголовок раздела «ContractPivotConditionalCellIdentity»](#contractpivotconditionalcellidentity) 
```ts
interface ContractPivotConditionalCellIdentity {
  dataFieldIndex?: number | null;
  rowItems: ContractPivotConditionalItemIdentity[];
  columnItems: ContractPivotConditionalItemIdentity[];
  area: ContractPivotConditionalArea;
}
```
 ### ContractPivotConditionalItemIdentity [Заголовок раздела «ContractPivotConditionalItemIdentity»](#contractpivotconditionalitemidentity) 
```ts
interface ContractPivotConditionalItemIdentity {
  fieldOrdinal: number;
  itemId: string;
}
```
 ### ContractPivotConditionalRuleScope [Заголовок раздела «ContractPivotConditionalRuleScope»](#contractpivotconditionalrulescope) 
```ts
interface ContractPivotConditionalRuleScope {
  cacheId: string;
  pivotTableName: string;
  expectedGeneration: number;
  scope: ContractPivotConditionalScope;
}
```
 ### ContractPivotConditionalScope [Заголовок раздела «ContractPivotConditionalScope»](#contractpivotconditionalscope) 
```ts
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 [Заголовок раздела «ContractPivotConnectionPropertiesView»](#contractpivotconnectionpropertiesview) 
```ts
interface ContractPivotConnectionPropertiesView {
  identity: string;
  sourceKind: string;
  properties: ContractPivotConnectionPropertyView[];
}
```
 ### ContractPivotConnectionPropertyView [Заголовок раздела «ContractPivotConnectionPropertyView»](#contractpivotconnectionpropertyview) 
```ts
interface ContractPivotConnectionPropertyView {
  key: string;
  value: string;
  applicable: boolean;
  editable: boolean;
  disabledReasonCode?: string | null;
  disabledReasonDetail?: string | null;
}
```
 ### ContractPivotConsolidationPageFieldMode [Заголовок раздела «ContractPivotConsolidationPageFieldMode»](#contractpivotconsolidationpagefieldmode) 
```ts
type ContractPivotConsolidationPageFieldMode = "automatic" | "manual";
```
 ### ContractPivotConsolidationRangeInput [Заголовок раздела «ContractPivotConsolidationRangeInput»](#contractpivotconsolidationrangeinput) 
```ts
interface ContractPivotConsolidationRangeInput {
  stableId?: string | null;
  sheetName: string;
  reference: string;
  pageItems?: string[];
}
```
 ### ContractPivotConsolidationRangeView [Заголовок раздела «ContractPivotConsolidationRangeView»](#contractpivotconsolidationrangeview) 
```ts
interface ContractPivotConsolidationRangeView {
  stableId: string;
  sheetName: string;
  sheetPath: string;
  reference: string;
  pageItems: string[];
  valueCount: number;
}
```
 ### ContractPivotCopyCacheOwnership [Заголовок раздела «ContractPivotCopyCacheOwnership»](#contractpivotcopycacheownership) 
```ts
type ContractPivotCopyCacheOwnership = "share_source_cache" | "independent_cache";
```
 ### ContractPivotDataModelOlapInventory [Заголовок раздела «ContractPivotDataModelOlapInventory»](#contractpivotdatamodelolapinventory) 
```ts
interface ContractPivotDataModelOlapInventory {
  connections: ContractPivotReadonlyConnection[];
  pivotTables: ContractPivotReadonlyTable[];
  cacheDefinitions: ContractPivotReadonlyCache[];
  modelParts: ContractPivotReadonlyOpaquePart[];
  slicerParts: ContractPivotReadonlyOpaquePart[];
  unknownParts: ContractPivotReadonlyOpaquePart[];
  signatureParts: ContractPivotReadonlyOpaquePart[];
  relationships: ContractPivotReadonlyRelationship[];
  unknownExtensionUris: string[];
  entityCount: number;
}
```
 ### ContractPivotDataModelOlapReadonlyAction [Заголовок раздела «ContractPivotDataModelOlapReadonlyAction»](#contractpivotdatamodelolapreadonlyaction) 
```ts
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 [Заголовок раздела «ContractPivotDateGroupPeriod»](#contractpivotdategroupperiod) 
```ts
type ContractPivotDateGroupPeriod = "years" | "quarters" | "months" | "days";
```
 ### ContractPivotDeletedItemsRetention [Заголовок раздела «ContractPivotDeletedItemsRetention»](#contractpivotdeleteditemsretention) 
```ts
type ContractPivotDeletedItemsRetention = "automatic" | "none" | "maximum";
```
 ### ContractPivotDetailCellRef [Заголовок раздела «ContractPivotDetailCellRef»](#contractpivotdetailcellref) 
```ts
interface ContractPivotDetailCellRef {
  sheetPath: string;
  row: number;
  col: number;
}
```
 ### ContractPivotDetailContextView [Заголовок раздела «ContractPivotDetailContextView»](#contractpivotdetailcontextview) 
```ts
interface ContractPivotDetailContextView {
  cacheIdentity: string;
  cacheGeneration: number;
  showDetailsEnabled: boolean;
  rowItems: ContractPivotGroupingItemKey[];
  columnItems: ContractPivotGroupingItemKey[];
  filterItems: ContractPivotGroupingItemKey[];
}
```
 ### ContractPivotDetailLineageView [Заголовок раздела «ContractPivotDetailLineageView»](#contractpivotdetaillineageview) 
```ts
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 [Заголовок раздела «ContractPivotExpandedItemView»](#contractpivotexpandeditemview) 
```ts
interface ContractPivotExpandedItemView {
  cacheId: string;
  pivotTableName: string;
  fieldOrdinal: number;
  itemId: string;
  expanded: boolean;
}
```
 ### ContractPivotFieldAggregation [Заголовок раздела «ContractPivotFieldAggregation»](#contractpivotfieldaggregation) 
```ts
type ContractPivotFieldAggregation = | "sum" | "count" | "average" | "max" | "min" | "product" | "count_numbers" | "std_dev" | "variance";
```
 ### ContractPivotFieldArea [Заголовок раздела «ContractPivotFieldArea»](#contractpivotfieldarea) 
```ts
type ContractPivotFieldArea = "filters" | "columns" | "rows" | "values";
```
 ### ContractPivotFieldListAuthoringAction [Заголовок раздела «ContractPivotFieldListAuthoringAction»](#contractpivotfieldlistauthoringaction) 
```ts
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 [Заголовок раздела «ContractPivotFieldListFieldView»](#contractpivotfieldlistfieldview) 
```ts
interface ContractPivotFieldListFieldView {
  ordinal: number;
  name: string;
  scalarKind: string;
  calculated: boolean;
  hasCalculatedItems: boolean;
}
```
 ### ContractPivotFieldListView [Заголовок раздела «ContractPivotFieldListView»](#contractpivotfieldlistview) 
```ts
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 [Заголовок раздела «ContractPivotFieldMutation»](#contractpivotfieldmutation) 
```ts
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 [Заголовок раздела «ContractPivotFilter»](#contractpivotfilter) 
```ts
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 [Заголовок раздела «ContractPivotFilterConnectionView»](#contractpivotfilterconnectionview) 
```ts
interface ContractPivotFilterConnectionView {
  controlId: string;
  caption: string;
  name: string;
  sheetName: string;
  kind: ContractSlicerTimelineControlKind;
  connected: boolean;
}
```
 ### ContractPivotFilterOperator [Заголовок раздела «ContractPivotFilterOperator»](#contractpivotfilteroperator) 
```ts
type ContractPivotFilterOperator = "equals" | "contains" | "begins_with" | "between";
```
 ### ContractPivotGetPivotDataView [Заголовок раздела «ContractPivotGetPivotDataView»](#contractpivotgetpivotdataview) 
```ts
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 [Заголовок раздела «ContractPivotGroupView»](#contractpivotgroupview) 
```ts
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 [Заголовок раздела «ContractPivotGroupingCacheView»](#contractpivotgroupingcacheview) 
```ts
interface ContractPivotGroupingCacheView {
  cacheId: string;
  cacheIdentity: string;
  generation: number;
  pivotTableNames: string[];
  refreshedRowCount: number;
  stale: boolean;
  readOnly: boolean;
  protected: boolean;
  unsupportedReason?: string | null;
}
```
 ### ContractPivotGroupingDrilldownAction [Заголовок раздела «ContractPivotGroupingDrilldownAction»](#contractpivotgroupingdrilldownaction) 
```ts
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 [Заголовок раздела «ContractPivotGroupingItemKey»](#contractpivotgroupingitemkey) 
```ts
interface ContractPivotGroupingItemKey {
  fieldOrdinal: number;
  itemId: string;
}
```
 ### ContractPivotGroupingItemView [Заголовок раздела «ContractPivotGroupingItemView»](#contractpivotgroupingitemview) 
```ts
interface ContractPivotGroupingItemView {
  id: string;
  cacheId: string;
  fieldOrdinal: number;
  fieldName: string;
  label: string;
  scalarKind: string;
  retired: boolean;
  groupId?: string | null;
  groupIds: string[];
}
```
 ### ContractPivotHierarchyNodeView [Заголовок раздела «ContractPivotHierarchyNodeView»](#contractpivothierarchynodeview) 
```ts
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 [Заголовок раздела «ContractPivotLayoutFormatAction»](#contractpivotlayoutformataction) 
```ts
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 [Заголовок раздела «ContractPivotLayoutFormatOptions»](#contractpivotlayoutformatoptions) 
```ts
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 [Заголовок раздела «ContractPivotLayoutFormatView»](#contractpivotlayoutformatview) 
```ts
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 [Заголовок раздела «ContractPivotMoveCopyAction»](#contractpivotmovecopyaction) 
```ts
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 [Заголовок раздела «ContractPivotMoveCopyDestination»](#contractpivotmovecopydestination) 
```ts
type ContractPivotMoveCopyDestination =
  | { kind: "existing_sheet"; sheetPath: string; anchor: string }
  | { kind: "new_sheet"; sheetName: string; anchor: string };
```
 ### ContractPivotMoveCopySheetView [Заголовок раздела «ContractPivotMoveCopySheetView»](#contractpivotmovecopysheetview) 
```ts
interface ContractPivotMoveCopySheetView {
  sheetName: string;
  sheetPath: string;
  loaded: boolean;
  protected: boolean;
}
```
 ### ContractPivotMoveCopyView [Заголовок раздела «ContractPivotMoveCopyView»](#contractpivotmovecopyview) 
```ts
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 [Заголовок раздела «ContractPivotMultipleConsolidationView»](#contractpivotmultipleconsolidationview) 
```ts
interface ContractPivotMultipleConsolidationView {
  pageFieldMode: ContractPivotConsolidationPageFieldMode;
  pageFieldNames: string[];
  ranges: ContractPivotConsolidationRangeView[];
  recordCount: number;
}
```
 ### ContractPivotPageBreakAfter [Заголовок раздела «ContractPivotPageBreakAfter»](#contractpivotpagebreakafter) 
```ts
type ContractPivotPageBreakAfter = "none" | "item" | "cohort";
```
 ### ContractPivotPrintAreaState [Заголовок раздела «ContractPivotPrintAreaState»](#contractpivotprintareastate) 
```ts
type ContractPivotPrintAreaState = "none" | "disjoint" | "contains_pivot";
```
 ### ContractPivotPrintPreviewProjection [Заголовок раздела «ContractPivotPrintPreviewProjection»](#contractpivotprintpreviewprojection) 
```ts
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 [Заголовок раздела «ContractPivotRankDirection»](#contractpivotrankdirection) 
```ts
type ContractPivotRankDirection = "small_to_large" | "large_to_small";
```
 ### ContractPivotReadonlyCache [Заголовок раздела «ContractPivotReadonlyCache»](#contractpivotreadonlycache) 
```ts
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 [Заголовок раздела «ContractPivotReadonlyCapability»](#contractpivotreadonlycapability) 
```ts
interface ContractPivotReadonlyCapability {
  command: string;
  state: ContractPivotReadonlyCapabilityState;
  available: boolean;
  reasonCode: string | null;
}
```
 ### ContractPivotReadonlyCapabilityState [Заголовок раздела «ContractPivotReadonlyCapabilityState»](#contractpivotreadonlycapabilitystate) 
```ts
type ContractPivotReadonlyCapabilityState = "live" | "disabled" | "blocked";
```
 ### ContractPivotReadonlyConnection [Заголовок раздела «ContractPivotReadonlyConnection»](#contractpivotreadonlyconnection) 
```ts
interface ContractPivotReadonlyConnection {
  stableId: string;
  id: string;
  name: string;
  connectionType: number | null;
  sourceKind: ContractPivotReadonlySourceKind;
  credentialsPresent: boolean;
  capabilities: ContractPivotReadonlyCapability[];
}
```
 ### ContractPivotReadonlyEntityKind [Заголовок раздела «ContractPivotReadonlyEntityKind»](#contractpivotreadonlyentitykind) 
```ts
type ContractPivotReadonlyEntityKind = | "measure" | "kpi" | "named_set" | "cube_field" | "hierarchy" | "calculated_member";
```
 ### ContractPivotReadonlyField [Заголовок раздела «ContractPivotReadonlyField»](#contractpivotreadonlyfield) 
```ts
interface ContractPivotReadonlyField {
  stableId: string;
  name: string;
  caption: string;
  hierarchyIndex: number | null;
  capabilities: ContractPivotReadonlyCapability[];
}
```
 ### ContractPivotReadonlyMutationKind [Заголовок раздела «ContractPivotReadonlyMutationKind»](#contractpivotreadonlymutationkind) 
```ts
type ContractPivotReadonlyMutationKind = "create" | "edit" | "rename" | "delete" | "author" | "evaluate";
```
 ### ContractPivotReadonlyNamedItem [Заголовок раздела «ContractPivotReadonlyNamedItem»](#contractpivotreadonlynameditem) 
```ts
interface ContractPivotReadonlyNamedItem {
  stableId: string;
  ownerPath: string;
  entityKind: ContractPivotReadonlyEntityKind;
  ordinal: number;
  name: string;
  caption: string;
  expressionPresent: boolean;
  capabilities: ContractPivotReadonlyCapability[];
}
```
 ### ContractPivotReadonlyOpaquePart [Заголовок раздела «ContractPivotReadonlyOpaquePart»](#contractpivotreadonlyopaquepart) 
```ts
interface ContractPivotReadonlyOpaquePart {
  path: string;
  byteCount: number;
  sha256: string;
}
```
 ### ContractPivotReadonlyRelationship [Заголовок раздела «ContractPivotReadonlyRelationship»](#contractpivotreadonlyrelationship) 
```ts
interface ContractPivotReadonlyRelationship {
  sourcePath: string;
  relationshipId: string;
  relationshipType: string;
  target: string;
  external: boolean;
}
```
 ### ContractPivotReadonlySourceKind [Заголовок раздела «ContractPivotReadonlySourceKind»](#contractpivotreadonlysourcekind) 
```ts
type ContractPivotReadonlySourceKind = "data_model" | "olap";
```
 ### ContractPivotReadonlyTable [Заголовок раздела «ContractPivotReadonlyTable»](#contractpivotreadonlytable) 
```ts
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 [Заголовок раздела «ContractPivotRefreshState»](#contractpivotrefreshstate) 
```ts
type ContractPivotRefreshState = "idle" | "queued" | "running" | "cancelling" | "committed" | "failed";
```
 ### ContractPivotRefreshStatusView [Заголовок раздела «ContractPivotRefreshStatusView»](#contractpivotrefreshstatusview) 
```ts
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 [Заголовок раздела «ContractPivotReportFilterFieldView»](#contractpivotreportfilterfieldview) 
```ts
interface ContractPivotReportFilterFieldView {
  fieldOrdinal: number;
  caption: string;
  allSelected: boolean;
  selectedItemIds: string[];
  items: ContractPivotReportFilterItemView[];
}
```
 ### ContractPivotReportFilterItemView [Заголовок раздела «ContractPivotReportFilterItemView»](#contractpivotreportfilteritemview) 
```ts
interface ContractPivotReportFilterItemView {
  itemId: string;
  label: string;
  scalarKind: string;
  retired: boolean;
  selected: boolean;
}
```
 ### ContractPivotReportFilterPageView [Заголовок раздела «ContractPivotReportFilterPageView»](#contractpivotreportfilterpageview) 
```ts
interface ContractPivotReportFilterPageView {
  sheetName: string;
  sheetPath: string;
  pivotTableName: string;
  pivotTablePath: string;
  selections: ContractPivotReportFilterSelection[];
}
```
 ### ContractPivotReportFilterPagesAction [Заголовок раздела «ContractPivotReportFilterPagesAction»](#contractpivotreportfilterpagesaction) 
```ts
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 [Заголовок раздела «ContractPivotReportFilterSelection»](#contractpivotreportfilterselection) 
```ts
interface ContractPivotReportFilterSelection {
  fieldOrdinal: number;


  selectedItemIds: string[];
}
```
 ### ContractPivotReportFilterView [Заголовок раздела «ContractPivotReportFilterView»](#contractpivotreportfilterview) 
```ts
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 [Заголовок раздела «ContractPivotReportLayout»](#contractpivotreportlayout) 
```ts
type ContractPivotReportLayout = "compact" | "outline" | "tabular";
```
 ### ContractPivotShowValuesAs [Заголовок раздела «ContractPivotShowValuesAs»](#contractpivotshowvaluesas) 
```ts
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 [Заголовок раздела «ContractPivotSortFilterAction»](#contractpivotsortfilteraction) 
```ts
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 [Заголовок раздела «ContractPivotSortFilterItemView»](#contractpivotsortfilteritemview) 
```ts
interface ContractPivotSortFilterItemView {
  itemId: string;
  label: string;
  scalarKind: string;
  retired: boolean;
  visible: boolean;
  aggregate?: number | null;
  rank?: number | null;
}
```
 ### ContractPivotSortFilterSettings [Заголовок раздела «ContractPivotSortFilterSettings»](#contractpivotsortfiltersettings) 
```ts
interface ContractPivotSortFilterSettings {
  fieldOrdinal: number;
  sort: ContractPivotSortMode;
  filters: ContractPivotFilter[];
  selectedItemIds?: string[] | null;
  includeNewItems: boolean;
  rankDirection: ContractPivotRankDirection;
}
```
 ### ContractPivotSortFilterView [Заголовок раздела «ContractPivotSortFilterView»](#contractpivotsortfilterview) 
```ts
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 [Заголовок раздела «ContractPivotSortMode»](#contractpivotsortmode) 
```ts
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 [Заголовок раздела «ContractPivotSubtotalPosition»](#contractpivotsubtotalposition) 
```ts
type ContractPivotSubtotalPosition = "off" | "top" | "bottom";
```
 ### ContractPivotTopMode [Заголовок раздела «ContractPivotTopMode»](#contractpivottopmode) 
```ts
type ContractPivotTopMode = "top" | "bottom";
```
 ### ContractPivotTopUnit [Заголовок раздела «ContractPivotTopUnit»](#contractpivottopunit) 
```ts
type ContractPivotTopUnit = "items" | "percent" | "sum";
```
 ### ContractPivotValueBaseFieldView [Заголовок раздела «ContractPivotValueBaseFieldView»](#contractpivotvaluebasefieldview) 
```ts
interface ContractPivotValueBaseFieldView {
  ordinal: number;
  caption: string;
  items: ContractPivotValueBaseItemView[];
}
```
 ### ContractPivotValueBaseItemView [Заголовок раздела «ContractPivotValueBaseItemView»](#contractpivotvaluebaseitemview) 
```ts
interface ContractPivotValueBaseItemView {
  id: string;
  index: number;
  label: string;
  retired: boolean;
}
```
 ### ContractPivotValueCellView [Заголовок раздела «ContractPivotValueCellView»](#contractpivotvaluecellview) 
```ts
interface ContractPivotValueCellView {
  occurrenceId: string;
  rowItems: string[];
  columnItems: string[];
  display: string;
}
```
 ### ContractPivotValueFieldSettings [Заголовок раздела «ContractPivotValueFieldSettings»](#contractpivotvaluefieldsettings) 
```ts
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 [Заголовок раздела «ContractPivotValueFieldSettingsAction»](#contractpivotvaluefieldsettingsaction) 
```ts
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 [Заголовок раздела «ContractPivotValueFieldSettingsView»](#contractpivotvaluefieldsettingsview) 
```ts
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 [Заголовок раздела «ContractPivotValueFieldView»](#contractpivotvaluefieldview) 
```ts
interface ContractPivotValueFieldView {
  occurrenceId: string;
  fieldOrdinal: number;
  caption: string;
  aggregation: ContractPivotFieldAggregation;
}
```
 ### ContractPivotValueSummaryFunction [Заголовок раздела «ContractPivotValueSummaryFunction»](#contractpivotvaluesummaryfunction) 
```ts
type ContractPivotValueSummaryFunction = | "sum" | "count" | "average" | "max" | "min" | "product" | "count_numbers" | "std_dev" | "variance";
```
 ### ContractXlsxPivotCalculatedFieldMaterialization [Заголовок раздела «ContractXlsxPivotCalculatedFieldMaterialization»](#contractxlsxpivotcalculatedfieldmaterialization) 
```ts
interface ContractXlsxPivotCalculatedFieldMaterialization {
  name: string;
  formula: string;
  summaryFunction: "sum" | "count" | "average" | "min" | "max";
}
```
 ### ContractXlsxPivotCalculatedPresentationMaterialization [Заголовок раздела «ContractXlsxPivotCalculatedPresentationMaterialization»](#contractxlsxpivotcalculatedpresentationmaterialization) 
```ts
interface ContractXlsxPivotCalculatedPresentationMaterialization {
  columnLabelsCaption: string;
  rowLabelsCaption: string;
  grandTotalCaption: string;
  columnWidths: ContractColumnWidth[];
}
```
 ### ContractXlsxPivotCalculatedStateMaterialization [Заголовок раздела «ContractXlsxPivotCalculatedStateMaterialization»](#contractxlsxpivotcalculatedstatematerialization) 
```ts
interface ContractXlsxPivotCalculatedStateMaterialization {
  calculatedFields: ContractXlsxPivotCalculatedFieldMaterialization[];
  values: ContractXlsxPivotValueFieldMaterialization[];
  valueCells: ContractXlsxPivotValueCellMaterialization[];
  presentation?: ContractXlsxPivotCalculatedPresentationMaterialization | null;
}
```
 ### ContractXlsxPivotTableCalculatedFieldPatch [Заголовок раздела «ContractXlsxPivotTableCalculatedFieldPatch»](#contractxlsxpivottablecalculatedfieldpatch) 
```ts
interface ContractXlsxPivotTableCalculatedFieldPatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  fieldName: "RevenuePerUnit";
  formula: "'Revenue'/'Units'";
  summaryFunction: "sum";
  name?: string | null;
}
```
 ### ContractXlsxPivotTableClearAllPatch [Заголовок раздела «ContractXlsxPivotTableClearAllPatch»](#contractxlsxpivottableclearallpatch) 
```ts
interface ContractXlsxPivotTableClearAllPatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  name?: string | null;
}
```
 ### ContractXlsxPivotTableClearFiltersPatch [Заголовок раздела «ContractXlsxPivotTableClearFiltersPatch»](#contractxlsxpivottableclearfilterspatch) 
```ts
interface ContractXlsxPivotTableClearFiltersPatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  fieldName?: string | null;
  name?: string | null;
}
```
 ### ContractXlsxPivotTableCreationPatch [Заголовок раздела «ContractXlsxPivotTableCreationPatch»](#contractxlsxpivottablecreationpatch) 
```ts
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;
}
```
 ### ContractXlsxPivotTableDeletionPatch [Заголовок раздела «ContractXlsxPivotTableDeletionPatch»](#contractxlsxpivottabledeletionpatch) 
```ts
interface ContractXlsxPivotTableDeletionPatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  name?: string | null;
}
```
 ### ContractXlsxPivotTableFieldAdditionPatch [Заголовок раздела «ContractXlsxPivotTableFieldAdditionPatch»](#contractxlsxpivottablefieldadditionpatch) 
```ts
interface ContractXlsxPivotTableFieldAdditionPatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  fieldName: string;
  targetArea: "columns" | "rows" | "filters";
  targetIndex?: number | null;
  name?: string | null;
}
```
 ### ContractXlsxPivotTableFieldFilterPatch [Заголовок раздела «ContractXlsxPivotTableFieldFilterPatch»](#contractxlsxpivottablefieldfilterpatch) 
```ts
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;
}
```
 ### ContractXlsxPivotTableFieldMovePatch [Заголовок раздела «ContractXlsxPivotTableFieldMovePatch»](#contractxlsxpivottablefieldmovepatch) 
```ts
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;
}
```
 ### ContractXlsxPivotTableFieldRemovalPatch [Заголовок раздела «ContractXlsxPivotTableFieldRemovalPatch»](#contractxlsxpivottablefieldremovalpatch) 
```ts
interface ContractXlsxPivotTableFieldRemovalPatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  fieldName: string;
  fromArea?: "filters" | "columns" | "rows" | "values" | null;
  name?: string | null;
}
```
 ### ContractXlsxPivotTableFieldSettingsPatch [Заголовок раздела «ContractXlsxPivotTableFieldSettingsPatch»](#contractxlsxpivottablefieldsettingspatch) 
```ts
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;
}
```
 ### ContractXlsxPivotTableFieldSortPatch [Заголовок раздела «ContractXlsxPivotTableFieldSortPatch»](#contractxlsxpivottablefieldsortpatch) 
```ts
interface ContractXlsxPivotTableFieldSortPatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  fieldName: string;
  direction: "ascending" | "descending";
  name?: string | null;
}
```
 ### ContractXlsxPivotTableItemDetailPatch [Заголовок раздела «ContractXlsxPivotTableItemDetailPatch»](#contractxlsxpivottableitemdetailpatch) 
```ts
interface ContractXlsxPivotTableItemDetailPatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  fieldName: string;
  itemLabel: string;
  expanded: boolean;
  name?: string | null;
}
```
 ### ContractXlsxPivotTableItemGroupPatch [Заголовок раздела «ContractXlsxPivotTableItemGroupPatch»](#contractxlsxpivottableitemgrouppatch) 
```ts
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;
}
```
 ### ContractXlsxPivotTableMovePatch [Заголовок раздела «ContractXlsxPivotTableMovePatch»](#contractxlsxpivottablemovepatch) 
```ts
interface ContractXlsxPivotTableMovePatch {
  activeSheetPath: string;
  destinationSheetPath: string;
  pivotTablePath: string;
  ref: string;
  destinationRef: string;
  destinationSheetName?: string | null;
  createDestinationSheet?: boolean | null;
  name?: string | null;
}
```
 ### ContractXlsxPivotTableRefreshPatch [Заголовок раздела «ContractXlsxPivotTableRefreshPatch»](#contractxlsxpivottablerefreshpatch) 
```ts
interface ContractXlsxPivotTableRefreshPatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  name?: string | null;


  runtimeOwner?: "rust" | null;
}
```
 ### ContractXlsxPivotTableReportLayoutPatch [Заголовок раздела «ContractXlsxPivotTableReportLayoutPatch»](#contractxlsxpivottablereportlayoutpatch) 
```ts
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;
}
```
 ### ContractXlsxPivotTableShowValuesAsPatch [Заголовок раздела «ContractXlsxPivotTableShowValuesAsPatch»](#contractxlsxpivottableshowvaluesaspatch) 
```ts
interface ContractXlsxPivotTableShowValuesAsPatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  mode: "percentOfTotal" | "percentOfRow" | "runningTotal";
  baseFieldName?: string | null;
  name?: string | null;
}
```
 ### ContractXlsxPivotTableSourceChangePatch [Заголовок раздела «ContractXlsxPivotTableSourceChangePatch»](#contractxlsxpivottablesourcechangepatch) 
```ts
interface ContractXlsxPivotTableSourceChangePatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  sourceSheetName: string;
  sourceRef: string;
  sourceTableName?: string | null;
  name?: string | null;


  runtimeOwner?: "rust" | null;
}
```
 ### ContractXlsxPivotTableStylePatch [Заголовок раздела «ContractXlsxPivotTableStylePatch»](#contractxlsxpivottablestylepatch) 
```ts
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;
}
```
 ### ContractXlsxPivotTableValueFieldAdditionPatch [Заголовок раздела «ContractXlsxPivotTableValueFieldAdditionPatch»](#contractxlsxpivottablevaluefieldadditionpatch) 
```ts
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;
}
```
 ### ContractXlsxPivotTableValueSummaryPatch [Заголовок раздела «ContractXlsxPivotTableValueSummaryPatch»](#contractxlsxpivottablevaluesummarypatch) 
```ts
interface ContractXlsxPivotTableValueSummaryPatch {
  activeSheetPath: string;
  pivotTablePath: string;
  ref: string;
  summaryFunction: "sum" | "count" | "average" | "min" | "max";
  name?: string | null;
  customName?: string | null;
}
```
 ### ContractXlsxPivotValueCellMaterialization [Заголовок раздела «ContractXlsxPivotValueCellMaterialization»](#contractxlsxpivotvaluecellmaterialization) 
```ts
interface ContractXlsxPivotValueCellMaterialization {
  occurrenceId: string;
  rowItems: string[];
  columnItems: string[];
  numericValue?: string | null;
}
```
 ### ContractXlsxPivotValueFieldMaterialization [Заголовок раздела «ContractXlsxPivotValueFieldMaterialization»](#contractxlsxpivotvaluefieldmaterialization) 
```ts
interface ContractXlsxPivotValueFieldMaterialization {
  occurrenceId: string;
  fieldName: string;
  caption: string;
  summaryFunction: "sum" | "count" | "average" | "min" | "max";
}
```

# Типы: Power Query

> Определения типов Compute Contract — запросы, шаги, коннекторы, приватность источников и mashup. Имён: 86.

Определения имён из колонки «Тип TypeScript» на страницах операций. Другие темы словаря: [сеанс, книга и листы](/reference/f1/types-session/) · [ячейки и диапазоны](/reference/f1/types-cells/) · [формулы и вычисления](/reference/f1/types-formulas/) · [форматирование](/reference/f1/types-format/) · [данные и объекты листа](/reference/f1/types-data/) · [сводные таблицы](/reference/f1/types-pivot/) · [диаграммы и графика](/reference/f1/types-charts/) · [печать и разметка страницы](/reference/f1/types-print/) · **Power Query** · [VBA и макросы](/reference/f1/types-vba/) · [защита и рецензирование](/reference/f1/types-protection/) · [общие и служебные](/reference/f1/types-common/). ### AppliedStep [Заголовок раздела «AppliedStep»](#appliedstep) 
```ts
interface AppliedStep {


  stepId: string;


  displayName: string;


  canonicalM: string;


  span: MWireSpan;


  inputs: string[];


  kind: "source" | "transform" | "output";


  astNodeId?: string;
}
```
 ### AppliedStepsProjection [Заголовок раздела «AppliedStepsProjection»](#appliedstepsprojection) 
```ts
interface AppliedStepsProjection {


  queryStableId: string;


  steps: AppliedStep[];


  canonicalM: string;


  diagnostics: InspectorDiagnostic[];


  foldExplainPlan?: FoldExplainPlan;
}
```
 ### ApprovedMacroDescriptor [Заголовок раздела «ApprovedMacroDescriptor»](#approvedmacrodescriptor) 
```ts
interface ApprovedMacroDescriptor {
  macroId: string;
  displayName: string;
  entrypoint: string;
  scope: ApprovedMacroScope;
  sourceLabel: string;
  sourceText: string;
  mode: ApprovedMacroExecutionMode;
  summary: string;
  effectRangeA1: string;
  limitations: string[];
}
```
 ### ApprovedMacroExecutionMode [Заголовок раздела «ApprovedMacroExecutionMode»](#approvedmacroexecutionmode) 
```ts
type ApprovedMacroExecutionMode = "approved-demo";
```
 ### ApprovedMacroScope [Заголовок раздела «ApprovedMacroScope»](#approvedmacroscope) 
```ts
type ApprovedMacroScope = "workbook-local";
```
 ### ApprovedODataFeedDescriptor [Заголовок раздела «ApprovedODataFeedDescriptor»](#approvedodatafeeddescriptor) 
```ts
interface ApprovedODataFeedDescriptor {


  serviceUrl: string;


  approvedHeaders?: [string, string][];


  timeoutMs: number;


  maxResponseBytes: number;


  maxPageCount: number;


  maxTotalRows: number;


  queryOptions?: ODataQueryOptions;


  credential: ODataFeedCredential;


  testAllowlist?: WebSourceTestAllowlist;
}
```
 ### ApprovedSourceDescriptor [Заголовок раздела «ApprovedSourceDescriptor»](#approvedsourcedescriptor) 
```ts
type ApprovedSourceDescriptor =
  | ({ kind: "workbook" } & WorkbookSourceDescriptor)
  | ({ kind: "file" } & FileSourceDescriptor)
  | ({ kind: "folder" } & FolderSourceDescriptor);
```
 ### ApprovedWebConnectorDescriptor [Заголовок раздела «ApprovedWebConnectorDescriptor»](#approvedwebconnectordescriptor) 
```ts
interface ApprovedWebConnectorDescriptor {


  source: ApprovedWebSourceDescriptor;


  relativePath?: string;


  query?: ApprovedWebConnectorHeader[];


  headers?: ApprovedWebConnectorHeader[];


  cacheRetry?: WebConnectorCacheRetryPolicy;


  credentialMode?: WebConnectorCredentialMode;


  credentialScope?: WebConnectorCredentialScope;
}
```
 ### ApprovedWebConnectorHeader [Заголовок раздела «ApprovedWebConnectorHeader»](#approvedwebconnectorheader) 
```ts
interface ApprovedWebConnectorHeader {
  name: string;
  value: string;
}
```
 ### ApprovedWebSourceDescriptor [Заголовок раздела «ApprovedWebSourceDescriptor»](#approvedwebsourcedescriptor) 
```ts
interface ApprovedWebSourceDescriptor {


  url: string;


  workbookId: string;


  queryId?: string;


  timeoutMs?: number;


  revoked?: boolean;


  testAllowlist?: WebSourceTestAllowlist;
}
```
 ### ContractForeignMashupGroup [Заголовок раздела «ContractForeignMashupGroup»](#contractforeignmashupgroup) 
```ts
interface ContractForeignMashupGroup {
  id: string;
  name?: string;
}
```
 ### ContractForeignMashupLoadDestination [Заголовок раздела «ContractForeignMashupLoadDestination»](#contractforeignmashuploaddestination) 
```ts
type ContractForeignMashupLoadDestination =
  | { mode: "existing_sheet"; sheetName: string; anchor: string }
  | { mode: "new_sheet"; sheetName: string }
  | { mode: "connection_only" };
```
 ### ContractForeignMashupProjection [Заголовок раздела «ContractForeignMashupProjection»](#contractforeignmashupprojection) 
```ts
interface ContractForeignMashupProjection {
  readOnly: boolean;
  revision: number;
  refused?: ContractForeignMashupRefusal;
  queries: ContractForeignMashupQueryEntry[];
  groups: ContractForeignMashupGroup[];
  connections: ContractWorkbookConnectionEntry[];
  loadLinks: ContractWorkbookConnectionLoadLink[];
  sourceScopes?: PqSourceScopeWire[];
  unknownElements: string[];
  sectionName?: string;
  sectionDeclarationCount: number;
  sectionHasErrors: boolean;
  hasConfig: boolean;
}
```
 ### ContractForeignMashupQueryEntry [Заголовок раздела «ContractForeignMashupQueryEntry»](#contractforeignmashupqueryentry) 
```ts
interface ContractForeignMashupQueryEntry {
  identity: string;
  name: string;
  dependencyIdentities?: string[];
  stableGuid?: string;
  itemPath?: string;
  queryGroupId?: string;
  isPrivate?: boolean;
  loadEnabled?: boolean;
  loadObjectType?: string;
  loadToDataModel?: boolean;
  resultType?: string;
  expressionParseOk?: boolean;
  expressionPreview?: string;
  expressionSha256?: string;
  previewSanitized: boolean;
  hasSectionDeclaration: boolean;
}
```
 ### ContractForeignMashupRefreshResult [Заголовок раздела «ContractForeignMashupRefreshResult»](#contractforeignmashuprefreshresult) 
```ts
interface ContractForeignMashupRefreshResult {
  status: string;
  revision: number;
  generation: number;
  queryIdentity: string;
  valueKind?: string;
  rowCount?: number;
  columnCount?: number;
  packageHash?: string;
  code?: string;
  detail?: string;
}
```
 ### ContractForeignMashupRefusal [Заголовок раздела «ContractForeignMashupRefusal»](#contractforeignmashuprefusal) 
```ts
interface ContractForeignMashupRefusal {
  code: string;
  detail: string;
}
```
 ### ContractMashupWriteEdit [Заголовок раздела «ContractMashupWriteEdit»](#contractmashupwriteedit) 
```ts
type ContractMashupWriteEdit =
  | { kind: "replace_expression"; query: string; newExpression: string }
  | { kind: "rename_query"; query: string; newName: string }
  | { kind: "delete_query"; query: string }
  | { kind: "duplicate_query"; query: string; newName: string }
  | { kind: "reference_query"; query: string; newName: string }
  | { kind: "load_to"; query: string; destination: ContractForeignMashupLoadDestination; }
  | { kind: "create_connection";
    sourceSubsetId: string;
    name: string;
    destination: ContractWorkbookConnectionDestination;
    refreshOnOpen?: boolean;
  }
  | { kind: "edit_connection";
    connection: string;
    sourceSubsetId?: string;
    name?: string;
    destination?: ContractWorkbookConnectionDestination;
    refreshOnOpen?: boolean;
  }
  | { kind: "rename_connection"; connection: string; newName: string }
  | { kind: "delete_connection"; connection: string }
  | { kind: "duplicate_connection"; connection: string; newName: string }
  | { kind: "reference_connection"; connection: string; newName: string };
```
 ### ContractMashupWriteResult [Заголовок раздела «ContractMashupWriteResult»](#contractmashupwriteresult) 
```ts
interface ContractMashupWriteResult {
  status: string;
  revision: number;
  envelopeHash?: string;
  code?: string;
  detail?: string;
}
```
 ### ContractPowerQueryCell [Заголовок раздела «ContractPowerQueryCell»](#contractpowerquerycell) 
```ts
interface ContractPowerQueryCell {
  kind: ContractPowerQueryCellKind;
  text?: string;
  number?: number;
  integer?: number;
  logical?: boolean;
  date?: string;
  errorSourceText?: string;
  errorTargetType?: string;
}
```
 ### ContractPowerQueryCellKind [Заголовок раздела «ContractPowerQueryCellKind»](#contractpowerquerycellkind) 
```ts
type ContractPowerQueryCellKind = "null" | "text" | "number" | "integer" | "logical" | "date" | "error";
```
 ### ContractPowerQueryTransformOutcome [Заголовок раздела «ContractPowerQueryTransformOutcome»](#contractpowerquerytransformoutcome) 
```ts
type ContractPowerQueryTransformOutcome =
  | { status: "evaluated";
    sourceId: string;
    mSource: string;
    supportedSubset: string;
    columns: string[];
    rows: ContractPowerQueryCell[][];
    cellErrorCount: number;
  }
  | { status: "blocked"; sourceId: string; mSource: string; reason: string; detail: string; };
```
 ### ContractPrivacyInspectorIntent [Заголовок раздела «ContractPrivacyInspectorIntent»](#contractprivacyinspectorintent) 
```ts
type ContractPrivacyInspectorIntent =
  | { action: "scan" }
  | { action: "remove_to_copy";
    destinationUri: string;
    selectedCategories: PrivacyCategory[];
    expectedSourceSha256: string;
  };
```
 ### ContractPrivacyInspectorResult [Заголовок раздела «ContractPrivacyInspectorResult»](#contractprivacyinspectorresult) 
```ts
type ContractPrivacyInspectorResult =
  | { status: "scanned"; inspection: PrivacyInventoryReport }
  | { status: "removed_to_copy"; sanitization: PrivacyMutationReport };
```
 ### ContractQueryDependencyEdge [Заголовок раздела «ContractQueryDependencyEdge»](#contractquerydependencyedge) 
```ts
interface ContractQueryDependencyEdge {
  dependentStableId: string;
  upstreamStableId: string;
}
```
 ### ContractRecomputedQueryStatus [Заголовок раздела «ContractRecomputedQueryStatus»](#contractrecomputedquerystatus) 
```ts
interface ContractRecomputedQueryStatus {
  queryStableId: string;
  recomputed: boolean;
}
```
 ### FoldingNativeQuery [Заголовок раздела «FoldingNativeQuery»](#foldingnativequery) 
```ts
interface FoldingNativeQuery {
  transport: "odata" | "sql" | string;
  text: string;
}
```
 ### ODataFeedCredential [Заголовок раздела «ODataFeedCredential»](#odatafeedcredential) 
```ts
interface ODataFeedCredential {


  mode?: WebConnectorCredentialMode;


  scope: WebConnectorCredentialScope;
}
```
 ### ODataQueryOptions [Заголовок раздела «ODataQueryOptions»](#odataqueryoptions) 
```ts
interface ODataQueryOptions {


  select?: string[];


  filter?: string;


  top?: number;
}
```
 ### PowerQueryInspectorSnapshot [Заголовок раздела «PowerQueryInspectorSnapshot»](#powerqueryinspectorsnapshot) 
```ts
interface PowerQueryInspectorSnapshot {


  source: string;
  ast?: InspectorAstNode;


  bindings: InspectorBinding[];
  outcome: InspectorOutcome;


  diagnostics: InspectorDiagnostic[];
  lineage: InspectorLineage;


  foldExplainPlan?: FoldExplainPlan;


  foldingVerdict: FoldingVerdict;


}
```
 ### PowerQueryLoadDestination [Заголовок раздела «PowerQueryLoadDestination»](#powerqueryloaddestination) 
```ts
interface PowerQueryLoadDestination {
  mode: PowerQueryLoadMode;
  sheetName?: string;


  sheet_name?: string;


  anchor?: CellAnchor;
}
```
 ### PowerQueryLoadMode [Заголовок раздела «PowerQueryLoadMode»](#powerqueryloadmode) 
```ts
type PowerQueryLoadMode = "new-sheet" | "current-anchor" | "existing-range" | "connection-only";
```
 ### PowerQueryLoadPlan [Заголовок раздела «PowerQueryLoadPlan»](#powerqueryloadplan) 
```ts
interface PowerQueryLoadPlan {
  requests: ComputeRequest[];
  outputRect: CellRect;
  sheetKey: string;
  staleClearCount: number;
  createdSheet: boolean;
}
```
 ### PqDataSourceEntry [Заголовок раздела «PqDataSourceEntry»](#pqdatasourceentry) 
```ts
interface PqDataSourceEntry {


  scopeId: string;
  scopeKind: "workbook" | "file" | "folder" | "web" | "odata" | "database";


  queryCount: number;


  pathChangeable: boolean;
}
```
 ### PqDataSourceSettingsOutcome [Заголовок раздела «PqDataSourceSettingsOutcome»](#pqdatasourcesettingsoutcome) 
```ts
interface PqDataSourceSettingsOutcome {
  action: string;


  requestedScopeId: string;


  scopeId?: string;
  accepted: boolean;
  reason?: string;
}
```
 ### PqPostgresConnectorBounds [Заголовок раздела «PqPostgresConnectorBounds»](#pqpostgresconnectorbounds) 
```ts
interface PqPostgresConnectorBounds {
  maxPreviewRows?: number;
  maxTotalRows?: number;
  statementTimeoutMs?: number;
}
```
 ### PqPostgresDeniedWire [Заголовок раздела «PqPostgresDeniedWire»](#pqpostgresdeniedwire) 
```ts
interface PqPostgresDeniedWire {
  reason: string;
  message: string;
}
```
 ### PqPostgresDialogDescriptor [Заголовок раздела «PqPostgresDialogDescriptor»](#pqpostgresdialogdescriptor) 
```ts
interface PqPostgresDialogDescriptor {
  providerId?: "postgres";
  host: string;
  port: number;
  database: string;


  credentialMode?: "stored" | "anonymous";
  credentialScope?: WebConnectorCredentialScope;


  options?: Record<string, string>;
  bounds?: PqPostgresConnectorBounds;
  revoked?: boolean;
}
```
 ### PqPostgresInspectHint [Заголовок раздела «PqPostgresInspectHint»](#pqpostgresinspecthint) 
```ts
interface PqPostgresInspectHint {


  canonicalM: string;


  descriptorJson: string;


  schema?: string;


  item?: string;
}
```
 ### PqPostgresLanGrantWire [Заголовок раздела «PqPostgresLanGrantWire»](#pqpostgreslangrantwire) 
```ts
interface PqPostgresLanGrantWire {
  scopeOrigin: string;
  allowPrivateNetwork: boolean;
}
```
 ### PqPostgresNavTableWire [Заголовок раздела «PqPostgresNavTableWire»](#pqpostgresnavtablewire) 
```ts
interface PqPostgresNavTableWire {
  schema: string;
  name: string;
  kind: string;
}
```
 ### PqPostgresNavigationItemWire [Заголовок раздела «PqPostgresNavigationItemWire»](#pqpostgresnavigationitemwire) 
```ts
interface PqPostgresNavigationItemWire {
  name: string;


  kind: string;
}
```
 ### PqPostgresNavigationSchemaWire [Заголовок раздела «PqPostgresNavigationSchemaWire»](#pqpostgresnavigationschemawire) 
```ts
interface PqPostgresNavigationSchemaWire {
  name: string;
  items: PqPostgresNavigationItemWire[];
}
```
 ### PqPostgresPreviewTableRef [Заголовок раздела «PqPostgresPreviewTableRef»](#pqpostgrespreviewtableref) 
```ts
interface PqPostgresPreviewTableRef {
  schema: string;
  table: string;
}
```
 ### PqPrivacyEvaluationInput [Заголовок раздела «PqPrivacyEvaluationInput»](#pqprivacyevaluationinput) 
```ts
interface PqPrivacyEvaluationInput {
  rootQueryId: string;
  graph?: PqPrivacyGraphNode[];
  levels?: PqPrivacyLevelAssignment[];
}
```
 ### PqPrivacyGraphNode [Заголовок раздела «PqPrivacyGraphNode»](#pqprivacygraphnode) 
```ts
interface PqPrivacyGraphNode {
  queryId: string;
  references?: string[];
  parameters?: string[];
  dynamicSource?: boolean;
  directScopes?: PqSourceScopeWire[];
}
```
 ### PqPrivacyLevelAssignment [Заголовок раздела «PqPrivacyLevelAssignment»](#pqprivacylevelassignment) 
```ts
interface PqPrivacyLevelAssignment {
  canonicalScope: string;
  level: string;
  invalid?: boolean;
}
```
 ### PqPrivacyLevelListEntry [Заголовок раздела «PqPrivacyLevelListEntry»](#pqprivacylevellistentry) 
```ts
interface PqPrivacyLevelListEntry {
  scopeId: string;
  scopeKind: "workbook" | "file" | "folder" | "web" | "odata" | "unknown";
  displayResource: string;
  level: string;
  origin: "user-store" | "workbook-declared" | "effective";
  reason?: string;
}
```
 ### PqPrivacyLevelWriteOutcome [Заголовок раздела «PqPrivacyLevelWriteOutcome»](#pqprivacylevelwriteoutcome) 
```ts
interface PqPrivacyLevelWriteOutcome {
  canonicalScope: string;
  level?: string;
  scopeId?: string;
  accepted: boolean;
  reason?: string;
}
```
 ### PqProductRibbonColumnPayload [Заголовок раздела «PqProductRibbonColumnPayload»](#pqproductribboncolumnpayload) 
```ts
interface PqProductRibbonColumnPayload {
  name: string;
  inferredType: string;
}
```
 ### PqProductRibbonDenied [Заголовок раздела «PqProductRibbonDenied»](#pqproductribbondenied) 
```ts
interface PqProductRibbonDenied {
  reason: string;
  message: string;
}
```
 ### PqProductRibbonQueryPayload [Заголовок раздела «PqProductRibbonQueryPayload»](#pqproductribbonquerypayload) 
```ts
interface PqProductRibbonQueryPayload {
  queryId: string;
  sheetName: string;
  selectorKind: "table" | "range";
  selectorName: string;
  columns: PqProductRibbonColumnPayload[];
  totalRows: number;
  sampledRows: number;
  truncated: boolean;
  stepCount: number;
  canonicalM: string;
  editorAvailable: boolean;
  loaded: boolean;


  loadedQueryStableId?: string;
}
```
 ### PqQueryGraphDiagnostic [Заголовок раздела «PqQueryGraphDiagnostic»](#pqquerygraphdiagnostic) 
```ts
interface PqQueryGraphDiagnostic {
  code: string;
  nodes: string[];
  message: string;
}
```
 ### PqQueryGraphEdge [Заголовок раздела «PqQueryGraphEdge»](#pqquerygraphedge) 
```ts
interface PqQueryGraphEdge {
  from: string;
  to: string;
  kind: "query-ref" | "parameter-ref" | "source-read" | string;
}
```
 ### PqQueryGraphExplain [Заголовок раздела «PqQueryGraphExplain»](#pqquerygraphexplain) 
```ts
interface PqQueryGraphExplain {
  query_stable_id: string;
  display_name: string;
  dependencies: string[];


  plan_availability: string;
  fold_explain_plan?: FoldExplainPlan;


  folding_verdict: FoldingVerdict;
  partition_summary?: PqQueryGraphPartitionSummary;
  diagnostics: PqQueryGraphDiagnostic[];


  postgres_inspect_hint?: PqPostgresInspectHint;
}
```
 ### PqQueryGraphNode [Заголовок раздела «PqQueryGraphNode»](#pqquerygraphnode) 
```ts
interface PqQueryGraphNode {
  id: string;
  kind: "query" | "parameter" | "source" | string;
  display_name: string;


  status: string;
  generation: number;


  diagnostic_code?: string;
}
```
 ### PqQueryGraphNodePublication [Заголовок раздела «PqQueryGraphNodePublication»](#pqquerygraphnodepublication) 
```ts
interface PqQueryGraphNodePublication {
  query_stable_id: string;
  load_plan?: PowerQueryLoadPlan;
  refresh_outcome: unknown;
  persisted_query?: unknown;
}
```
 ### PqQueryGraphPartitionSummary [Заголовок раздела «PqQueryGraphPartitionSummary»](#pqquerygraphpartitionsummary) 
```ts
interface PqQueryGraphPartitionSummary {
  transitive_query_ids: string[];
  transitive_scope_ids: string[];
}
```
 ### PqQueryGraphRefreshOutcome [Заголовок раздела «PqQueryGraphRefreshOutcome»](#pqquerygraphrefreshoutcome) 
```ts
interface PqQueryGraphRefreshOutcome {
  generation: number;
  workbook_revision?: number;


  states: Record<string, string>;
  diagnostics: PqQueryGraphDiagnostic[];


  node_reasons?: Record<string, string>;
}
```
 ### PqQueryGraphSnapshot [Заголовок раздела «PqQueryGraphSnapshot»](#pqquerygraphsnapshot) 
```ts
interface PqQueryGraphSnapshot {
  schema_version: number;
  workbook_revision?: number;
  nodes: PqQueryGraphNode[];
  edges: PqQueryGraphEdge[];
  diagnostics: PqQueryGraphDiagnostic[];
}
```
 ### PqScaleBackpressureState [Заголовок раздела «PqScaleBackpressureState»](#pqscalebackpressurestate) 
```ts
type PqScaleBackpressureState = { state: "ready" } | { state: "throttled"; retryAfterMs: number };
```
 ### PqScaleBudget [Заголовок раздела «PqScaleBudget»](#pqscalebudget) 
```ts
interface PqScaleBudget {
  maxRows: number;
  maxResultBytes: number;
  maxRowBytes: number;
  maxSpillBytes: number;
  maxBatchRows: number;
  timeBudgetMs: number;
}
```
 ### PqScaleDenied [Заголовок раздела «PqScaleDenied»](#pqscaledenied) 
```ts
interface PqScaleDenied {
  reason: PqScaleDeniedReason;
  message: string;
}
```
 ### PqScaleDeniedReason [Заголовок раздела «PqScaleDeniedReason»](#pqscaledeniedreason) 
```ts
type PqScaleDeniedReason =
  | "row-budget-exceeded"
  | "byte-budget-exceeded"
  | "oversized-row"
  | "time-budget-exceeded"
  | "spill-cap-exceeded"
  | "cancelled"
  | "superseded"
  | "firewall-blocked"
  | "unsupported";
```
 ### PqScaleProgressCancelPayload [Заголовок раздела «PqScaleProgressCancelPayload»](#pqscaleprogresscancelpayload) 
```ts
interface PqScaleProgressCancelPayload {
  cancelled: boolean;
}
```
 ### PqScaleProgressOpenPayload [Заголовок раздела «PqScaleProgressOpenPayload»](#pqscaleprogressopenpayload) 
```ts
interface PqScaleProgressOpenPayload {
  sessionId: string;
  rowsTotal: number;
  budget: PqScaleBudget;
}
```
 ### PqScaleProgressPullPayload [Заголовок раздела «PqScaleProgressPullPayload»](#pqscaleprogresspullpayload) 
```ts
interface PqScaleProgressPullPayload {
  status: PqScaleProgressStatus;
  rowsInBatch: number;
  rowsEmitted: number;
  rowsTotal: number;
  bytesEmitted: number;
  backpressure: PqScaleBackpressureState;
  elapsedMs: number;
  batchesPulled: number;
  denied?: PqScaleDenied;
}
```
 ### PqScaleProgressSnapshotPayload [Заголовок раздела «PqScaleProgressSnapshotPayload»](#pqscaleprogresssnapshotpayload) 
```ts
interface PqScaleProgressSnapshotPayload {
  status: PqScaleProgressStatus;
  rowsEmitted: number;
  rowsTotal: number;
  bytesEmitted: number;
  backpressure: PqScaleBackpressureState;
  elapsedMs: number;
  batchesPulled: number;
  denied?: PqScaleDenied;
}
```
 ### PqScaleProgressStatus [Заголовок раздела «PqScaleProgressStatus»](#pqscaleprogressstatus) 
```ts
type PqScaleProgressStatus = "batch" | "done" | "denied";
```
 ### PqSourceScopeWire [Заголовок раздела «PqSourceScopeWire»](#pqsourcescopewire) 
```ts
type PqSourceScopeWire =
  | { kind: "workbook"; workbookStableId: string }
  | { kind: "file"; path: string }
  | { kind: "folder"; root: string }
  | { kind: "web"; origin: string }
  | { kind: "odata"; serviceOrigin: string }
  | { kind: "database"; resource: string };
```
 ### PqSqlServerDeniedWire [Заголовок раздела «PqSqlServerDeniedWire»](#pqsqlserverdeniedwire) 
```ts
interface PqSqlServerDeniedWire {
  reason: string;
  message: string;
}
```
 ### PqSqlServerDescriptor [Заголовок раздела «PqSqlServerDescriptor»](#pqsqlserverdescriptor) 
```ts
interface PqSqlServerDescriptor {
  host: string;
  port?: number;
  database: string;
  user: string;
  credentialScope: string;
  timeoutMs?: number;
  revoked?: boolean;
}
```
 ### PqSqlServerNavigationItemWire [Заголовок раздела «PqSqlServerNavigationItemWire»](#pqsqlservernavigationitemwire) 
```ts
interface PqSqlServerNavigationItemWire {
  schema: string;
  name: string;
  kind: string;
}
```
 ### PqSqlServerTableRef [Заголовок раздела «PqSqlServerTableRef»](#pqsqlservertableref) 
```ts
interface PqSqlServerTableRef {
  schema: string;
  table: string;
}
```
 ### PrivacyCapabilityState [Заголовок раздела «PrivacyCapabilityState»](#privacycapabilitystate) 
```ts
type PrivacyCapabilityState = "remove_live" | "detect_only" | "blocked";
```
 ### PrivacyCategory [Заголовок раздела «PrivacyCategory»](#privacycategory) 
```ts
type PrivacyCategory =
  | "core_properties"
  | "app_properties"
  | "custom_properties"
  | "custom_xml"
  | "thumbnail"
  | "document_server_metadata"
  | "comments_notes"
  | "hidden_sheets"
  | "hidden_rows_columns"
  | "external_links"
  | "custom_views"
  | "drawings";
```
 ### PrivacyCategorySummary [Заголовок раздела «PrivacyCategorySummary»](#privacycategorysummary) 
```ts
interface PrivacyCategorySummary {
  category: PrivacyCategory;
  findingCount: number;
  capabilityState: PrivacyCapabilityState;
  reasonCodes: string[];
}
```
 ### PrivacyFinding [Заголовок раздела «PrivacyFinding»](#privacyfinding) 
```ts
interface PrivacyFinding {
  category: PrivacyCategory;
  reasonCode: string;
  count: number;
  riskLevel: PrivacyRiskLevel;
}
```
 ### PrivacyInventoryReport [Заголовок раздела «PrivacyInventoryReport»](#privacyinventoryreport) 
```ts
interface PrivacyInventoryReport {
  schemaVersion: number;
  sourceSha256: string;
  signedPackage: boolean;
  totalFindingCount: number;
  findings: PrivacyFinding[];
  categories: PrivacyCategorySummary[];
  packageReasonCodes: string[];
}
```
 ### PrivacyMutationReport [Заголовок раздела «PrivacyMutationReport»](#privacymutationreport) 
```ts
interface PrivacyMutationReport {
  schemaVersion: number;
  sourceSha256: string;
  outputSha256: string;
  removedCategories: PrivacyCategory[];
  removedPartCount: number;
  modifiedPartCount: number;
  after: PrivacyInventoryReport;
}
```
 ### PrivacyRiskLevel [Заголовок раздела «PrivacyRiskLevel»](#privacyrisklevel) 
```ts
type PrivacyRiskLevel = "high" | "medium" | "low" | "none";
```
 ### ProductTableRangeRefreshQueryOutcome [Заголовок раздела «ProductTableRangeRefreshQueryOutcome»](#producttablerangerefreshqueryoutcome) 
```ts
interface ProductTableRangeRefreshQueryOutcome {
  queryStableId: string;
  status: "refreshed" | "blocked" | "skipped";
  loadPlan?: PowerQueryLoadPlan;


  persistedQuery?: unknown;
  reason?: string;
  detail?: string;
}
```
 ### TableRangeQueryMutationPreview [Заголовок раздела «TableRangeQueryMutationPreview»](#tablerangequerymutationpreview) 
```ts
interface TableRangeQueryMutationPreview {
  mutation: StepMutationResult;
  preview: TableRangeQueryPreview;
}
```
 ### TableRangeQueryPreview [Заголовок раздела «TableRangeQueryPreview»](#tablerangequerypreview) 
```ts
interface TableRangeQueryPreview {


  outcome: MExpressionOutcome;


  totalRows?: number;


  sampledRows?: number;


  truncated: boolean;
}
```
 ### WebConnectorCacheRetryPolicy [Заголовок раздела «WebConnectorCacheRetryPolicy»](#webconnectorcacheretrypolicy) 
```ts
interface WebConnectorCacheRetryPolicy {


  cacheEnabled?: boolean;


  maxRetries?: number;
}
```
 ### WebConnectorCredentialMode [Заголовок раздела «WebConnectorCredentialMode»](#webconnectorcredentialmode) 
```ts
type WebConnectorCredentialMode = "anonymous" | "webApi";
```
 ### WebConnectorCredentialScope [Заголовок раздела «WebConnectorCredentialScope»](#webconnectorcredentialscope) 
```ts
interface WebConnectorCredentialScope {


  origin: string;


  queryId?: string;
}
```

# Типы: печать и разметка страницы

> Определения типов Compute Contract — параметры страницы, поля, колонтитулы и разрывы. Имён: 26.

Определения имён из колонки «Тип TypeScript» на страницах операций. Другие темы словаря: [сеанс, книга и листы](/reference/f1/types-session/) · [ячейки и диапазоны](/reference/f1/types-cells/) · [формулы и вычисления](/reference/f1/types-formulas/) · [форматирование](/reference/f1/types-format/) · [данные и объекты листа](/reference/f1/types-data/) · [сводные таблицы](/reference/f1/types-pivot/) · [диаграммы и графика](/reference/f1/types-charts/) · **печать и разметка страницы** · [Power Query](/reference/f1/types-powerquery/) · [VBA и макросы](/reference/f1/types-vba/) · [защита и рецензирование](/reference/f1/types-protection/) · [общие и служебные](/reference/f1/types-common/). **Типы на этой странице — 26** * [`ContractPageBreakAreaBounds`](#contractpagebreakareabounds) * [`ContractPageBreakAreaProjection`](#contractpagebreakareaprojection) * [`ContractPageBreakKind`](#contractpagebreakkind) * [`ContractPageBreakLine`](#contractpagebreakline) * [`ContractPageBreakPageSetup`](#contractpagebreakpagesetup) * [`ContractRemoveDuplicatesHeaderPolicy`](#contractremoveduplicatesheaderpolicy) * [`ContractWorksheetPageAxisRange`](#contractworksheetpageaxisrange) * [`ContractWorksheetPageBreakAxis`](#contractworksheetpagebreakaxis) * [`ContractWorksheetPageBreakIntent`](#contractworksheetpagebreakintent) * [`ContractWorksheetPageMargins`](#contractworksheetpagemargins) * [`ContractWorksheetPageOrder`](#contractworksheetpageorder) * [`ContractWorksheetPageOrientation`](#contractworksheetpageorientation) * [`ContractWorksheetPageScaleMode`](#contractworksheetpagescalemode) * [`ContractWorksheetPageSetup`](#contractworksheetpagesetup) * [`ContractWorksheetPrintArea`](#contractworksheetprintarea) * [`ContractXlsxPrintAreaClearPatch`](#contractxlsxprintareaclearpatch) * [`ContractXlsxPrintAreaPatch`](#contractxlsxprintareapatch) * [`ContractXlsxPrintTitlesClearPatch`](#contractxlsxprinttitlesclearpatch) * [`ContractXlsxPrintTitlesPatch`](#contractxlsxprinttitlespatch) * [`ContractXlsxWorksheetHeaderFooterClearPatch`](#contractxlsxworksheetheaderfooterclearpatch) * [`ContractXlsxWorksheetHeaderFooterPatch`](#contractxlsxworksheetheaderfooterpatch) * [`ContractXlsxWorksheetPageBreakPatch`](#contractxlsxworksheetpagebreakpatch) * [`ContractXlsxWorksheetPageBreakResetPatch`](#contractxlsxworksheetpagebreakresetpatch) * [`ContractXlsxWorksheetPageSetupPatch`](#contractxlsxworksheetpagesetuppatch) * [`ContractXlsxWorksheetPrintOptionsPatch`](#contractxlsxworksheetprintoptionspatch) * [`SortRangeRowsHeaderMode`](#sortrangerowsheadermode) ### ContractPageBreakAreaBounds [Заголовок раздела «ContractPageBreakAreaBounds»](#contractpagebreakareabounds) 
```ts
interface ContractPageBreakAreaBounds {
  rowStart: number;
  rowEnd: number;
  colStart: number;
  colEnd: number;
}
```
 ### ContractPageBreakAreaProjection [Заголовок раздела «ContractPageBreakAreaProjection»](#contractpagebreakareaprojection) 
```ts
interface ContractPageBreakAreaProjection {
  bounds: ContractPageBreakAreaBounds;
  rowBreaks: ContractPageBreakLine[];
  colBreaks: ContractPageBreakLine[];
  pagesAcross: number;
  pagesDown: number;
  pageCount: number;
}
```
 ### ContractPageBreakKind [Заголовок раздела «ContractPageBreakKind»](#contractpagebreakkind) 
```ts
type ContractPageBreakKind = "manual" | "automatic";
```
 ### ContractPageBreakLine [Заголовок раздела «ContractPageBreakLine»](#contractpagebreakline) 
```ts
interface ContractPageBreakLine {


  position: number;
  kind: ContractPageBreakKind;
}
```
 ### ContractPageBreakPageSetup [Заголовок раздела «ContractPageBreakPageSetup»](#contractpagebreakpagesetup) 
```ts
interface ContractPageBreakPageSetup {
  paperSize: number;
  orientationLandscape: boolean;


  scale: number;
  marginLeftIn: number;
  marginRightIn: number;
  marginTopIn: number;
  marginBottomIn: number;
}
```
 ### ContractRemoveDuplicatesHeaderPolicy [Заголовок раздела «ContractRemoveDuplicatesHeaderPolicy»](#contractremoveduplicatesheaderpolicy) 
```ts
type ContractRemoveDuplicatesHeaderPolicy = "auto" | "present" | "absent";
```
 ### ContractWorksheetPageAxisRange [Заголовок раздела «ContractWorksheetPageAxisRange»](#contractworksheetpageaxisrange) 
```ts
interface ContractWorksheetPageAxisRange {
  start: number;
  end: number;
}
```
 ### ContractWorksheetPageBreakAxis [Заголовок раздела «ContractWorksheetPageBreakAxis»](#contractworksheetpagebreakaxis) 
```ts
type ContractWorksheetPageBreakAxis = "row" | "column";
```
 ### ContractWorksheetPageBreakIntent [Заголовок раздела «ContractWorksheetPageBreakIntent»](#contractworksheetpagebreakintent) 
```ts
type ContractWorksheetPageBreakIntent =
  | { action: "insert-at-cell"; rowPosition?: number
  | null; colPosition?: number
  | null; }
  | { action: "remove-at-cell"; rowPosition?: number
  | null; colPosition?: number
  | null; }
  | { action: "insert"; axis: ContractWorksheetPageBreakAxis; position: number }
  | { action: "remove"; axis: ContractWorksheetPageBreakAxis; position: number }
  | { action: "move"; axis: ContractWorksheetPageBreakAxis; fromPosition: number; toPosition: number; }
  | { action: "reset-all" };
```
 ### ContractWorksheetPageMargins [Заголовок раздела «ContractWorksheetPageMargins»](#contractworksheetpagemargins) 
```ts
interface ContractWorksheetPageMargins {
  left: number;
  right: number;
  top: number;
  bottom: number;
  header: number;
  footer: number;
}
```
 ### ContractWorksheetPageOrder [Заголовок раздела «ContractWorksheetPageOrder»](#contractworksheetpageorder) 
```ts
type ContractWorksheetPageOrder = "downThenOver" | "overThenDown";
```
 ### ContractWorksheetPageOrientation [Заголовок раздела «ContractWorksheetPageOrientation»](#contractworksheetpageorientation) 
```ts
type ContractWorksheetPageOrientation = "portrait" | "landscape";
```
 ### ContractWorksheetPageScaleMode [Заголовок раздела «ContractWorksheetPageScaleMode»](#contractworksheetpagescalemode) 
```ts
type ContractWorksheetPageScaleMode = "adjust" | "fit";
```
 ### ContractWorksheetPageSetup [Заголовок раздела «ContractWorksheetPageSetup»](#contractworksheetpagesetup) 
```ts
interface ContractWorksheetPageSetup {
  orientation: ContractWorksheetPageOrientation;
  paperSize: number;
  scaleMode: ContractWorksheetPageScaleMode;


  scaleDraft: string;
  fitToWidth: number;
  fitToHeight: number;
  margins: ContractWorksheetPageMargins;
  printGridLines: boolean;
  printHeadings: boolean;


  printArea?: ContractWorksheetPrintArea | null;


  printTitleRows?: ContractWorksheetPageAxisRange | null;


  printTitleColumns?: ContractWorksheetPageAxisRange | null;


  oddHeader?: string;


  oddFooter?: string;


  pageOrder?: ContractWorksheetPageOrder;
}
```
 ### ContractWorksheetPrintArea [Заголовок раздела «ContractWorksheetPrintArea»](#contractworksheetprintarea) 
```ts
interface ContractWorksheetPrintArea {
  rowStart: number;
  rowEnd: number;
  colStart: number;
  colEnd: number;
}
```
 ### ContractXlsxPrintAreaClearPatch [Заголовок раздела «ContractXlsxPrintAreaClearPatch»](#contractxlsxprintareaclearpatch) 
```ts
interface ContractXlsxPrintAreaClearPatch {
  activeSheetPath: string;
}
```
 ### ContractXlsxPrintAreaPatch [Заголовок раздела «ContractXlsxPrintAreaPatch»](#contractxlsxprintareapatch) 
```ts
interface ContractXlsxPrintAreaPatch {
  activeSheetPath: string;
  ref: string;
}
```
 ### ContractXlsxPrintTitlesClearPatch [Заголовок раздела «ContractXlsxPrintTitlesClearPatch»](#contractxlsxprinttitlesclearpatch) 
```ts
interface ContractXlsxPrintTitlesClearPatch {
  activeSheetPath: string;
}
```
 ### ContractXlsxPrintTitlesPatch [Заголовок раздела «ContractXlsxPrintTitlesPatch»](#contractxlsxprinttitlespatch) 
```ts
interface ContractXlsxPrintTitlesPatch {
  activeSheetPath: string;
  rowStart: number;
  rowEnd: number;
}
```
 ### ContractXlsxWorksheetHeaderFooterClearPatch [Заголовок раздела «ContractXlsxWorksheetHeaderFooterClearPatch»](#contractxlsxworksheetheaderfooterclearpatch) 
```ts
interface ContractXlsxWorksheetHeaderFooterClearPatch {
  activeSheetPath: string;
}
```
 ### ContractXlsxWorksheetHeaderFooterPatch [Заголовок раздела «ContractXlsxWorksheetHeaderFooterPatch»](#contractxlsxworksheetheaderfooterpatch) 
```ts
interface ContractXlsxWorksheetHeaderFooterPatch {
  activeSheetPath: string;
  oddHeader?: string | null;
  oddFooter?: string | null;
}
```
 ### ContractXlsxWorksheetPageBreakPatch [Заголовок раздела «ContractXlsxWorksheetPageBreakPatch»](#contractxlsxworksheetpagebreakpatch) 
```ts
interface ContractXlsxWorksheetPageBreakPatch {
  activeSheetPath: string;
  rowBreakId?: number | null;
  columnBreakId?: number | null;
}
```
 ### ContractXlsxWorksheetPageBreakResetPatch [Заголовок раздела «ContractXlsxWorksheetPageBreakResetPatch»](#contractxlsxworksheetpagebreakresetpatch) 
```ts
interface ContractXlsxWorksheetPageBreakResetPatch {
  activeSheetPath: string;
}
```
 ### ContractXlsxWorksheetPageSetupPatch [Заголовок раздела «ContractXlsxWorksheetPageSetupPatch»](#contractxlsxworksheetpagesetuppatch) 
```ts
interface ContractXlsxWorksheetPageSetupPatch {
  activeSheetPath: string;
  orientation?: "portrait" | "landscape" | null;
  paperSize?: number | null;
  scale?: number | null;
  fitToWidth?: number | null;
  fitToHeight?: number | null;
  pageMargins?: {
    left: number;
    right: number;
    top: number;
    bottom: number;
    header: number;
    footer: number;
  } | null;
}
```
 ### ContractXlsxWorksheetPrintOptionsPatch [Заголовок раздела «ContractXlsxWorksheetPrintOptionsPatch»](#contractxlsxworksheetprintoptionspatch) 
```ts
interface ContractXlsxWorksheetPrintOptionsPatch {
  activeSheetPath: string;
  gridLines?: boolean | null;
  headings?: boolean | null;
}
```
 ### SortRangeRowsHeaderMode [Заголовок раздела «SortRangeRowsHeaderMode»](#sortrangerowsheadermode) 
```ts
type SortRangeRowsHeaderMode = "auto" | "present" | "absent";
```

# Типы: защита и рецензирование

> Определения типов Compute Contract — защита, разрешения, примечания, исправления и подписи. Имён: 65.

Определения имён из колонки «Тип TypeScript» на страницах операций. Другие темы словаря: [сеанс, книга и листы](/reference/f1/types-session/) · [ячейки и диапазоны](/reference/f1/types-cells/) · [формулы и вычисления](/reference/f1/types-formulas/) · [форматирование](/reference/f1/types-format/) · [данные и объекты листа](/reference/f1/types-data/) · [сводные таблицы](/reference/f1/types-pivot/) · [диаграммы и графика](/reference/f1/types-charts/) · [печать и разметка страницы](/reference/f1/types-print/) · [Power Query](/reference/f1/types-powerquery/) · [VBA и макросы](/reference/f1/types-vba/) · **защита и рецензирование** · [общие и служебные](/reference/f1/types-common/). ### ContractCommentRichTextRun [Заголовок раздела «ContractCommentRichTextRun»](#contractcommentrichtextrun) 
```ts
interface ContractCommentRichTextRun {
  text: string;
  fontFamily?: string | null;
  fontSize?: string | null;
  bold?: boolean | null;
  italic?: boolean | null;
  color?: string | null;
  language?: string | null;
  rtl?: boolean | null;
}
```
 ### ContractCustomViewOutlineTrack [Заголовок раздела «ContractCustomViewOutlineTrack»](#contractcustomviewoutlinetrack) 
```ts
interface ContractCustomViewOutlineTrack {
  axis: ContractCustomViewOutlineAxis;
  index: number;
  level: number;
  collapsed: boolean;
}
```
 ### ContractOutlineTrackState [Заголовок раздела «ContractOutlineTrackState»](#contractoutlinetrackstate) 
```ts
interface ContractOutlineTrackState {
  index: number;
  level: number;
  hidden: boolean;
  collapsed: boolean;
}
```
 ### ContractProtectedRangeAccessKind [Заголовок раздела «ContractProtectedRangeAccessKind»](#contractprotectedrangeaccesskind) 
```ts
type ContractProtectedRangeAccessKind = | "open" | "password" | "domain_permission" | "irm" | "unsupported_algorithm" | "invalid_verifier";
```
 ### ContractProtectedRangeView [Заголовок раздела «ContractProtectedRangeView»](#contractprotectedrangeview) 
```ts
interface ContractProtectedRangeView {
  id: string;
  sheetKey: string;
  sheetName: string;
  name: string;
  sqref: string;
  accessKind: ContractProtectedRangeAccessKind;
  supported: boolean;
  unlocked: boolean;
  unsupportedCode?: string | null;
}
```
 ### ContractProtectedRangesIntent [Заголовок раздела «ContractProtectedRangesIntent»](#contractprotectedrangesintent) 
```ts
type ContractProtectedRangesIntent =
  | { action: "list"; sheetKey: string }
  | ({ action: "create"; sheetKey: string; name: string; sqref: string; password?: string
  | null; } & ProtectedRangesMutationGuard)
  | ({ action: "update";
    sheetKey: string;
    rangeId: string;
    name: string;
    sqref: string;
    clearPassword?: boolean;
  password?: string
  | null; } & ProtectedRangesMutationGuard)
  | ({ action: "rename"; sheetKey: string; rangeId: string; name: string; } & ProtectedRangesMutationGuard)
  | ({ action: "delete"; sheetKey: string; rangeId: string; } & ProtectedRangesMutationGuard)
  | { action: "unlock"; sheetKey: string; rangeId: string; password: string; expectedRevision?: number
  | null; }
  | { action: "lock"; sheetKey: string; rangeId: string; expectedRevision?: number
  | null; }
  | { action: "reset"; sheetKey?: string
  | null; expectedRevision?: number
  | null; }
  | ({ action: "undo" } & ProtectedRangesMutationGuard)
  | ({ action: "redo" } & ProtectedRangesMutationGuard);
```
 ### ContractProtectedRangesResult [Заголовок раздела «ContractProtectedRangesResult»](#contractprotectedrangesresult) 
```ts
interface ContractProtectedRangesResult {
  status:
    | "listed"
    | "applied"
    | "unlocked"
    | "locked"
    | "reset"
    | "undone"
    | "redone";
  revision: number;
  sheetKey: string;
  sheetName: string;
  entries: ContractProtectedRangeView[];
  unlockedCount: number;
  undoDepth: number;
  redoDepth: number;
  mutatedCount: number;
}
```
 ### ContractProtectionAuditCategory [Заголовок раздела «ContractProtectionAuditCategory»](#contractprotectionauditcategory) 
```ts
type ContractProtectionAuditCategory = "workbook" | "sheet" | "cell" | "protected-range";
```
 ### ContractProtectionAuditFinding [Заголовок раздела «ContractProtectionAuditFinding»](#contractprotectionauditfinding) 
```ts
interface ContractProtectionAuditFinding {
  stableId: string;
  kind: ContractProtectionAuditFindingKind;
  category: ContractProtectionAuditCategory;
  severity: ContractProtectionAuditSeverity;
  reasonCode: string;
  sheetId?: string | null;
  sheetName?: string | null;
  locationLabel: string;
  navigationTarget: ContractProtectionAuditNavigationTarget;
  observedRevision: number;
  remediations?: ContractProtectionAuditRemediation[];
}
```
 ### ContractProtectionAuditFindingKind [Заголовок раздела «ContractProtectionAuditFindingKind»](#contractprotectionauditfindingkind) 
```ts
type ContractProtectionAuditFindingKind =
  | "malformed-workbook-protection"
  | "unsupported-workbook-protection"
  | "malformed-sheet-protection"
  | "unsupported-sheet-protection-verifier"
  | "invalid-sheet-protection-verifier"
  | "malformed-protected-ranges"
  | "unsupported-protected-range"
  | "invalid-protected-range-verifier"
  | "non-canonical-protected-range-sqref"
  | "protected-ranges-inactive"
  | "hidden-cell-ineffective"
  | "hidden-non-formula-cell"
  | "missing-cell-style"
  | "session-authority-active"
  | "stale-session-authority";
```
 ### ContractProtectionAuditIntent [Заголовок раздела «ContractProtectionAuditIntent»](#contractprotectionauditintent) 
```ts
type ContractProtectionAuditIntent =
  | { action: "scan" }
  | { action: "apply"; findingId: string; remediation: ContractProtectionAuditRemediationKind; }
  | { action: "fix_all" }
  | { action: "undo" }
  | { action: "redo" };
```
 ### ContractProtectionAuditNavigationTarget [Заголовок раздела «ContractProtectionAuditNavigationTarget»](#contractprotectionauditnavigationtarget) 
```ts
type ContractProtectionAuditNavigationTarget =
  | { kind: "workbook" }
  | { kind: "sheet"; sheetId: string }
  | { kind: "cell"; sheetId: string; row: number; col: number; cellRef: string }
  | { kind: "protected-range"; sheetId: string; rangeId: string; sqref: string; };
```
 ### ContractProtectionAuditRemediation [Заголовок раздела «ContractProtectionAuditRemediation»](#contractprotectionauditremediation) 
```ts
interface ContractProtectionAuditRemediation {
  kind: ContractProtectionAuditRemediationKind;
  fixAllEligible: boolean;
}
```
 ### ContractProtectionAuditRemediationKind [Заголовок раздела «ContractProtectionAuditRemediationKind»](#contractprotectionauditremediationkind) 
```ts
type ContractProtectionAuditRemediationKind = "normalize-protected-range-sqref" | "revoke-session-authority";
```
 ### ContractProtectionAuditResult [Заголовок раздела «ContractProtectionAuditResult»](#contractprotectionauditresult) 
```ts
interface ContractProtectionAuditResult {
  requestId: string;
  generation: number;
  revision: number;
  status: ContractProtectionAuditStatus;
  reason?: string | null;
  workbook: ContractProtectionWorkbookAuditState;
  sheets: ContractProtectionSheetAuditState[];
  totalFindingCount: number;
  returnedFindingCount: number;
  truncated: boolean;
  undoDepth: number;
  redoDepth: number;
  mutatedCount: number;
  packageMutated: boolean;
  findings: ContractProtectionAuditFinding[];
}
```
 ### ContractProtectionAuditSeverity [Заголовок раздела «ContractProtectionAuditSeverity»](#contractprotectionauditseverity) 
```ts
type ContractProtectionAuditSeverity = "error" | "warning" | "info";
```
 ### ContractProtectionAuditStatus [Заголовок раздела «ContractProtectionAuditStatus»](#contractprotectionauditstatus) 
```ts
type ContractProtectionAuditStatus = "scanned" | "mutated" | "undone" | "redone" | "blocked";
```
 ### ContractProtectionSheetAuditState [Заголовок раздела «ContractProtectionSheetAuditState»](#contractprotectionsheetauditstate) 
```ts
interface ContractProtectionSheetAuditState {
  sheetId: string;
  sheetName: string;
  packageProtected: boolean;
  effectiveProtected: boolean;
  sessionUnlocked: boolean;
  allowedActions: string[];
  presentCellCount: number;
  lockedCellCount: number;
  unlockedCellCount: number;
  hiddenCellCount: number;
  hiddenFormulaCellCount: number;
  malformedStyleReferenceCount: number;
  protectedRangeCount: number;
  unlockedProtectedRangeCount: number;
  overlapPairCount: number;
}
```
 ### ContractProtectionWorkbookAuditState [Заголовок раздела «ContractProtectionWorkbookAuditState»](#contractprotectionworkbookauditstate) 
```ts
interface ContractProtectionWorkbookAuditState {
  packageProtected: boolean;
  lockStructure: boolean;
  lockWindows: boolean;
  effectiveStructureLocked: boolean;
  effectiveWindowsLocked: boolean;
  sessionUnlocked: boolean;
  supported: boolean;
  stateCode?: string | null;
}
```
 ### ContractReviewAnchorCellMapping [Заголовок раздела «ContractReviewAnchorCellMapping»](#contractreviewanchorcellmapping) 
```ts
interface ContractReviewAnchorCellMapping {
  from: string;
  to: string;
}
```
 ### ContractReviewAnchorTransform [Заголовок раздела «ContractReviewAnchorTransform»](#contractreviewanchortransform) 
```ts
type ContractReviewAnchorTransform =
  | { kind: "copy_cells"; mappings: ContractReviewAnchorCellMapping[] }
  | { kind: "fill_cells"; mappings: ContractReviewAnchorCellMapping[] }
  | { kind: "move_cells"; mappings: ContractReviewAnchorCellMapping[] }
  | { kind: "insert_rows"; at: number; count: number }
  | { kind: "delete_rows"; at: number; count: number }
  | { kind: "insert_columns"; at: number; count: number }
  | { kind: "delete_columns"; at: number; count: number }
  | { kind: "reorder_rows"; mappings: ContractReviewAnchorCellMapping[] }
  | { kind: "filter_rows" }
  | { kind: "rename_sheet"; newSheetId: string }
  | { kind: "copy_sheet"; newSheetId: string }
  | { kind: "delete_sheet" };
```
 ### ContractReviewAnnotation [Заголовок раздела «ContractReviewAnnotation»](#contractreviewannotation) 
```ts
interface ContractReviewAnnotation {
  annotationId: string;
  kind: ContractReviewAnnotationKind;
  supportState: ContractReviewAnnotationSupportState;
  sheetId: string;
  cellRef: string;
  personId: string;
  author: string;
  text: string;
  paragraphs?: ContractTextParagraph[];
  createdAt: string;
  modifiedAt: string;
  visible?: boolean;
  resolved?: boolean;
  replies?: ContractReviewReply[];
  task?: ContractReviewTask | null;
  preservedMentionsXml?: string[];
}
```
 ### ContractReviewAnnotationKind [Заголовок раздела «ContractReviewAnnotationKind»](#contractreviewannotationkind) 
```ts
type ContractReviewAnnotationKind = "legacy-note" | "threaded-comment";
```
 ### ContractReviewAnnotationSupportState [Заголовок раздела «ContractReviewAnnotationSupportState»](#contractreviewannotationsupportstate) 
```ts
type ContractReviewAnnotationSupportState = "live" | "unsupported-preserved";
```
 ### ContractReviewAnnotationsIntent [Заголовок раздела «ContractReviewAnnotationsIntent»](#contractreviewannotationsintent) 
```ts
type ContractReviewAnnotationsIntent =
  | { action: "list" }
  | { action: "upsert";
    kind: ContractReviewAnnotationKind;
    cellRef: string;
    text: string;
    author: string;
    annotationId?: string;
    visible?: boolean;
    paragraphs?: ContractTextParagraph[];
  }
  | { action: "delete"; annotationId: string }
  | { action: "reply"; annotationId: string; text: string; author: string }
  | { action: "delete_reply"; annotationId: string; replyId: string }
  | { action: "set_resolved"; annotationId: string; resolved: boolean }
  | { action: "set_task"; annotationId: string; title: string; assignee: string; }
  | { action: "set_task_completed"; annotationId: string; completed: boolean }
  | { action: "remove_task"; annotationId: string }
  | { action: "set_note_visibility"; annotationId: string; visible: boolean }
  | { action: "show_all_notes"; visible: boolean }
  | { action: "transform_anchors"; transform: ContractReviewAnchorTransform }
  | { action: "undo" }
  | { action: "redo" };
```
 ### ContractReviewAnnotationsResult [Заголовок раздела «ContractReviewAnnotationsResult»](#contractreviewannotationsresult) 
```ts
interface ContractReviewAnnotationsResult {
  requestId: string;
  generation: number;
  status: ContractReviewAnnotationsStatus;
  state: ContractReviewAnnotationsState;
  reason?: string;
}
```
 ### ContractReviewAnnotationsSnapshot [Заголовок раздела «ContractReviewAnnotationsSnapshot»](#contractreviewannotationssnapshot) 
```ts
interface ContractReviewAnnotationsSnapshot {
  sheetId: string;
  persons: ContractReviewPerson[];
  annotations: ContractReviewAnnotation[];
}
```
 ### ContractReviewAnnotationsState [Заголовок раздела «ContractReviewAnnotationsState»](#contractreviewannotationsstate) 
```ts
interface ContractReviewAnnotationsState {
  workbookId: string;
  revision: number;
  generation: number;
  undoStack: ContractReviewAnnotationsSnapshot[];
  redoStack: ContractReviewAnnotationsSnapshot[];
}
```
 ### ContractReviewAnnotationsStatus [Заголовок раздела «ContractReviewAnnotationsStatus»](#contractreviewannotationsstatus) 
```ts
type ContractReviewAnnotationsStatus = "listed" | "mutated" | "undone" | "redone" | "blocked";
```
 ### ContractReviewInkDeleteScope [Заголовок раздела «ContractReviewInkDeleteScope»](#contractreviewinkdeletescope) 
```ts
type ContractReviewInkDeleteScope = "sheet" | "workbook";
```
 ### ContractReviewInkIdentityLedgerEntry [Заголовок раздела «ContractReviewInkIdentityLedgerEntry»](#contractreviewinkidentityledgerentry) 
```ts
interface ContractReviewInkIdentityLedgerEntry {
  stableId: string;
  sheetPath: string;
  drawingPath: string;
  nonVisualId: string;
  relationshipIds: string[];
  removedParts: string[];
}
```
 ### ContractReviewInkPreservedPart [Заголовок раздела «ContractReviewInkPreservedPart»](#contractreviewinkpreservedpart) 
```ts
interface ContractReviewInkPreservedPart {
  partName: string;
  sha256: string;
}
```
 ### ContractReviewInkProjectionItem [Заголовок раздела «ContractReviewInkProjectionItem»](#contractreviewinkprojectionitem) 
```ts
interface ContractReviewInkProjectionItem {
  stableId: string;
  objectId: string;
  sheetPath: string;
  name: string;
  presenceStatus: ContractWorkbookObjectPresenceStatus;
  supportState: ContractWorkbookObjectSupportState;
  anchor: ContractObjectAnchor;
  inkXml: string;
}
```
 ### ContractReviewPerson [Заголовок раздела «ContractReviewPerson»](#contractreviewperson) 
```ts
interface ContractReviewPerson {
  personId: string;
  displayName: string;
}
```
 ### ContractReviewReply [Заголовок раздела «ContractReviewReply»](#contractreviewreply) 
```ts
interface ContractReviewReply {
  replyId: string;
  personId: string;
  author: string;
  text: string;
  createdAt: string;
  modifiedAt: string;
}
```
 ### ContractReviewTask [Заголовок раздела «ContractReviewTask»](#contractreviewtask) 
```ts
interface ContractReviewTask {
  taskId: string;
  title: string;
  assignee: string;
  status: ContractReviewTaskStatus;
  deliveryScope: ContractReviewTaskDeliveryScope;
  createdAt: string;
  modifiedAt: string;
}
```
 ### ContractReviewTaskDeliveryScope [Заголовок раздела «ContractReviewTaskDeliveryScope»](#contractreviewtaskdeliveryscope) 
```ts
type ContractReviewTaskDeliveryScope = "workbook-local-no-external-delivery";
```
 ### ContractReviewTaskStatus [Заголовок раздела «ContractReviewTaskStatus»](#contractreviewtaskstatus) 
```ts
type ContractReviewTaskStatus = "open" | "completed";
```
 ### ContractSheetProtectionAllowedAction [Заголовок раздела «ContractSheetProtectionAllowedAction»](#contractsheetprotectionallowedaction) 
```ts
type ContractSheetProtectionAllowedAction =
  | "selectLockedCells"
  | "selectUnlockedCells"
  | "formatCells"
  | "formatColumns"
  | "formatRows"
  | "insertColumns"
  | "insertRows"
  | "insertHyperlinks"
  | "deleteColumns"
  | "deleteRows"
  | "sort"
  | "autoFilter"
  | "pivotTables"
  | "editObjects"
  | "editScenarios";
```
 ### ContractSheetProtectionSessionAction [Заголовок раздела «ContractSheetProtectionSessionAction»](#contractsheetprotectionsessionaction) 
```ts
type ContractSheetProtectionSessionAction = "status" | "unlock" | "lock";
```
 ### ContractThreadedCommentPayload [Заголовок раздела «ContractThreadedCommentPayload»](#contractthreadedcommentpayload) 
```ts
interface ContractThreadedCommentPayload {
  source: ContractThreadedCommentPayloadSource;
  cellRef: string;
  author?: string | null;
  text: string;
  commentId?: string | null;
  personId?: string | null;
  createdAt?: string | null;
  modifiedAt?: string | null;
  resolved?: boolean;
  replies?: ContractThreadedCommentReplyPayload[] | null;
  taskAssignment?: ContractThreadedCommentTaskAssignment | null;
  preservedMentionsXml?: string[] | null;
}
```
 ### ContractThreadedCommentPayloadSource [Заголовок раздела «ContractThreadedCommentPayloadSource»](#contractthreadedcommentpayloadsource) 
```ts
type ContractThreadedCommentPayloadSource = "threaded-comments";
```
 ### ContractThreadedCommentReplyPayload [Заголовок раздела «ContractThreadedCommentReplyPayload»](#contractthreadedcommentreplypayload) 
```ts
interface ContractThreadedCommentReplyPayload {
  text: string;
  author?: string | null;
  replyId?: string | null;
  personId?: string | null;
  createdAt?: string | null;
  modifiedAt?: string | null;
}
```
 ### ContractThreadedCommentTaskAssignment [Заголовок раздела «ContractThreadedCommentTaskAssignment»](#contractthreadedcommenttaskassignment) 
```ts
interface ContractThreadedCommentTaskAssignment {
  source:
    | "f1-workbook-local-task-extension"
    | "f1-workbook-local-task-extension-malformed"
    | "f1-bounded-task-marker";
  assignee: string;
  status: "open" | "completed" | "assigned" | "";
  taskId?: string | null;
  title?: string | null;
  deliveryScope?: ContractReviewTaskDeliveryScope | null;
  createdAt?: string | null;
  modifiedAt?: string | null;
}
```
 ### ContractTrackAxis [Заголовок раздела «ContractTrackAxis»](#contracttrackaxis) 
```ts
type ContractTrackAxis = "row" | "column";
```
 ### ContractTrackStructureAction [Заголовок раздела «ContractTrackStructureAction»](#contracttrackstructureaction) 
```ts
type ContractTrackStructureAction = "insert" | "delete";
```
 ### ContractTrackVisibilityOwner [Заголовок раздела «ContractTrackVisibilityOwner»](#contracttrackvisibilityowner) 
```ts
type ContractTrackVisibilityOwner = "manual" | "filter";
```
 ### ContractWorkbookProtectionIntent [Заголовок раздела «ContractWorkbookProtectionIntent»](#contractworkbookprotectionintent) 
```ts
type ContractWorkbookProtectionIntent =
  | { action: "status" }
  | ({ action: "protect"; lockStructure: boolean; lockWindows: boolean; password?: string
  | null; } & WorkbookProtectionMutationGuard)
  | { action: "unlock"; password: string; expectedRevision?: number
  | null }
  | { action: "lock"; expectedRevision?: number
  | null }
  | { action: "reset" }
  | ({ action: "unprotect"; password?: string
  | null; } & WorkbookProtectionMutationGuard)
  | ({ action: "undo" } & WorkbookProtectionMutationGuard)
  | ({ action: "redo" } & WorkbookProtectionMutationGuard);
```
 ### ContractWorkbookProtectionResult [Заголовок раздела «ContractWorkbookProtectionResult»](#contractworkbookprotectionresult) 
```ts
interface ContractWorkbookProtectionResult {
  status:
    | "status"
    | "protected"
    | "unlocked"
    | "locked"
    | "reset"
    | "unprotected"
    | "undone"
    | "redone";
  revision: number;
  lockStructure: boolean;
  lockWindows: boolean;
  effectiveStructureLocked: boolean;
  effectiveWindowsLocked: boolean;
  passwordProtected: boolean;
  sessionUnlocked: boolean;
  supported: boolean;
  unsupportedCode?: string | null;
  undoDepth: number;
  redoDepth: number;
  mutatedCount: number;
}
```
 ### ContractXlsxThreadedCommentMutationPatch [Заголовок раздела «ContractXlsxThreadedCommentMutationPatch»](#contractxlsxthreadedcommentmutationpatch) 
```ts
interface ContractXlsxThreadedCommentMutationPatch {
  activeSheetPath: string;
  cellRef: string;
  action: "upsert" | "delete" | "reply" | "resolve" | "reopen" | "assign-task";
  text?: string | null;
  author?: string | null;
  commentId?: string | null;
  personId?: string | null;
  createdAt?: string | null;
  modifiedAt?: string | null;
  resolved?: boolean | null;
  replyId?: string | null;
  replies?: ContractXlsxThreadedCommentReplyPatch[] | null;
  task?: ContractReviewTask | null;


  assignee?: string | null;
}
```
 ### ContractXlsxThreadedCommentReplyPatch [Заголовок раздела «ContractXlsxThreadedCommentReplyPatch»](#contractxlsxthreadedcommentreplypatch) 
```ts
interface ContractXlsxThreadedCommentReplyPatch {
  text: string;
  author?: string | null;
  replyId?: string | null;
  personId?: string | null;
  createdAt?: string | null;
  modifiedAt?: string | null;
}
```
 ### ContractXlsxTrackTransferAxis [Заголовок раздела «ContractXlsxTrackTransferAxis»](#contractxlsxtracktransferaxis) 
```ts
type ContractXlsxTrackTransferAxis = "row" | "column";
```
 ### ContractXlsxTrackTransferMode [Заголовок раздела «ContractXlsxTrackTransferMode»](#contractxlsxtracktransfermode) 
```ts
type ContractXlsxTrackTransferMode = "move" | "copy";
```
 ### ContractXlsxTrackTransferPatch [Заголовок раздела «ContractXlsxTrackTransferPatch»](#contractxlsxtracktransferpatch) 
```ts
interface ContractXlsxTrackTransferPatch {
  activeSheetPath: string;
  axis: ContractXlsxTrackTransferAxis;
  sourceStart: number;
  sourceEnd: number;
  targetStart: number;
  mode: ContractXlsxTrackTransferMode;
}
```
 ### ContractXlsxWorkbookProtectionPatch [Заголовок раздела «ContractXlsxWorkbookProtectionPatch»](#contractxlsxworkbookprotectionpatch) 
```ts
interface ContractXlsxWorkbookProtectionPatch {
  lockStructure?: boolean | null;
  lockWindows?: boolean | null;
  workbookPassword?: string | null;
  workbookAlgorithmName?: string | null;
  workbookHashValue?: string | null;
  workbookSaltValue?: string | null;
  workbookSpinCount?: number | string | null;
}
```
 ### OpcSignatureInventory [Заголовок раздела «OpcSignatureInventory»](#opcsignatureinventory) 
```ts
interface OpcSignatureInventory {
  schemaVersion: 1;
  signed: boolean;
  states: SignatureTrustState[];
  originCount: number;
  signatureCount: number;
  signedPartCount: number;
  signedRelationshipCount: number;
  validDigestCount: number;
  invalidDigestCount: number;
  unsupportedDigestCount: number;
  malformed: boolean;
  errorCode?: string;
  trustProviderChecked: false;
  sourceBytesUnchanged: boolean;
  signatures: OpcSignatureRecord[];
}
```
 ### OpcSignatureRecord [Заголовок раздела «OpcSignatureRecord»](#opcsignaturerecord) 
```ts
interface OpcSignatureRecord {
  signatureId: string;
  originId: string;
  partName: string;
  states: SignatureTrustState[];
  algorithms: SignatureAlgorithmRecord[];
  references: SignedReferenceRecord[];
  certificates: SignatureCertificateMetadata[];
  signatureValueVerified: false;
  certificateChainValidated: false;
  xadesOpaque: boolean;
  opaquePreserved: boolean;
}
```
 ### SignatureAlgorithmKind [Заголовок раздела «SignatureAlgorithmKind»](#signaturealgorithmkind) 
```ts
type SignatureAlgorithmKind = "digest" | "signature" | "canonicalization" | "transform";
```
 ### SignatureAlgorithmRecord [Заголовок раздела «SignatureAlgorithmRecord»](#signaturealgorithmrecord) 
```ts
interface SignatureAlgorithmRecord {
  kind: SignatureAlgorithmKind;
  uri: string;
  support: SignatureAlgorithmSupport;
}
```
 ### SignatureAlgorithmSupport [Заголовок раздела «SignatureAlgorithmSupport»](#signaturealgorithmsupport) 
```ts
type SignatureAlgorithmSupport = "supported" | "recognized-unverified" | "unsupported";
```
 ### SignatureCertificateMetadata [Заголовок раздела «SignatureCertificateMetadata»](#signaturecertificatemetadata) 
```ts
interface SignatureCertificateMetadata {
  fingerprintSha256: string;
  serialHex: string;
  subject: string;
  issuer: string;
  notBeforeUtc: string;
  notAfterUtc: string;
  expired: boolean;
  selfSigned: boolean;
  chainValidated: false;
}
```
 ### SignatureDigestState [Заголовок раздела «SignatureDigestState»](#signaturedigeststate) 
```ts
type SignatureDigestState = "valid" | "invalid" | "unsupported" | "not-checked";
```
 ### SignatureTargetKind [Заголовок раздела «SignatureTargetKind»](#signaturetargetkind) 
```ts
type SignatureTargetKind = | "part" | "relationship-set" | "same-document-object" | "external" | "malformed";
```
 ### SignatureTrustState [Заголовок раздела «SignatureTrustState»](#signaturetruststate) 
```ts
type SignatureTrustState =
  | "unsigned"
  | "trusted"
  | "untrusted"
  | "expired"
  | "invalid"
  | "modified"
  | "unsupported"
  | "malformed";
```
 ### SignedReferenceRecord [Заголовок раздела «SignedReferenceRecord»](#signedreferencerecord) 
```ts
interface SignedReferenceRecord {
  targetId: string;
  target: string;
  targetKind: SignatureTargetKind;
  digestMethod: string;
  digestState: SignatureDigestState;
  transformCount: number;
}
```

# Типы: сеанс, книга и листы

> Определения типов Compute Contract — подмножество книги, ревизии, viewport, свойства и совместимость. Имён: 119.

Определения имён из колонки «Тип TypeScript» на страницах операций. Другие темы словаря: **сеанс, книга и листы** · [ячейки и диапазоны](/reference/f1/types-cells/) · [формулы и вычисления](/reference/f1/types-formulas/) · [форматирование](/reference/f1/types-format/) · [данные и объекты листа](/reference/f1/types-data/) · [сводные таблицы](/reference/f1/types-pivot/) · [диаграммы и графика](/reference/f1/types-charts/) · [печать и разметка страницы](/reference/f1/types-print/) · [Power Query](/reference/f1/types-powerquery/) · [VBA и макросы](/reference/f1/types-vba/) · [защита и рецензирование](/reference/f1/types-protection/) · [общие и служебные](/reference/f1/types-common/). ### CompatibilityCategory [Заголовок раздела «CompatibilityCategory»](#compatibilitycategory) 
```ts
type CompatibilityCategory =
  | "workbook_structure"
  | "formulas_calculation"
  | "formatting_layout"
  | "objects_media"
  | "data_connections"
  | "metadata_package";
```
 ### CompatibilityFinding [Заголовок раздела «CompatibilityFinding»](#compatibilityfinding) 
```ts
interface CompatibilityFinding {
  stableId: string;
  target: CompatibilityTarget;
  severity: CompatibilitySeverity;
  category: CompatibilityCategory;
  reasonCode: string;
  count: number;
  location: CompatibilityLocation;
}
```
 ### CompatibilityFindingGroup [Заголовок раздела «CompatibilityFindingGroup»](#compatibilityfindinggroup) 
```ts
interface CompatibilityFindingGroup {
  severity: CompatibilitySeverity;
  category: CompatibilityCategory;
  findingCount: number;
}
```
 ### CompatibilityInventoryReport [Заголовок раздела «CompatibilityInventoryReport»](#compatibilityinventoryreport) 
```ts
interface CompatibilityInventoryReport {
  schemaVersion: number;
  status: "scanned" | "blocked";
  reasonCode: string;
  sourceFormat: string;
  selectedTarget: CompatibilityTarget;
  availableTargets: CompatibilityTarget[];
  totalFindingCount: number;
  returnedFindingCount: number;
  truncated: boolean;
  signedPackage: boolean;
  readOnly: boolean;
  copyAllowed: boolean;
  reportFingerprint: string;
  findings: CompatibilityFinding[];
  groups: CompatibilityFindingGroup[];
  redactedReport: CompatibilityRedactedReport;
}
```
 ### CompatibilityLocation [Заголовок раздела «CompatibilityLocation»](#compatibilitylocation) 
```ts
type CompatibilityLocation =
  | { kind: "package" }
  | { kind: "sheet"; sheetKey: string; sheetName: string }
  | { kind: "cell"; sheetKey: string; sheetName: string; cellRef: string; row: number; col: number; }
  | { kind: "object"; sheetKey: string; sheetName: string; stableId: string; label: string; };
```
 ### CompatibilityRedactedReport [Заголовок раздела «CompatibilityRedactedReport»](#compatibilityredactedreport) 
```ts
interface CompatibilityRedactedReport {
  schemaVersion: number;
  target: CompatibilityTarget;
  reportFingerprint: string;
  totalFindingCount: number;
  returnedFindingCount: number;
  truncated: boolean;
  reasonCodes: string[];
  stableFindingIds: string[];
  groups: CompatibilityFindingGroup[];
}
```
 ### CompatibilitySeverity [Заголовок раздела «CompatibilitySeverity»](#compatibilityseverity) 
```ts
type CompatibilitySeverity = "error" | "warning" | "info";
```
 ### CompatibilityTarget [Заголовок раздела «CompatibilityTarget»](#compatibilitytarget) 
```ts
type CompatibilityTarget = "xlsx" | "xls" | "csv" | "ods";
```
 ### ContractActiveSheetMeta [Заголовок раздела «ContractActiveSheetMeta»](#contractactivesheetmeta) 
```ts
interface ContractActiveSheetMeta {
  index: number;
  name: string;
  path: string;


  autoFilterRef?: string;
}
```
 ### ContractCapabilityLevel [Заголовок раздела «ContractCapabilityLevel»](#contractcapabilitylevel) 
```ts
type ContractCapabilityLevel = (typeof CONTRACT_CAPABILITY_LEVEL_IDS)[number];
```
 ### ContractContainerFamily [Заголовок раздела «ContractContainerFamily»](#contractcontainerfamily) 
```ts
type ContractContainerFamily = (typeof CONTRACT_CONTAINER_FAMILY_IDS)[number];
```
 ### ContractCurrentSubsetSaveRoute [Заголовок раздела «ContractCurrentSubsetSaveRoute»](#contractcurrentsubsetsaveroute) 
```ts
type ContractCurrentSubsetSaveRoute = (typeof CONTRACT_CURRENT_SUBSET_SAVE_ROUTE_IDS)[number];
```
 ### ContractCustomViewSheetSnapshot [Заголовок раздела «ContractCustomViewSheetSnapshot»](#contractcustomviewsheetsnapshot) 
```ts
interface ContractCustomViewSheetSnapshot {
  sheetKey: string;
  hiddenRows: number[];
  hiddenColumns: number[];
  filters: ContractCustomViewFilterSnapshot[];
  outline: ContractCustomViewOutlineTrack[];
  workbookViewMode?: "normal" | "page-layout" | "page-break-preview";
  gridLinesVisible?: boolean;
  headingsVisible?: boolean;
  printOptionsXml?: string;
  pageMarginsXml?: string;
  pageSetupXml?: string;
  rowBreaksXml?: string;
  columnBreaksXml?: string;
  headerFooterXml?: string;
}
```
 ### ContractCustomViewWindowSnapshot [Заголовок раздела «ContractCustomViewWindowSnapshot»](#contractcustomviewwindowsnapshot) 
```ts
interface ContractCustomViewWindowSnapshot {
  activeSheetKey: string;
  activeCell: string;
  selection: string;
  scrollTopLeftCell: string;
  zoomScale: number;
  paneMode: "none" | "frozen" | "split";
  freezePane?: ContractFreezePaneSubset;
}
```
 ### ContractDirectionPlaceholderSubset [Заголовок раздела «ContractDirectionPlaceholderSubset»](#contractdirectionplaceholdersubset) 
```ts
interface ContractDirectionPlaceholderSubset {
  kind: ContractDirectionPlaceholderKind;
  workbookDirection: ContractSessionDirection;
  activeSheetDirection: ContractSessionDirection;
  writingMode: ContractWritingModePlaceholder;
}
```
 ### ContractDocumentPropertiesCapability [Заголовок раздела «ContractDocumentPropertiesCapability»](#contractdocumentpropertiescapability) 
```ts
type ContractDocumentPropertiesCapability = "edit_live" | "save_copy_only" | "blocked";
```
 ### ContractExternalWorkbookReferenceTrustMetadata [Заголовок раздела «ContractExternalWorkbookReferenceTrustMetadata»](#contractexternalworkbookreferencetrustmetadata) 
```ts
interface ContractExternalWorkbookReferenceTrustMetadata {
  label: string;
  externalWorkbookIdentity: string;
  sheetName?: string | null;
  referenceText: string;
  shape: string;
  resolutionState: string;
}
```
 ### ContractFillAcrossSheetsMode [Заголовок раздела «ContractFillAcrossSheetsMode»](#contractfillacrosssheetsmode) 
```ts
type ContractFillAcrossSheetsMode = "all" | "contents" | "formats";
```
 ### ContractForecastSheetPlan [Заголовок раздела «ContractForecastSheetPlan»](#contractforecastsheetplan) 
```ts
interface ContractForecastSheetPlan {
  generation: number;
  sourcePointCount: number;
  normalizedPointCount: number;
  forecastPointCount: number;
  missingPointCount: number;
  duplicatePointCount: number;
  step: number;
  forecastEnd: number;
  seasonality: number;
  confidenceLevel: number;
  dateSystem: string;
  outputSheetName: string;
  tableStableId: string;
  chartStableId: string;
  chartType: "line" | "column";
  previewTruncated: boolean;
  rows: ContractForecastSheetPreviewRow[];
  warnings: string[];
}
```
 ### ContractForecastSheetPreviewRow [Заголовок раздела «ContractForecastSheetPreviewRow»](#contractforecastsheetpreviewrow) 
```ts
interface ContractForecastSheetPreviewRow {
  timeline: number;
  actual?: number | null;
  forecast?: number | null;
  lowerConfidenceBound?: number | null;
  upperConfidenceBound?: number | null;
}
```
 ### ContractFreezePaneSubset [Заголовок раздела «ContractFreezePaneSubset»](#contractfreezepanesubset) 
```ts
interface ContractFreezePaneSubset {
  topLeftCell?: string;
  xSplit?: number;
  ySplit?: number;
}
```
 ### ContractGeometrySubset [Заголовок раздела «ContractGeometrySubset»](#contractgeometrysubset) 
```ts
interface ContractGeometrySubset {
  usedRange: string;
  usedRangeProvenance?:
    | "worksheet-dimension"
    | "indexed-cell-extent"
    | "delimited-record-index"
    | "parsed-cell-extent"
    | "session-recalculation";


  usedRangeFinality?: "provisional" | "final";
  maxRow: number;
  maxCol: number;
  presentCellCount: number;
}
```
 ### ContractLayoutMetricsSubset [Заголовок раздела «ContractLayoutMetricsSubset»](#contractlayoutmetricssubset) 
```ts
interface ContractLayoutMetricsSubset {
  rowHeights: ContractRowHeight[];
  columnWidths: ContractColumnWidth[];
  defaultColumnWidth?: number | null;
  hiddenRows?: number[];
  manualHiddenRows?: number[];
  filterHiddenRows?: number[];
  hiddenColumns?: number[];
  merges?: string[];
  freezePane?: ContractFreezePaneSubset;
  gridLinesVisible?: boolean | null;


  showFormulas?: boolean | null;
  headingsVisible?: boolean | null;
  workbookViewMode?: "normal" | "page-layout" | "page-break-preview" | null;
  scrollTopLeftCell?: string | null;
  zoomScale?: number | null;
  activeCell?: string | null;
  selection?: string | null;
  selectionPane?: "topLeft" | "topRight" | "bottomLeft" | "bottomRight" | null;
  sheetViews?: ContractWorkbookNamedView[] | null;
  sheetViewActiveId?: string | null;
  customViews?: ContractWorkbookNamedView[] | null;
  customViewActiveId?: string | null;
}
```
 ### ContractObjectStatusPlaceholderSubset [Заголовок раздела «ContractObjectStatusPlaceholderSubset»](#contractobjectstatusplaceholdersubset) 
```ts
interface ContractObjectStatusPlaceholderSubset {
  scope: ContractObjectPlaceholderScope;
  families: ContractObjectFamilyStatusPlaceholder[];
}
```
 ### ContractSaveCapability [Заголовок раздела «ContractSaveCapability»](#contractsavecapability) 
```ts
type ContractSaveCapability = (typeof CONTRACT_SAVE_CAPABILITY_IDS)[number];
```
 ### ContractSessionDirection [Заголовок раздела «ContractSessionDirection»](#contractsessiondirection) 
```ts
type ContractSessionDirection = "ltr";
```
 ### ContractSheetBackgroundProjection [Заголовок раздела «ContractSheetBackgroundProjection»](#contractsheetbackgroundprojection) 
```ts
interface ContractSheetBackgroundProjection {
  mimeType: "image/png" | "image/jpeg" | "image/gif";
  dataUrl: string;
}
```
 ### ContractSheetKind [Заголовок раздела «ContractSheetKind»](#contractsheetkind) 
```ts
type ContractSheetKind = "worksheet" | "chartSheet";
```
 ### ContractSheetObject [Заголовок раздела «ContractSheetObject»](#contractsheetobject) 
```ts
interface ContractSheetObject {
  id: string;


  stableId?: string;
  name?: string | null;
  altText?: string | null;
  title?: string | null;
  description?: string | null;
  decorative?: boolean;
  family: ContractSheetObjectFamily;
  status: ContractSheetObjectStatus;
  preservedSupportFamily?: ContractSheetObjectPreservedSupportFamily | null;
  renderMode?: string | null;
  bounds?: ContractSheetObjectBounds;
  anchor: ContractObjectAnchor;
  relTarget?: string | null;
  targetMode?: string | null;
  payloadRef: string;
  zOrder: number;
  readingOrder?: number;


  visible?: boolean;
  locked?: boolean;
  printObject?: boolean;
  locksWithSheet?: boolean;
  groupId?: string | null;
  parentGroupId?: string | null;
  groupDepth?: number;
  rotationDeg?: number | null;
  imageFlipH?: boolean;
  imageFlipV?: boolean;
  aspectLocked?: boolean;
  imageCrop?: ContractDrawingObjectImageCrop | null;
  imagePayload?: ContractImagePayload | null;


  graphicKind?: "svg" | null;
  linkedPicturePayload?: ContractLinkedPicturePayload | null;
  chartPayload?: ContractChartPayload | null;
  legacyNotePayload?: ContractLegacyNotePayload | null;
  threadedCommentPayload?: ContractThreadedCommentPayload | null;
  textPayload?: ContractTextPayload | null;
  smartArtPayload?: ContractSmartArtPayload | null;
  wordArtPayload?: ContractWordArtPayload | null;
  groupMembers?: ContractSheetObject[] | null;


  presetGeometry?: string | null;
  shapePayload?: {
    prst: string;
    fill?: string | null;


    fillThemeSlot?: number | null;
    fillThemeLumMod?: number | null;
    fillThemeLumOff?: number | null;
    fillThemeTint?: number | null;
    fillThemeShade?: number | null;
    stroke?: string | null;
    strokeThemeSlot?: number | null;
    strokeThemeLumMod?: number | null;
    strokeThemeLumOff?: number | null;
    strokeThemeTint?: number | null;
    strokeThemeShade?: number | null;
    adjust?: number | null;


    sourceId?: string | number | null;
    sourceAnchor?: string | null;
    targetId?: string | number | null;
    targetAnchor?: string | null;
    flipH?: boolean;
    flipV?: boolean;
    routePoints?: number[] | null;
    lineKind?: "line" | "arrow" | "doubleArrow";
    lineWidthEmu?: number | null;


    rawAnchorXml?: string | null;
    adjustments?: ReadonlyArray<{ name: string; val: number }> | null;
    strokeDash?: string | null;
    isManagedShape?: boolean;
    originalNvId?: number | null;


    freeformPoints?: ReadonlyArray<{
      x: number;
      y: number;
      c1x?: number | null;
      c1y?: number | null;
      c2x?: number | null;
      c2y?: number | null;
    }> | null;
    isClosed?: boolean | null;


    fillOpacity?: number | null;
    strokeWidth?: number | null;
    strokeOpacity?: number | null;
    strokeCap?: string | null;
    strokeJoin?: string | null;
    shadowColor?: string | null;
    shadowBlur?: number | null;
    shadowAngle?: number | null;
    shadowDist?: number | null;
    shadowOpacity?: number | null;
    glowColor?: string | null;
    glowSize?: number | null;
    glowOpacity?: number | null;
    softEdges?: number | null;
    reflectionOpacity?: number | null;
    reflectionBlur?: number | null;
    reflectionDistance?: number | null;
    reflectionSize?: number | null;
    bevelTopPreset?: string | null;
    bevelTopWidth?: number | null;
    bevelTopHeight?: number | null;
    bevelBottomPreset?: string | null;
    bevelBottomWidth?: number | null;
    bevelBottomHeight?: number | null;
    depthColor?: string | null;
    depth?: number | null;
    contourColor?: string | null;
    contourWidth?: number | null;
    material?: string | null;
    lightingRig?: string | null;
    lightingAngle?: number | null;
    cameraPreset?: string | null;
    rotationX?: number | null;
    rotationY?: number | null;
    rotationZ?: number | null;
    perspective?: number | null;
    gradientFill?: boolean | null;
    gradientAngle?: number | null;
    gradientColor1?: string | null;
    gradientColor2?: string | null;
    arrowBeginType?: string | null;
    arrowBeginSize?: string | null;
    arrowBeginLength?: string | null;
    arrowBeginWidth?: string | null;
    arrowEndType?: string | null;
    arrowEndSize?: string | null;
    arrowEndLength?: string | null;
    arrowEndWidth?: string | null;
    strokeCompound?: string | null;
    headEnd?: string | null;
    tailEnd?: string | null;
  } | null;
}
```
 ### ContractSheetObjectBounds [Заголовок раздела «ContractSheetObjectBounds»](#contractsheetobjectbounds) 
```ts
interface ContractSheetObjectBounds {
  x: number;
  y: number;
  width: number;
  height: number;
}
```
 ### ContractSheetObjectFamily [Заголовок раздела «ContractSheetObjectFamily»](#contractsheetobjectfamily) 
```ts
type ContractSheetObjectFamily = "chart" | "image" | "shape" | "media" | "comments-notes";
```
 ### ContractSheetObjectMutationAction [Заголовок раздела «ContractSheetObjectMutationAction»](#contractsheetobjectmutationaction) 
```ts
type ContractSheetObjectMutationAction = "create" | "edit" | "move" | "resize" | "delete";
```
 ### ContractSheetObjectMutationIntent [Заголовок раздела «ContractSheetObjectMutationIntent»](#contractsheetobjectmutationintent) 
```ts
interface ContractSheetObjectMutationIntent {
  sheetId: string;
  action: ContractSheetObjectMutationAction;
  stableId?: string | null;
}
```
 ### ContractSheetObjectPreservedSupportFamily [Заголовок раздела «ContractSheetObjectPreservedSupportFamily»](#contractsheetobjectpreservedsupportfamily) 
```ts
type ContractSheetObjectPreservedSupportFamily =
  | "smart-art"
  | "ink"
  | "embedded-ole"
  | "embedded-package"
  | "media-placeholder"
  | "control-placeholder"
  | "active-x-control"
  | "form-control"
  | "audio"
  | "video"
  | "unknown";
```
 ### ContractSheetObjectStatus [Заголовок раздела «ContractSheetObjectStatus»](#contractsheetobjectstatus) 
```ts
type ContractSheetObjectStatus = | "cataloged" | "placeholder" | "broken-rel" | "external-target" | "unsupported";
```
 ### ContractSheetVisibilityState [Заголовок раздела «ContractSheetVisibilityState»](#contractsheetvisibilitystate) 
```ts
type ContractSheetVisibilityState = "visible" | "hidden" | "veryHidden";
```
 ### ContractSourceTrustSessionBinding [Заголовок раздела «ContractSourceTrustSessionBinding»](#contractsourcetrustsessionbinding) 
```ts
interface ContractSourceTrustSessionBinding {
  sourceIdentity: string;
  authority: Exclude<ContractSourceTrustAuthority, "none" | "editing_session">;
}
```
 ### ContractSubsetSessionInfo [Заголовок раздела «ContractSubsetSessionInfo»](#contractsubsetsessioninfo) 
```ts
interface ContractSubsetSessionInfo {
  mode: SubsetSessionMode;
  reusableWithinProcess: boolean;
  reusableAcrossProcessLaunches: boolean;
  note: string;
}
```
 ### ContractViewportReadiness [Заголовок раздела «ContractViewportReadiness»](#contractviewportreadiness) 
```ts
interface ContractViewportReadiness {
  schemaVersion: 1;
  state: ContractViewportReadinessState;
  subsetId: string;
  generation: number;
  terminal: boolean;
  retryOnTransition: boolean;
  projectionPublished: boolean;
  detail: string;
}
```
 ### ContractViewportReadinessState [Заголовок раздела «ContractViewportReadinessState»](#contractviewportreadinessstate) 
```ts
type ContractViewportReadinessState = "ready" | "deferred" | "cancelled" | "superseded" | "failed";
```
 ### ContractWorkbookAccessibilityIntent [Заголовок раздела «ContractWorkbookAccessibilityIntent»](#contractworkbookaccessibilityintent) 
```ts
type ContractWorkbookAccessibilityIntent =
  | { action: "scan" }
  | { action: "apply";
    issueId: string;
    remediation: ContractWorkbookAccessibilityRemediationKind;
    value?: string;
  }
  | { action: "fix_all" }
  | { action: "undo" }
  | { action: "redo" };
```
 ### ContractWorkbookAccessibilityIssue [Заголовок раздела «ContractWorkbookAccessibilityIssue»](#contractworkbookaccessibilityissue) 
```ts
interface ContractWorkbookAccessibilityIssue {
  stableId: string;
  kind: ContractWorkbookAccessibilityIssueKind;
  severity: ContractWorkbookAccessibilitySeverity;
  location: ContractWorkbookAccessibilityLocation;
  explanationCode: string;
  navigationTarget: ContractWorkbookAccessibilityNavigationTarget;
  observedRevision: number;
  remediations?: ContractWorkbookAccessibilityRemediation[];
}
```
 ### ContractWorkbookAccessibilityIssueKind [Заголовок раздела «ContractWorkbookAccessibilityIssueKind»](#contractworkbookaccessibilityissuekind) 
```ts
type ContractWorkbookAccessibilityIssueKind =
  | "missing-object-alt-text"
  | "weak-object-alt-text"
  | "decorative-object"
  | "decorative-metadata-conflict"
  | "low-text-fill-contrast"
  | "merged-cell-hazard"
  | "blank-table-header"
  | "duplicate-table-header"
  | "ambiguous-hyperlink-text"
  | "hidden-sheet-with-content"
  | "empty-sheet-name"
  | "inaccessible-comment-authorship"
  | "inaccessible-note-authorship"
  | "chart-title-gap"
  | "chart-description-gap"
  | "non-text-content";
```
 ### ContractWorkbookAccessibilityLocation [Заголовок раздела «ContractWorkbookAccessibilityLocation»](#contractworkbookaccessibilitylocation) 
```ts
interface ContractWorkbookAccessibilityLocation {
  sheetId: string;
  sheetName: string;
  label: string;
  cellRef?: string;
  objectStableId?: string;
  tableName?: string;
}
```
 ### ContractWorkbookAccessibilityNavigationTarget [Заголовок раздела «ContractWorkbookAccessibilityNavigationTarget»](#contractworkbookaccessibilitynavigationtarget) 
```ts
type ContractWorkbookAccessibilityNavigationTarget =
  | { kind: "cell"; sheetId: string; row: number; col: number; cellRef: string }
  | { kind: "object"; sheetId: string; stableId: string }
  | { kind: "sheet"; sheetId: string }
  | { kind: "table-header"; sheetId: string; tableName: string; columnIndex: number; cellRef: string; };
```
 ### ContractWorkbookAccessibilityPackageFix [Заголовок раздела «ContractWorkbookAccessibilityPackageFix»](#contractworkbookaccessibilitypackagefix) 
```ts
type ContractWorkbookAccessibilityPackageFix =
  | { action: "set-object-accessibility";
    sheetId: string;
    stableId: string;
    title?: string;
    description?: string;
    decorative: boolean;
  }
  | { action: "set-chart-title"; sheetId: string; stableId: string; chartPath: string; title: string; }
  | { action: "set-table-header"; sheetId: string; tableName: string; columnIndex: number; value: string; }
  | { action: "set-hyperlink-text"; sheetId: string; row: number; col: number; value: string; }
  | { action: "set-sheet-state"; sheetId: string; name?: string; visibility?: ContractSheetVisibilityState; };
```
 ### ContractWorkbookAccessibilityRemediation [Заголовок раздела «ContractWorkbookAccessibilityRemediation»](#contractworkbookaccessibilityremediation) 
```ts
interface ContractWorkbookAccessibilityRemediation {
  kind: ContractWorkbookAccessibilityRemediationKind;
  requiresValue: boolean;
  defaultValue?: string;
  fixAllEligible: boolean;
}
```
 ### ContractWorkbookAccessibilityRemediationKind [Заголовок раздела «ContractWorkbookAccessibilityRemediationKind»](#contractworkbookaccessibilityremediationkind) 
```ts
type ContractWorkbookAccessibilityRemediationKind =
  | "set-object-alt-text"
  | "mark-object-decorative"
  | "repair-table-header"
  | "add-chart-title"
  | "add-chart-description"
  | "rename-hyperlink-text"
  | "rename-sheet"
  | "unhide-sheet";
```
 ### ContractWorkbookAccessibilityResult [Заголовок раздела «ContractWorkbookAccessibilityResult»](#contractworkbookaccessibilityresult) 
```ts
interface ContractWorkbookAccessibilityResult {
  requestId: string;
  generation: number;
  revision: number;
  status: ContractWorkbookAccessibilityStatus;
  reason?: string;
  totalIssueCount: number;
  returnedIssueCount: number;
  truncated: boolean;
  undoDepth: number;
  redoDepth: number;
  issues: ContractWorkbookAccessibilityIssue[];
  approvedPackageFixes?: ContractWorkbookAccessibilityPackageFix[];
}
```
 ### ContractWorkbookAccessibilitySeverity [Заголовок раздела «ContractWorkbookAccessibilitySeverity»](#contractworkbookaccessibilityseverity) 
```ts
type ContractWorkbookAccessibilitySeverity = "error" | "warning" | "info";
```
 ### ContractWorkbookAccessibilityStatus [Заголовок раздела «ContractWorkbookAccessibilityStatus»](#contractworkbookaccessibilitystatus) 
```ts
type ContractWorkbookAccessibilityStatus = "scanned" | "mutated" | "undone" | "redone" | "blocked";
```
 ### ContractWorkbookCalculationMode [Заголовок раздела «ContractWorkbookCalculationMode»](#contractworkbookcalculationmode) 
```ts
type ContractWorkbookCalculationMode = "automatic" | "automatic_except_data_tables" | "manual" | "unknown";
```
 ### ContractWorkbookConnectionDestination [Заголовок раздела «ContractWorkbookConnectionDestination»](#contractworkbookconnectiondestination) 
```ts
type ContractWorkbookConnectionDestination =
  | { mode: "connection_only" }
  | { mode: "existing_sheet"; sheetName: string; anchor: string }
  | { mode: "new_sheet"; sheetName: string };
```
 ### ContractWorkbookConnectionEntry [Заголовок раздела «ContractWorkbookConnectionEntry»](#contractworkbookconnectionentry) 
```ts
interface ContractWorkbookConnectionEntry {
  identity: string;
  id: string;
  ownerQueryIdentity?: string | null;
  name?: string | null;
  description?: string | null;
  connectionTypeCode?: string | null;
  refreshedVersion?: string | null;
  backgroundRefresh?: boolean | null;
  saveData?: boolean | null;
  provider?: string | null;
  queryLocation?: string | null;
  command?: string | null;
  connectionStringWhollyRedacted: boolean;


  sourceKind: string;
  loadDestination: string;
  refreshState: string;
  packageOwner: string;
  packageParts: string[];
  legacyReadOnly: boolean;
}
```
 ### ContractWorkbookConnectionLoadLink [Заголовок раздела «ContractWorkbookConnectionLoadLink»](#contractworkbookconnectionloadlink) 
```ts
interface ContractWorkbookConnectionLoadLink {
  identity: string;
  connectionId: string;
  queryIdentity?: string | null;
  connectionName?: string | null;
  queryLocation?: string | null;
  queryTableName?: string | null;
  queryTablePart?: string | null;
}
```
 ### ContractWorkbookConnectionsProjection [Заголовок раздела «ContractWorkbookConnectionsProjection»](#contractworkbookconnectionsprojection) 
```ts
interface ContractWorkbookConnectionsProjection {
  scope: string;
  source: string;
  connectionCount: number;
  connections: ContractWorkbookConnectionEntry[];
  loadLinks: ContractWorkbookConnectionLoadLink[];
  note: string;
}
```
 ### ContractWorkbookHistoryActiveSheetProjection [Заголовок раздела «ContractWorkbookHistoryActiveSheetProjection»](#contractworkbookhistoryactivesheetprojection) 
```ts
interface ContractWorkbookHistoryActiveSheetProjection {
  activeSheet: ContractActiveSheetMeta;
  workbookSheets: ContractWorkbookSheetMeta[];
  geometry: ContractGeometrySubset;
  viewport: ViewportWindow;
  previewCells: ContractPreviewCell[];
  layoutMetrics?: ContractLayoutMetricsSubset;
}
```
 ### ContractWorkbookHistoryDirection [Заголовок раздела «ContractWorkbookHistoryDirection»](#contractworkbookhistorydirection) 
```ts
type ContractWorkbookHistoryDirection = "undo" | "redo";
```
 ### ContractWorkbookHistoryOwner [Заголовок раздела «ContractWorkbookHistoryOwner»](#contractworkbookhistoryowner) 
```ts
type ContractWorkbookHistoryOwner =
  | "cell"
  | "range"
  | "revision_merge"
  | "defined_names"
  | "sheet_lifecycle"
  | "review_annotations"
  | "table_lifecycle"
  | "drawing_objects"
  | "sparklines"
  | "scenarios"
  | "custom_views"
  | "theme_colors"
  | "fill_across_sheets"
  | "calculation_properties";
```
 ### ContractWorkbookHistoryProjection [Заголовок раздела «ContractWorkbookHistoryProjection»](#contractworkbookhistoryprojection) 
```ts
interface ContractWorkbookHistoryProjection {
  owner?: ContractWorkbookHistoryOwner | null;
  undoDepth: number;
  redoDepth: number;


  revision: number;
}
```
 ### ContractWorkbookLinkCachedValueTruth [Заголовок раздела «ContractWorkbookLinkCachedValueTruth»](#contractworkbooklinkcachedvaluetruth) 
```ts
type ContractWorkbookLinkCachedValueTruth = "imported_cache" | "refreshed" | "frozen_value" | "unavailable";
```
 ### ContractWorkbookLinkInventoryEntry [Заголовок раздела «ContractWorkbookLinkInventoryEntry»](#contractworkbooklinkinventoryentry) 
```ts
interface ContractWorkbookLinkInventoryEntry {
  id: string;
  displayName: string;
  sourceKind: ContractWorkbookLinkSourceKind;
  state: ContractWorkbookLinkState;
  cachedValueTruth: ContractWorkbookLinkCachedValueTruth;
  formulaCellCount: number;
  definedNameCount: number;
  cachedCellCount: number;
  structuredTables: ContractWorkbookLinkStructuredTable[];
  sourceRevision?: string;
  canUpdate: boolean;
  canChangeSource: boolean;
  canOpenSource: boolean;
  canBreakLink: boolean;
}
```
 ### ContractWorkbookLinkSourceKind [Заголовок раздела «ContractWorkbookLinkSourceKind»](#contractworkbooklinksourcekind) 
```ts
type ContractWorkbookLinkSourceKind = "local" | "network" | "cloud" | "unknown";
```
 ### ContractWorkbookLinkState [Заголовок раздела «ContractWorkbookLinkState»](#contractworkbooklinkstate) 
```ts
type ContractWorkbookLinkState = | "cached" | "trusted" | "current" | "missing" | "moved" | "corrupt" | "blocked" | "broken";
```
 ### ContractWorkbookLinkStructuredTable [Заголовок раздела «ContractWorkbookLinkStructuredTable»](#contractworkbooklinkstructuredtable) 
```ts
interface ContractWorkbookLinkStructuredTable {
  workbookIdentity: string;
  sheetName: string;
  tableName: string;
  columnNames: string[];
  totalsRowPresent: boolean;
}
```
 ### ContractWorkbookLinksIntent [Заголовок раздела «ContractWorkbookLinksIntent»](#contractworkbooklinksintent) 
```ts
type ContractWorkbookLinksIntent =
  | { action: "list" }
  | { action: "startup_decision"; trustLocalSources: boolean; expectedRevision: number; }
  | { action: "update_values"; linkIds?: string[]; expectedRevision: number }
  | { action: "change_source"; linkId: string; sourceUri: string; expectedRevision: number; }
  | { action: "open_source"; linkId: string; expectedRevision: number }
  | { action: "break_link"; linkIds?: string[]; expectedRevision: number }
  | { action: "undo"; expectedRevision: number }
  | { action: "redo"; expectedRevision: number };
```
 ### ContractWorkbookLinksResult [Заголовок раздела «ContractWorkbookLinksResult»](#contractworkbooklinksresult) 
```ts
interface ContractWorkbookLinksResult {
  status: ContractWorkbookLinksStatus;
  revision: number;
  links: ContractWorkbookLinkInventoryEntry[];
  transactionId?: string;
  openSourceUri?: string;
  reason?: string;
}
```
 ### ContractWorkbookLinksStatus [Заголовок раздела «ContractWorkbookLinksStatus»](#contractworkbooklinksstatus) 
```ts
type ContractWorkbookLinksStatus =
  | "listed"
  | "trust_applied"
  | "updated"
  | "source_changed"
  | "source_opened"
  | "links_broken"
  | "undone"
  | "redone"
  | "blocked";
```
 ### ContractWorkbookNamedView [Заголовок раздела «ContractWorkbookNamedView»](#contractworkbooknamedview) 
```ts
interface ContractWorkbookNamedView {
  id: string;
  name: string;
  snapshot: ContractWorkbookNamedViewSnapshot;
}
```
 ### ContractWorkbookNamedViewSnapshot [Заголовок раздела «ContractWorkbookNamedViewSnapshot»](#contractworkbooknamedviewsnapshot) 
```ts
interface ContractWorkbookNamedViewSnapshot {
  workbookViewMode?: "normal" | "page-layout" | "page-break-preview" | null;
  gridLinesVisible?: boolean | null;
  headingsVisible?: boolean | null;
  formulaBarVisible?: boolean | null;
  rulerVisible?: boolean | null;
  zoomScale?: number | null;
  windowCount?: number | null;
  windowActive?: number | null;
  windowArranged?: boolean | null;
  windowSideBySide?: boolean | null;
  windowSynchronousScrolling?: boolean | null;
}
```
 ### ContractWorkbookObjectAnchorState [Заголовок раздела «ContractWorkbookObjectAnchorState»](#contractworkbookobjectanchorstate) 
```ts
type ContractWorkbookObjectAnchorState = "resolved" | "unavailable" | "broken";
```
 ### ContractWorkbookObjectInventoryEntry [Заголовок раздела «ContractWorkbookObjectInventoryEntry»](#contractworkbookobjectinventoryentry) 
```ts
interface ContractWorkbookObjectInventoryEntry {
  stableId: string;
  objectId: string;
  sheetIndex: number;
  sheetName: string;
  sheetPath: string;
  objectType: ContractWorkbookObjectType;
  name: string;
  title?: string | null;
  description?: string | null;


  altText?: string | null;
  decorative: boolean;
  supportState: ContractWorkbookObjectSupportState;
  presenceStatus: ContractWorkbookObjectPresenceStatus;
  targetState: ContractWorkbookObjectTargetState;
  editable: boolean;
  navigable: boolean;
  mutationCapabilities: ContractWorkbookObjectMutationCapabilities;
  anchorState: ContractWorkbookObjectAnchorState;
  anchor: ContractObjectAnchor;
  relationships: ContractWorkbookObjectRelationship[];
  zOrder: number;


  readingOrder: number;
  visible: boolean;
  locked: boolean;
  printObject: boolean;
  locksWithSheet: boolean;
  groupId?: string | null;
  parentGroupId?: string | null;
  groupDepth: number;
  cellRef?: string | null;
  formControl?: ContractFormControlView | null;
  smartArtPayload?: ContractSmartArtPayload | null;
  wordArtPayload?: ContractWordArtPayload | null;
}
```
 ### ContractWorkbookObjectMutationCapabilities [Заголовок раздела «ContractWorkbookObjectMutationCapabilities»](#contractworkbookobjectmutationcapabilities) 
```ts
interface ContractWorkbookObjectMutationCapabilities {
  moveObject: boolean;
  copyObject: boolean;
  deleteObject: boolean;
  rename: boolean;
  visibility: boolean;
  accessibility: boolean;
  print: boolean;
}
```
 ### ContractWorkbookObjectPresenceStatus [Заголовок раздела «ContractWorkbookObjectPresenceStatus»](#contractworkbookobjectpresencestatus) 
```ts
type ContractWorkbookObjectPresenceStatus = "present" | "selected" | "hidden" | "locked" | "unsupported" | "error";
```
 ### ContractWorkbookObjectRelationship [Заголовок раздела «ContractWorkbookObjectRelationship»](#contractworkbookobjectrelationship) 
```ts
interface ContractWorkbookObjectRelationship {
  id: string;
  relationshipType: string;
  ownerPart: string;
  target: string;
  targetMode?: string | null;
  targetState: ContractWorkbookObjectTargetState;
}
```
 ### ContractWorkbookObjectSupportState [Заголовок раздела «ContractWorkbookObjectSupportState»](#contractworkbookobjectsupportstate) 
```ts
type ContractWorkbookObjectSupportState = "live" | "stale" | "broken" | "unsupported";
```
 ### ContractWorkbookObjectTargetState [Заголовок раздела «ContractWorkbookObjectTargetState»](#contractworkbookobjecttargetstate) 
```ts
type ContractWorkbookObjectTargetState = "resolved" | "broken" | "orphan" | "external" | "unsupported";
```
 ### ContractWorkbookObjectType [Заголовок раздела «ContractWorkbookObjectType»](#contractworkbookobjecttype) 
```ts
type ContractWorkbookObjectType =
  | "chart"
  | "picture"
  | "shape"
  | "text-box"
  | "connector"
  | "group"
  | "comment"
  | "note"
  | "smart-art"
  | "word-art"
  | "ink"
  | "embedded-ole"
  | "embedded-package"
  | "active-x-control"
  | "form-control"
  | "audio"
  | "video"
  | "media"
  | "control"
  | "unknown";
```
 ### ContractWorkbookReadiness [Заголовок раздела «ContractWorkbookReadiness»](#contractworkbookreadiness) 
```ts
interface ContractWorkbookReadiness {
  schemaVersion: 1;
  generation: number;
  packageOpened: ContractWorkbookReadinessPhase;
  activeSheetKnown: ContractWorkbookReadinessPhase;
  firstViewportReady: ContractWorkbookReadinessPhase;
  editingReady: ContractWorkbookReadinessPhase;
  backgroundIndexing: ContractWorkbookReadinessPhase;
  fullyIndexed: ContractWorkbookReadinessPhase;
  deferredRegionCount: number;
  deferredRecalc: boolean;
}
```
 ### ContractWorkbookReadinessPhase [Заголовок раздела «ContractWorkbookReadinessPhase»](#contractworkbookreadinessphase) 
```ts
interface ContractWorkbookReadinessPhase {
  state: ContractWorkbookReadinessPhaseState;
  terminal: boolean;
  detail: string;
}
```
 ### ContractWorkbookReadinessPhaseState [Заголовок раздела «ContractWorkbookReadinessPhaseState»](#contractworkbookreadinessphasestate) 
```ts
type ContractWorkbookReadinessPhaseState = "pending" | "running" | "ready" | "failed" | "cancelled" | "not_required";
```
 ### ContractWorkbookRevisionCellState [Заголовок раздела «ContractWorkbookRevisionCellState»](#contractworkbookrevisioncellstate) 
```ts
type ContractWorkbookRevisionCellState =
  | { kind: "absent" }
  | { kind: "blank" }
  | { kind: "empty-string" }
  | { kind: "number"; value: string }
  | { kind: "boolean"; value: boolean }
  | { kind: "text"; value: string }
  | { kind: "formula"; formula: string }
  | { kind: "error"; code: string };
```
 ### ContractWorkbookRevisionCellSummary [Заголовок раздела «ContractWorkbookRevisionCellSummary»](#contractworkbookrevisioncellsummary) 
```ts
interface ContractWorkbookRevisionCellSummary {
  kind: string;


  detail: string;
}
```
 ### ContractWorkbookRevisionConflict [Заголовок раздела «ContractWorkbookRevisionConflict»](#contractworkbookrevisionconflict) 
```ts
interface ContractWorkbookRevisionConflict {
  sheetKey: string;
  row?: number | null;
  col?: number | null;
  address: string;
  kind: ContractWorkbookRevisionConflictKind;
  base: ContractWorkbookRevisionCellSummary;
  local: ContractWorkbookRevisionCellSummary;
  incoming: ContractWorkbookRevisionCellSummary;
}
```
 ### ContractWorkbookRevisionConflictKind [Заголовок раздела «ContractWorkbookRevisionConflictKind»](#contractworkbookrevisionconflictkind) 
```ts
type ContractWorkbookRevisionConflictKind =
  | "concurrent-edit"
  | "formula-value"
  | "edit-clear"
  | "unsupported-mutation"
  | "base-mismatch"
  | "missing-sheet"
  | "local-state-mismatch";
```
 ### ContractWorkbookRevisionDelta [Заголовок раздела «ContractWorkbookRevisionDelta»](#contractworkbookrevisiondelta) 
```ts
interface ContractWorkbookRevisionDelta {
  editionId: string;
  baseRevision: number;
  revision: number;
  mutations: ContractWorkbookRevisionMutation[];
}
```
 ### ContractWorkbookRevisionMergeOutcome [Заголовок раздела «ContractWorkbookRevisionMergeOutcome»](#contractworkbookrevisionmergeoutcome) 
```ts
type ContractWorkbookRevisionMergeOutcome = "merged" | "conflicts" | "already-applied";
```
 ### ContractWorkbookRevisionMutation [Заголовок раздела «ContractWorkbookRevisionMutation»](#contractworkbookrevisionmutation) 
```ts
type ContractWorkbookRevisionMutation =
  | { mutationKind: "cell";
    sheetKey: string;
    row: number;
    col: number;
    base: ContractWorkbookRevisionCellState;
    value: ContractWorkbookRevisionCellState;
  }
  | { mutationKind: "unsupported"; sheetKey: string; row?: number
  | null; col?: number
  | null; kind: ContractWorkbookRevisionUnsupportedMutationKind; };
```
 ### ContractWorkbookRevisionUnsupportedMutationKind [Заголовок раздела «ContractWorkbookRevisionUnsupportedMutationKind»](#contractworkbookrevisionunsupportedmutationkind) 
```ts
type ContractWorkbookRevisionUnsupportedMutationKind =
  | "sheet-lifecycle"
  | "defined-name"
  | "formatting"
  | "range-structure"
  | "table"
  | "data-validation"
  | "protection"
  | "object"
  | "workbook-metadata"
  | "external-data"
  | "power-query"
  | "vba"
  | "package-publication"
  | "unknown";
```
 ### ContractWorkbookSheetMeta [Заголовок раздела «ContractWorkbookSheetMeta»](#contractworkbooksheetmeta) 
```ts
interface ContractWorkbookSheetMeta {
  index: number;
  name: string;
  path: string;


  kind?: ContractSheetKind;
  visibilityState?: ContractSheetVisibilityState;
  tabColorRgb?: string | null;
  codeName?: string | null;
  sheetProtected?: boolean | null;
  sheetProtectionAllowedActions?: ContractSheetProtectionAllowedAction[] | null;
  rightToLeft?: boolean | null;
  usedRange?: string | null;
  usedRangeDirty?: boolean | null;


  sheetBackground?: ContractSheetBackgroundProjection | null;


  nonEmptyCellCount?: number | null;


  formulaCellCount?: number | null;


  isPqOutputSheet?: boolean;
}
```
 ### ContractWorkbookThemeColorScheme [Заголовок раздела «ContractWorkbookThemeColorScheme»](#contractworkbookthemecolorscheme) 
```ts
interface ContractWorkbookThemeColorScheme {
  name: string;
  dk1: string;
  lt1: string;
  dk2: string;
  lt2: string;
  accent1: string;
  accent2: string;
  accent3: string;
  accent4: string;
  accent5: string;
  accent6: string;
  hlink: string;
  folHlink: string;
}
```
 ### ContractWorkbookThemeFontsProjection [Заголовок раздела «ContractWorkbookThemeFontsProjection»](#contractworkbookthemefontsprojection) 
```ts
interface ContractWorkbookThemeFontsProjection {
  major: string;
  minor: string;
}
```
 ### ContractWorkbookWindowCommandState [Заголовок раздела «ContractWorkbookWindowCommandState»](#contractworkbookwindowcommandstate) 
```ts
interface ContractWorkbookWindowCommandState {
  commandId: string;
  enabled: boolean;
  active: boolean;
}
```
 ### ContractWorkbookWindowSessionAction [Заголовок раздела «ContractWorkbookWindowSessionAction»](#contractworkbookwindowsessionaction) 
```ts
type ContractWorkbookWindowSessionAction =
  | { action: "register_window";
    shellWindowHandle: string;
    visible: boolean;
    focused: boolean;
    view: ContractWorkbookWindowViewState;
  }
  | { action: "state"; windowId?: string
  | null }
  | { action: "activate_window"; windowId: string; focus: string }
  | { action: "update_view"; windowId: string; view: ContractWorkbookWindowViewState; }
  | { action: "set_show_formulas"; windowId: string; enabled: boolean }
  | { action: "record_activity";
    windowId: string;
    recordHistory?: boolean;
    clipboardTransferReady?: boolean;
  }
  | { action: "set_visibility"; windowId: string; visible: boolean }
  | { action: "arrange"; windowId: string }
  | { action: "set_side_by_side"; windowId: string; enabled: boolean }
  | { action: "set_synchronous_scrolling"; windowId: string; enabled: boolean }
  | { action: "close_window"; windowId: string };
```
 ### ContractWorkbookWindowSessionIdentity [Заголовок раздела «ContractWorkbookWindowSessionIdentity»](#contractworkbookwindowsessionidentity) 
```ts
interface ContractWorkbookWindowSessionIdentity {
  workbookId: string;
  sessionId: string;
  subsetId: string;
}
```
 ### ContractWorkbookWindowSessionProjection [Заголовок раздела «ContractWorkbookWindowSessionProjection»](#contractworkbookwindowsessionprojection) 
```ts
interface ContractWorkbookWindowSessionProjection {
  identity: ContractWorkbookWindowSessionIdentity;
  activeWorkbookId: string;
  activeSessionId: string;
  currentWindowId: string;
  activeWindowId: string;
  viewCount: number;
  arranged: boolean;
  sideBySide: boolean;
  synchronousScrolling: boolean;
  dirty: boolean;
  windows: ContractWorkbookWindowViewProjection[];
  commandStates: ContractWorkbookWindowCommandState[];
}
```
 ### ContractWorkbookWindowViewProjection [Заголовок раздела «ContractWorkbookWindowViewProjection»](#contractworkbookwindowviewprojection) 
```ts
interface ContractWorkbookWindowViewProjection {
  windowId: string;
  shellWindowHandle: string;
  visible: boolean;
  focused: boolean;
  view: ContractWorkbookWindowViewState;
  historyUndoDepth: number;
  historyRedoDepth: number;
  clipboardTransferReady: boolean;
}
```
 ### ContractWorkbookWindowViewState [Заголовок раздела «ContractWorkbookWindowViewState»](#contractworkbookwindowviewstate) 
```ts
interface ContractWorkbookWindowViewState {
  activeSheetKey: string;
  activeCell: string;
  selection: string;
  focus: string;
  viewport: ViewportWindow;


  showFormulas?: boolean;
  showFormulasPersistence?: ContractFormulaAuditingStatePersistence;
}
```
 ### ContractXlsxSheetBackgroundPatch [Заголовок раздела «ContractXlsxSheetBackgroundPatch»](#contractxlsxsheetbackgroundpatch) 
```ts
interface ContractXlsxSheetBackgroundPatch {
  activeSheetPath: string;
  sheetName?: string | null;
  mimeType?: "image/png" | "image/jpeg" | "image/gif" | null;
  dataUrl?: string | null;
  fileName?: string | null;
  remove?: boolean | null;
}
```
 ### ContractXlsxSheetFormatPatch [Заголовок раздела «ContractXlsxSheetFormatPatch»](#contractxlsxsheetformatpatch) 
```ts
interface ContractXlsxSheetFormatPatch {
  activeSheetPath: string;
  defaultRowHeight?: number | null;
  defaultColWidth?: number | null;
  baseColWidth?: number | null;
  customHeight?: boolean | null;
}
```
 ### ContractXlsxTextBoxSheetPatch [Заголовок раздела «ContractXlsxTextBoxSheetPatch»](#contractxlsxtextboxsheetpatch) 
```ts
interface ContractXlsxTextBoxSheetPatch {
  activeSheetPath: string;
  objects: ContractXlsxTextBoxObjectPatch[];
}
```
 ### ContractXlsxWorkbookActiveSheetPatch [Заголовок раздела «ContractXlsxWorkbookActiveSheetPatch»](#contractxlsxworkbookactivesheetpatch) 
```ts
interface ContractXlsxWorkbookActiveSheetPatch {
  activeSheetPath: string;
}
```
 ### ContractXlsxWorkbookThemeColorsPatch [Заголовок раздела «ContractXlsxWorkbookThemeColorsPatch»](#contractxlsxworkbookthemecolorspatch) 
```ts
interface ContractXlsxWorkbookThemeColorsPatch {
  colorSetId: string;
}
```
 ### ContractXlsxWorkbookThemePatch [Заголовок раздела «ContractXlsxWorkbookThemePatch»](#contractxlsxworkbookthemepatch) 
```ts
interface ContractXlsxWorkbookThemePatch {
  presetId: string;
}
```
 ### ContractXlsxWorkbookViewSelectionPatch [Заголовок раздела «ContractXlsxWorkbookViewSelectionPatch»](#contractxlsxworkbookviewselectionpatch) 
```ts
interface ContractXlsxWorkbookViewSelectionPatch {
  activeSheetPath: string;
  activeCell: string;
  sqref: string;
  pane?: string | null;
}
```
 ### EditorSessionStamp [Заголовок раздела «EditorSessionStamp»](#editorsessionstamp) 
```ts
interface EditorSessionStamp {
  editorSessionId: string;
  generation: number;
}
```
 ### FormulaSubsetStatus [Заголовок раздела «FormulaSubsetStatus»](#formulasubsetstatus) 
```ts
type FormulaSubsetStatus = "supported" | "unsupported" | "not-formula";
```
 ### OpenWorkbookSubsetProjectionPayload [Заголовок раздела «OpenWorkbookSubsetProjectionPayload»](#openworkbooksubsetprojectionpayload) 
```ts
interface OpenWorkbookSubsetProjectionPayload {
  operation: "open_workbook_subset";
  subsetId: string;
  sheetCount: number;
  session: ContractSubsetSessionInfo;
  readiness: ContractWorkbookReadiness;
  formatCapabilities?: ContractFormatCapabilities | null;
  xlsbDirtySaveProfile?: ContractXlsbDirtySaveProfile | null;
  activeSheet: ContractActiveSheetMeta;
  workbookSheets?: ContractWorkbookSheetMeta[];
  themeFonts?: ContractWorkbookThemeFontsProjection | null;
  tableMetadata?: ContractTableMetadataProjection | null;
  workbookTableMetadata?: ContractTableMetadataProjection | null;
  workbookConnections?: ContractWorkbookConnectionsProjection | null;
  worksheetAutoFilterMetadata?: ContractWorksheetAutoFilterMetadata | null;
  directionPlaceholder?: ContractDirectionPlaceholderSubset | null;
  objectStatusPlaceholder?: ContractObjectStatusPlaceholderSubset | null;
  surfaceObjects?: ContractSheetObject[] | null;
  objectInventory?: ContractWorkbookObjectInventoryEntry[] | null;
  inkProjection?: ContractReviewInkProjectionItem[] | null;
  geometry: ContractGeometrySubset;
  recalcNeeded: boolean;
  viewport: ViewportWindow;
  previewCells: ContractPreviewCell[];
  conditionalFormattingRules?: ContractConditionalRule[];
  dataValidationMetadata?: ContractDataValidationMetadata;
  frozenBandCells?: ContractPreviewCell[];
  layoutMetrics?: ContractLayoutMetricsSubset | null;
  formulaTrustSnapshot?: ContractFormulaTrustSnapshot | null;
  themeColorPalette?: string[];


  viewportReadiness?: ContractViewportReadiness;
}
```
 ### SubsetSessionMode [Заголовок раздела «SubsetSessionMode»](#subsetsessionmode) 
```ts
type SubsetSessionMode = "transient-non-reusable" | "process-reusable" | "persistent";
```
 ### ViewportWindow [Заголовок раздела «ViewportWindow»](#viewportwindow) 
```ts
interface ViewportWindow {
  top: number;
  left: number;
  rows: number;
  cols: number;
}
```
 ### WorkbookIdentityDescriptor [Заголовок раздела «WorkbookIdentityDescriptor»](#workbookidentitydescriptor) 
```ts
type WorkbookIdentityDescriptor =
  | { kind: "sheet"; name: string }
  | { kind: "table"; name: string }
  | { kind: "named"; name: string };
```
 ### WorkbookSelectorDescriptor [Заголовок раздела «WorkbookSelectorDescriptor»](#workbookselectordescriptor) 
```ts
type WorkbookSelectorDescriptor =
  | { kind: "sheet"; name: string }
  | { kind: "table"; name: string }
  | { kind: "named-range"; name: string };
```
 ### WorkbookSourceDescriptor [Заголовок раздела «WorkbookSourceDescriptor»](#workbooksourcedescriptor) 
```ts
interface WorkbookSourceDescriptor {
  workbookId: string;
  queryId?: string;
  source: WorkbookIdentityDescriptor;
  request: SourceRequestDescriptor;
  grid: SourceGridDescriptor;
  revoked?: boolean;
}
```
 ### WorkbookVersionByteProvenance [Заголовок раздела «WorkbookVersionByteProvenance»](#workbookversionbyteprovenance) 
```ts
interface WorkbookVersionByteProvenance {
  format: WorkbookVersionFormat;
  byteLength: number;
  sha256: string;
  readOnly: boolean;
  macroEnabled: boolean;
  signaturePresent: boolean;
}
```
 ### WorkbookVersionCategoryDiff [Заголовок раздела «WorkbookVersionCategoryDiff»](#workbookversioncategorydiff) 
```ts
interface WorkbookVersionCategoryDiff {
  category:
    | "values"
    | "formulas"
    | "styles"
    | "comments"
    | "sheets"
    | "names"
    | "tables"
    | "pivots"
    | "drawings"
    | "relationships";
  support: WorkbookVersionCategorySupport;
  currentCount: number;
  versionCount: number;
  addedCount: number;
  removedCount: number;
  changedCount: number;
  currentFingerprint: string;
  versionFingerprint: string;
  reasonCode: string;
  truncated: boolean;
}
```
 ### WorkbookVersionCategorySupport [Заголовок раздела «WorkbookVersionCategorySupport»](#workbookversioncategorysupport) 
```ts
type WorkbookVersionCategorySupport = "compared" | "detect_only" | "unsupported" | "blocked";
```
 ### WorkbookVersionCompareStatus [Заголовок раздела «WorkbookVersionCompareStatus»](#workbookversioncomparestatus) 
```ts
type WorkbookVersionCompareStatus = "identical" | "different" | "blocked";
```
 ### WorkbookVersionFormat [Заголовок раздела «WorkbookVersionFormat»](#workbookversionformat) 
```ts
type WorkbookVersionFormat = "xlsx" | "xlsm" | "xltm" | "csv" | "ods";
```
 ### WorkbookVersionStructuralDiff [Заголовок раздела «WorkbookVersionStructuralDiff»](#workbookversionstructuraldiff) 
```ts
interface WorkbookVersionStructuralDiff {
  schemaVersion: 1;
  status: WorkbookVersionCompareStatus;
  current: WorkbookVersionByteProvenance;
  version: WorkbookVersionByteProvenance;
  categories: WorkbookVersionCategoryDiff[];
  changedCategoryCount: number;
  detectOnlyCategoryCount: number;
  unsupportedCategoryCount: number;
  blockedReasonCode?: string | null;
  redactionProfile: "stable-hashes-counts-reason-codes-only-v1";
}
```

# Типы: VBA и макросы

> Определения типов Compute Contract — проект, запуск, доверие и список одобренных макросов. Имён: 28.

Определения имён из колонки «Тип TypeScript» на страницах операций. Другие темы словаря: [сеанс, книга и листы](/reference/f1/types-session/) · [ячейки и диапазоны](/reference/f1/types-cells/) · [формулы и вычисления](/reference/f1/types-formulas/) · [форматирование](/reference/f1/types-format/) · [данные и объекты листа](/reference/f1/types-data/) · [сводные таблицы](/reference/f1/types-pivot/) · [диаграммы и графика](/reference/f1/types-charts/) · [печать и разметка страницы](/reference/f1/types-print/) · [Power Query](/reference/f1/types-powerquery/) · **VBA и макросы** · [защита и рецензирование](/reference/f1/types-protection/) · [общие и служебные](/reference/f1/types-common/). **Типы на этой странице — 28** * [`ContractMacroTrustIntent`](#contractmacrotrustintent) * [`ContractMacroTrustInventoryCounts`](#contractmacrotrustinventorycounts) * [`ContractMacroTrustProvenance`](#contractmacrotrustprovenance) * [`ContractMacroTrustResult`](#contractmacrotrustresult) * [`ContractMacroTrustState`](#contractmacrotruststate) * [`ContractTrustCenterMacroPolicy`](#contracttrustcentermacropolicy) * [`VbaBlockerSourceSpan`](#vbablockersourcespan) * [`VbaCapabilityBlocker`](#vbacapabilityblocker) * [`VbaCapabilityBlockerKind`](#vbacapabilityblockerkind) * [`VbaEntrypointDescriptor`](#vbaentrypointdescriptor) * [`VbaExecutionOutcome`](#vbaexecutionoutcome) * [`VbaExecutionOutcomeKind`](#vbaexecutionoutcomekind) * [`VbaExecutionPlan`](#vbaexecutionplan) * [`VbaExecutionRoute`](#vbaexecutionroute) * [`VbaExecutionSessionId`](#vbaexecutionsessionid) * [`VbaMacroKind`](#vbamacrokind) * [`VbaMacroVisibility`](#vbamacrovisibility) * [`VbaModuleCapability`](#vbamodulecapability) * [`VbaModuleKind`](#vbamodulekind) * [`VbaMutationPreview`](#vbamutationpreview) * [`VbaMutationPreviewCell`](#vbamutationpreviewcell) * [`VbaProjectBlockerTally`](#vbaprojectblockertally) * [`VbaProjectCapabilitySummary`](#vbaprojectcapabilitysummary) * [`VbaProjectInspection`](#vbaprojectinspection) * [`VbaProjectReference`](#vbaprojectreference) * [`VbaStructuralChange`](#vbastructuralchange) * [`VbaStructuralChangeOperation`](#vbastructuralchangeoperation) * [`VbaStructuralPreview`](#vbastructuralpreview) ### ContractMacroTrustIntent [Заголовок раздела «ContractMacroTrustIntent»](#contractmacrotrustintent) 
```ts
type ContractMacroTrustIntent =
  | { action: "inspect" }
  | { action: "inspect_signatures" }
  | { action: "keep_macros" }
  | { action: "remove_macros_from_copy"; destinationUri: string }
  | { action: "save_signature_copy"; destinationUri: string }
  | { action: "remove_signatures" }
  | { action: "cancel" };
```
 ### ContractMacroTrustInventoryCounts [Заголовок раздела «ContractMacroTrustInventoryCounts»](#contractmacrotrustinventorycounts) 
```ts
interface ContractMacroTrustInventoryCounts {
  packageParts: number;
  vbaProjects: number;
  vbaRelationships: number;
  signatureParts: number;
  customUiParts: number;
  activeXParts: number;
  oleParts: number;
  formControlParts?: number;
  externalLinkParts?: number;
  externalRelationships?: number;
}
```
 ### ContractMacroTrustProvenance [Заголовок раздела «ContractMacroTrustProvenance»](#contractmacrotrustprovenance) 
```ts
type ContractMacroTrustProvenance = "package-inventory" | "protected-view-policy" | "trusted-location-policy";
```
 ### ContractMacroTrustResult [Заголовок раздела «ContractMacroTrustResult»](#contractmacrotrustresult) 
```ts
interface ContractMacroTrustResult {
  states: ContractMacroTrustState[];
  counts: ContractMacroTrustInventoryCounts;


  cryptographicSignatureValidated: false;


  vbaRuntimeAvailable: false;
  packageFormat?: ContractFileFormat;
  trustProvenance?: ContractMacroTrustProvenance[];
  opaquePreservationVerified?: boolean;
  sourceBytesUnchanged: boolean;
  copied: boolean;
  outputByteCount: number;
  removedPartCount: number;
  removedRelationshipCount: number;
  macroFreeRemainderCount?: number;
  sourceMutated?: boolean;
  signatureInventory?: OpcSignatureInventory;
  reasonCode?: string;
}
```
 ### ContractMacroTrustState [Заголовок раздела «ContractMacroTrustState»](#contractmacrotruststate) 
```ts
type ContractMacroTrustState =
  | "macro-present"
  | "signature-part-present"
  | "unsigned"
  | "modified-after-signature-risk"
  | "malformed"
  | "blocked-by-protected-view"
  | "blocked-by-trusted-location"
  | "unsupported";
```
 ### ContractTrustCenterMacroPolicy [Заголовок раздела «ContractTrustCenterMacroPolicy»](#contracttrustcentermacropolicy) 
```ts
type ContractTrustCenterMacroPolicy = "block_with_notification" | "block_without_notification";
```
 ### VbaBlockerSourceSpan [Заголовок раздела «VbaBlockerSourceSpan»](#vbablockersourcespan) 
```ts
interface VbaBlockerSourceSpan {


  line: number;


  column: number;


  length: number;


  offset: number;
}
```
 ### VbaCapabilityBlocker [Заголовок раздела «VbaCapabilityBlocker»](#vbacapabilityblocker) 
```ts
interface VbaCapabilityBlocker {
  kind: VbaCapabilityBlockerKind;


  detail: string;


  evidence: string;


  sourceSpan: VbaBlockerSourceSpan | null;


  module: string;


  procedure: string | null;
}
```
 ### VbaCapabilityBlockerKind [Заголовок раздела «VbaCapabilityBlockerKind»](#vbacapabilityblockerkind) 
```ts
type VbaCapabilityBlockerKind =
  | "external-automation"
  | "event-or-document-module"
  | "language-pending"
  | "host-member-pending"
  | "unparsed"
  | "run-declaration-pending"
  | "excel-compile-error";
```
 ### VbaEntrypointDescriptor [Заголовок раздела «VbaEntrypointDescriptor»](#vbaentrypointdescriptor) 
```ts
interface VbaEntrypointDescriptor {


  entrypoint: string;
  module: string;
  procedure: string;
  kind: VbaMacroKind;
  visibility: VbaMacroVisibility;
  userRunnable: boolean;
  route: VbaExecutionRoute;


  nativeClaim: boolean;


  nativeLowerable: number;
  blockers: VbaCapabilityBlocker[];
}
```
 ### VbaExecutionOutcome [Заголовок раздела «VbaExecutionOutcome»](#vbaexecutionoutcome) 
```ts
interface VbaExecutionOutcome {
  kind: VbaExecutionOutcomeKind;


  stop: string | null;


  detail: string;


  rolledBack: boolean;


  progress?: {
    phase: "pending" | "running" | "finished";
    steps: number;
    instructionBudget: number;
    cancellationRequested: boolean;
  };
}
```
 ### VbaExecutionOutcomeKind [Заголовок раздела «VbaExecutionOutcomeKind»](#vbaexecutionoutcomekind) 
```ts
type VbaExecutionOutcomeKind =
  | "running"
  | "completed"
  | "refused-by-capability"
  | "unknown-entrypoint"
  | "unresolved-code-module"
  | "runtime-error"
  | "runtime-stopped";
```
 ### VbaExecutionPlan [Заголовок раздела «VbaExecutionPlan»](#vbaexecutionplan) 
```ts
interface VbaExecutionPlan {


  planId: string;


  planHash: string;
  entrypoint: string;


  route: VbaExecutionRoute | null;


  mayRunNatively: boolean;
  blockers: VbaCapabilityBlocker[];


  instructionBudget: number;


  steps: null;
}
```
 ### VbaExecutionRoute [Заголовок раздела «VbaExecutionRoute»](#vbaexecutionroute) 
```ts
type VbaExecutionRoute = "native" | "excel-bridge" | "excel-bridge-legacy" | "preserve-only";
```
 ### VbaExecutionSessionId [Заголовок раздела «VbaExecutionSessionId»](#vbaexecutionsessionid) 
```ts
type VbaExecutionSessionId = string;
```
 ### VbaMacroKind [Заголовок раздела «VbaMacroKind»](#vbamacrokind) 
```ts
type VbaMacroKind = "sub" | "function" | "property-get" | "property-let" | "property-set";
```
 ### VbaMacroVisibility [Заголовок раздела «VbaMacroVisibility»](#vbamacrovisibility) 
```ts
type VbaMacroVisibility = "public" | "private" | "friend";
```
 ### VbaModuleCapability [Заголовок раздела «VbaModuleCapability»](#vbamodulecapability) 
```ts
interface VbaModuleCapability {
  name: string;
  kind: VbaModuleKind;


  supportedLines: number;
  unsupportedLines: number;
  syntaxErrorLines: number;
  entrypointCount: number;
}
```
 ### VbaModuleKind [Заголовок раздела «VbaModuleKind»](#vbamodulekind) 
```ts
type VbaModuleKind = "standard" | "document" | "class" | "form" | "unknown";
```
 ### VbaMutationPreview [Заголовок раздела «VbaMutationPreview»](#vbamutationpreview) 
```ts
interface VbaMutationPreview {
  cells: VbaMutationPreviewCell[];


  structural: VbaStructuralPreview;


  structureTouched: boolean;


  sessionStateTouched: boolean;
}
```
 ### VbaMutationPreviewCell [Заголовок раздела «VbaMutationPreviewCell»](#vbamutationpreviewcell) 
```ts
interface VbaMutationPreviewCell {
  sheet: string;
  row: number;
  col: number;


  beforeDisplayText: string | null;


  afterDisplayText: string | null;


  beforeFormula: string | null;
  afterFormula: string | null;
}
```
 ### VbaProjectBlockerTally [Заголовок раздела «VbaProjectBlockerTally»](#vbaprojectblockertally) 
```ts
interface VbaProjectBlockerTally {
  kind: VbaCapabilityBlockerKind;
  macros: number;
}
```
 ### VbaProjectCapabilitySummary [Заголовок раздела «VbaProjectCapabilitySummary»](#vbaprojectcapabilitysummary) 
```ts
interface VbaProjectCapabilitySummary {
  modules: number;
  macros: number;
  nativeCandidates: number;
  excelBridge: number;
  excelBridgeLegacy: number;
  preserveOnly: number;
  userRunnable: number;
  userRunnableNative: number;
  nativeCandidateRatio: number;
  topBlockers: VbaProjectBlockerTally[];
}
```
 ### VbaProjectInspection [Заголовок раздела «VbaProjectInspection»](#vbaprojectinspection) 
```ts
interface VbaProjectInspection {


  capabilityContractVersion: number;
  sourceLabel: string;
  projectName: string | null;


  codePage: number;
  modules: VbaModuleCapability[];
  references: VbaProjectReference[];
  entrypoints: VbaEntrypointDescriptor[];
  summary: VbaProjectCapabilitySummary;
}
```
 ### VbaProjectReference [Заголовок раздела «VbaProjectReference»](#vbaprojectreference) 
```ts
interface VbaProjectReference {
  key: string;
  value: string;
}
```
 ### VbaStructuralChange [Заголовок раздела «VbaStructuralChange»](#vbastructuralchange) 
```ts
interface VbaStructuralChange {
  operation: VbaStructuralChangeOperation;


  sheet: string | null;


  description: string;
}
```
 ### VbaStructuralChangeOperation [Заголовок раздела «VbaStructuralChangeOperation»](#vbastructuralchangeoperation) 
```ts
type VbaStructuralChangeOperation =
  | "sheet-added"
  | "sheet-renamed"
  | "sheet-deleted"
  | "cells-inserted"
  | "cells-deleted"
  | "name-defined"
  | "save-as-staged";
```
 ### VbaStructuralPreview [Заголовок раздела «VbaStructuralPreview»](#vbastructuralpreview) 
```ts
type VbaStructuralPreview =
  | { state: "none" }
  | { state: "listed"; changes: VbaStructuralChange[] }
  | { state: "incomplete"; named: VbaStructuralChange[] };
```

# VBA и макросы

> Инспекция проекта, планирование и запуск, статус, отмена и откат, доверие к макросам и список одобренных. Операций на странице: 12.

Инспекция проекта, планирование и запуск, статус, отмена и откат, доверие к макросам и список одобренных. Термины — в [глоссарии](/start/glossary/). **Операции на этой странице — 12** * [`cancel_vba_execution`](#cancel_vba_execution) * [`commit_vba_execution`](#commit_vba_execution) * [`get_vba_execution_status`](#get_vba_execution_status) * [`inspect_vba_project`](#inspect_vba_project) * [`list_approved_macros`](#list_approved_macros) * [`list_vba_entrypoints`](#list_vba_entrypoints) * [`macro_trust_lifecycle`](#macro_trust_lifecycle) * [`plan_vba_execution`](#plan_vba_execution) * [`preview_vba_mutations`](#preview_vba_mutations) * [`rollback_vba_execution`](#rollback_vba_execution) * [`run_approved_macro`](#run_approved_macro) * [`start_vba_execution`](#start_vba_execution) ## cancel\_vba\_execution [Заголовок раздела «cancel\_vba\_execution»](#cancel_vba_execution) Отменяет vba execution. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"cancel_vba_execution"` | да | | `subsetId` | string | да | | `sessionId` | [VbaExecutionSessionId](/reference/f1/types-vba/#vbaexecutionsessionid) | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · cancel\_vba\_execution** | Поле | Тип TypeScript | Обяз. | | ----------- | ----------------------------------------------------------------------- | ----- | | operation | `"cancel_vba_execution"` | да | | `subsetId` | string | да | | `sessionId` | [VbaExecutionSessionId](/reference/f1/types-vba/#vbaexecutionsessionid) | да | | outcome | [VbaExecutionOutcome](/reference/f1/types-vba/#vbaexecutionoutcome) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "cancel_vba_execution",
  "subsetId": "<subsetId>",
  "sessionId": "<VbaExecutionSessionId>",
  "requestedBackend": "native-desktop"
}
```
 ## commit\_vba\_execution [Заголовок раздела «commit\_vba\_execution»](#commit_vba_execution) Фиксирует vba execution. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"commit_vba_execution"` | да | | `subsetId` | string | да | | `sessionId` | [VbaExecutionSessionId](/reference/f1/types-vba/#vbaexecutionsessionid) | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · commit\_vba\_execution** | Поле | Тип TypeScript | Обяз. | | ----------- | ----------------------------------------------------------------------- | ----- | | operation | `"commit_vba_execution"` | да | | `subsetId` | string | да | | `sessionId` | [VbaExecutionSessionId](/reference/f1/types-vba/#vbaexecutionsessionid) | да | | committed | [VbaMutationPreview](/reference/f1/types-vba/#vbamutationpreview) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "commit_vba_execution",
  "subsetId": "<subsetId>",
  "sessionId": "<VbaExecutionSessionId>",
  "requestedBackend": "native-desktop"
}
```
 ## get\_vba\_execution\_status [Заголовок раздела «get\_vba\_execution\_status»](#get_vba_execution_status) Получает vba execution status. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"get_vba_execution_status"` | да | | `subsetId` | string | да | | `sessionId` | [VbaExecutionSessionId](/reference/f1/types-vba/#vbaexecutionsessionid) | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · get\_vba\_execution\_status** | Поле | Тип TypeScript | Обяз. | | ----------- | ----------------------------------------------------------------------- | ----- | | operation | `"get_vba_execution_status"` | да | | `subsetId` | string | да | | `sessionId` | [VbaExecutionSessionId](/reference/f1/types-vba/#vbaexecutionsessionid) | да | | outcome | [VbaExecutionOutcome](/reference/f1/types-vba/#vbaexecutionoutcome) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "get_vba_execution_status",
  "subsetId": "<subsetId>",
  "sessionId": "<VbaExecutionSessionId>",
  "requestedBackend": "native-desktop"
}
```
 ## inspect\_vba\_project [Заголовок раздела «inspect\_vba\_project»](#inspect_vba_project) Инспектирует vba project. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"inspect_vba_project"` | да | | `subsetId` | string | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · inspect\_vba\_project** | Поле | Тип TypeScript | Обяз. | | ---------- | --------------------------------------------------------------------- | ----- | | operation | `"inspect_vba_project"` | да | | `subsetId` | string | да | | inspection | [VbaProjectInspection](/reference/f1/types-vba/#vbaprojectinspection) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "inspect_vba_project",
  "subsetId": "<subsetId>",
  "requestedBackend": "native-desktop"
}
```
 ## list\_approved\_macros [Заголовок раздела «list\_approved\_macros»](#list_approved_macros) Возвращает список approved macros. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"list_approved_macros"` | да | | `subsetId` | string | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · list\_approved\_macros** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | ------------ | ------------------------------------------------------------------------------------- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | operation | `"list_approved_macros"` | да | | | `subsetId` | string | да | | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | | macros | [ApprovedMacroDescriptor](/reference/f1/types-powerquery/#approvedmacrodescriptor)\[] | да | | | `policyNote` | string | да | Объясняет, почему список получился именно таким. Пустой список означает одно из двух, и по этому полю их видно: в книге нет читаемого проекта VBA — запускать нечего; либо проект есть, но ни одна его процедура не попала в список разрешённых. Что именно есть в книге, отвечают операции `list_vba_entrypoints` и `plan_vba_execution`. | **Минимальный JSON-шаблон** 
```json
{
  "operation": "list_approved_macros",
  "subsetId": "<subsetId>",
  "requestedBackend": "native-desktop"
}
```
 ## list\_vba\_entrypoints [Заголовок раздела «list\_vba\_entrypoints»](#list_vba_entrypoints) Возвращает список vba entrypoints. **Запрос** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | ------------------ | ---------------------------------------------------------------------------- | ----- | ------------------------------------------------------------------------ | | operation | `"list_vba_entrypoints"` | да | | | `subsetId` | string | да | | | `userRunnableOnly` | boolean | нет | Только те макросы, которые пользователь видит в диалоге «Макросы» Excel. | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | | **Ответ при успехе · list\_vba\_entrypoints** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | -------------------- | ------------------------------------------------------------------------------ | ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | operation | `"list_vba_entrypoints"` | да | | | `subsetId` | string | да | | | entrypoints | [VbaEntrypointDescriptor](/reference/f1/types-vba/#vbaentrypointdescriptor)\[] | да | Процедуры, попавшие в ответ: либо все разобранные процедуры проекта, либо — при `userRunnableOnly` — только видимые в диалоге «Макросы». Длина этого списка зависит от запроса и ничего не говорит о самой книге; для этого есть два поля ниже. | | `userRunnable` | number | да | Сколько макросов пользователь мог бы запустить из диалога «Макросы» и сколько из них выполняются ядром напрямую. Это свойства самой книги: они не пересчитываются из показанного списка, поэтому сужение списка не занижает эти числа. Те же значения возвращает `inspect_vba_project`. | | `userRunnableNative` | number | да | | **Минимальный JSON-шаблон** 
```json
{
  "operation": "list_vba_entrypoints",
  "subsetId": "<subsetId>",
  "requestedBackend": "native-desktop"
}
```
 ## macro\_trust\_lifecycle [Заголовок раздела «macro\_trust\_lifecycle»](#macro_trust_lifecycle) **Запрос** | Поле | Тип TypeScript | Обяз. | | ---------------------------- | ----------------------------------------------------------------------------- | ----- | | operation | `"macro_trust_lifecycle"` | да | | `subsetId` | string | да | | intent | [ContractMacroTrustIntent](/reference/f1/types-vba/#contractmacrotrustintent) | да | | `readOnly` | boolean | нет | | `protectedView` | boolean | нет | | `trustedLocation` | boolean | нет | | `modifiedAfterSignatureRisk` | boolean | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · macro\_trust\_lifecycle** | Поле | Тип TypeScript | Обяз. | | ---------- | ----------------------------------------------------------------------------------- | ----- | | operation | `"macro_trust_lifecycle"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | result | [ContractMacroTrustResult](/reference/f1/types-vba/#contractmacrotrustresult) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "macro_trust_lifecycle",
  "subsetId": "<subsetId>",
  "intent": "<ContractMacroTrustIntent>",
  "requestedBackend": "native-desktop"
}
```
 ## plan\_vba\_execution [Заголовок раздела «plan\_vba\_execution»](#plan_vba_execution) Планирует vba execution. **Запрос** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | ------------------- | ---------------------------------------------------------------------------- | ----- | ---------------------------------------------------------------------------------------------- | | operation | `"plan_vba_execution"` | да | | | `subsetId` | string | да | | | entrypoint | string | да | Имя вида `Модуль.Процедура` — единственный способ адресовать точку входа. | | `activeSheet` | string | да | | | `instructionBudget` | number | нет | Предел числа инструкций для одного запуска. Без поля берётся значение по умолчанию для сеанса. | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | | **Ответ при успехе · plan\_vba\_execution** | Поле | Тип TypeScript | Обяз. | | ---------- | ------------------------------------------------------------- | ----- | | operation | `"plan_vba_execution"` | да | | `subsetId` | string | да | | plan | [VbaExecutionPlan](/reference/f1/types-vba/#vbaexecutionplan) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "plan_vba_execution",
  "subsetId": "<subsetId>",
  "entrypoint": "<string>",
  "activeSheet": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## preview\_vba\_mutations [Заголовок раздела «preview\_vba\_mutations»](#preview_vba_mutations) Формирует preview для vba mutations. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"preview_vba_mutations"` | да | | `subsetId` | string | да | | `sessionId` | [VbaExecutionSessionId](/reference/f1/types-vba/#vbaexecutionsessionid) | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · preview\_vba\_mutations** | Поле | Тип TypeScript | Обяз. | | ----------- | ----------------------------------------------------------------------- | ----- | | operation | `"preview_vba_mutations"` | да | | `subsetId` | string | да | | `sessionId` | [VbaExecutionSessionId](/reference/f1/types-vba/#vbaexecutionsessionid) | да | | preview | [VbaMutationPreview](/reference/f1/types-vba/#vbamutationpreview) | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "preview_vba_mutations",
  "subsetId": "<subsetId>",
  "sessionId": "<VbaExecutionSessionId>",
  "requestedBackend": "native-desktop"
}
```
 ## rollback\_vba\_execution [Заголовок раздела «rollback\_vba\_execution»](#rollback_vba_execution) Откатывает vba execution. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"rollback_vba_execution"` | да | | `subsetId` | string | да | | `sessionId` | [VbaExecutionSessionId](/reference/f1/types-vba/#vbaexecutionsessionid) | да | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · rollback\_vba\_execution** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | --------------- | ----------------------------------------------------------------------- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | operation | `"rollback_vba_execution"` | да | | | `subsetId` | string | да | | | `sessionId` | [VbaExecutionSessionId](/reference/f1/types-vba/#vbaexecutionsessionid) | да | | | `restoredCells` | number | да | Сколько ячеек вернулось к прежним значениям при откате. Ноль — это полноценный ответ: запуск, не изменивший ни одной ячейки, откатывается так же, как изменивший тысячу. | **Минимальный JSON-шаблон** 
```json
{
  "operation": "rollback_vba_execution",
  "subsetId": "<subsetId>",
  "sessionId": "<VbaExecutionSessionId>",
  "requestedBackend": "native-desktop"
}
```
 ## run\_approved\_macro [Заголовок раздела «run\_approved\_macro»](#run_approved_macro) Запускает approved macro. **Запрос** | Поле | Тип TypeScript | Обяз. | | ------------------ | ---------------------------------------------------------------------------- | ----- | | operation | `"run_approved_macro"` | да | | `subsetId` | string | да | | `macroId` | string | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) \| null | нет | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | **Ответ при успехе · run\_approved\_macro** | Поле | Тип TypeScript | Обяз. | | ------------------- | ----------------------------------------------------------------------------------- | ----- | | operation | `"run_approved_macro"` | да | | `subsetId` | string | да | | session | [ContractSubsetSessionInfo](/reference/f1/types-session/#contractsubsetsessioninfo) | да | | macro | [ApprovedMacroDescriptor](/reference/f1/types-powerquery/#approvedmacrodescriptor) | да | | delta | [DeltaSummary](/reference/f1/types-cells/#deltasummary) | да | | `changedKeys` | string\[] | да | | `highlightCellKeys` | string\[] | да | | `statusMessage` | string | да | | `activeSheet` | [ContractActiveSheetMeta](/reference/f1/types-session/#contractactivesheetmeta) | да | | geometry | [ContractGeometrySubset](/reference/f1/types-session/#contractgeometrysubset) | да | | `recalcNeeded` | boolean | да | | viewport | [ViewportWindow](/reference/f1/types-session/#viewportwindow) | да | | `previewCells` | [ContractPreviewCell](/reference/f1/types-cells/#contractpreviewcell)\[] | да | **Минимальный JSON-шаблон** 
```json
{
  "operation": "run_approved_macro",
  "subsetId": "<subsetId>",
  "macroId": "<string>",
  "requestedBackend": "native-desktop"
}
```
 ## start\_vba\_execution [Заголовок раздела «start\_vba\_execution»](#start_vba_execution) Запускает vba execution. **Запрос** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | ------------------- | ---------------------------------------------------------------------------- | ----- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | operation | `"start_vba_execution"` | да | | | `subsetId` | string | да | | | entrypoint | string | да | | | `activeSheet` | string | да | | | `instructionBudget` | number | нет | | | `shownPlanId` | string | нет | Идентификатор плана, который вы показали пользователю перед запуском. Без этого поля запрос планируется и сразу выполняется — как и раньше. С полем добавляется одна проверка: план, описанный запросом, должен совпадать с показанным, иначе приходит отказ `automation-plan-stale`. Именно это поле придаёт смысл показанному плану: без него можно показать пользователю одни условия запуска, а отправить другие, и контракт этого не заметит. | | `requestedBackend` | [ComputeBackendKind](/reference/f1/types-common/#computebackendkind) \| null | нет | | **Ответ при успехе · start\_vba\_execution** | Поле | Тип TypeScript | Обяз. | Примечание из контракта | | ----------- | ----------------------------------------------------------------------- | ----- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | operation | `"start_vba_execution"` | да | | | `subsetId` | string | да | | | `sessionId` | [VbaExecutionSessionId](/reference/f1/types-vba/#vbaexecutionsessionid) | да | Есть в ответе всегда, даже когда после запуска нечего откатывать. Идентификатор выдаётся до запуска и называет его в любом случае; если откатывать нечего, `rollback_vba_execution` честно отвечает `automation-session-unknown`. | | outcome | [VbaExecutionOutcome](/reference/f1/types-vba/#vbaexecutionoutcome) | да | Сразу после запуска — `running`. Дальнейшие запросы состояния возвращают либо ход выполнения, либо итог запуска. | **Минимальный JSON-шаблон** 
```json
{
  "operation": "start_vba_execution",
  "subsetId": "<subsetId>",
  "entrypoint": "<string>",
  "activeSheet": "<string>",
  "requestedBackend": "native-desktop"
}
```