Sheets
Sheet lifecycle, copying between workbooks, visibility, protection, and freezing panes. Operations on this page: 17.
Sheet lifecycle, copying between workbooks, visibility, protection, and freezing panes. Terms are in the glossary.
Operations on this page — 17
apply_freeze_panecopy_sheet_boundedcopy_sheet_to_workbook_boundedcopy_sheet_values_only_boundedcreate_sheet_boundedcustom_views_managerdelete_sheet_boundedmove_sheet_to_workbook_boundedredo_sheet_lifecycle_boundedrename_sheet_boundedreorder_sheet_boundedset_sheet_code_name_boundedset_sheet_right_to_left_boundedset_sheet_tab_color_boundedset_sheet_visibility_boundedundo_delete_sheet_boundedundo_sheet_lifecycle_bounded
apply_freeze_pane
Section titled “apply_freeze_pane”Applies freezing panes.
Request
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "apply_freeze_pane" |
yes |
subsetId |
string | yes |
sheetKey |
string | yes |
| row | number | yes |
| col | number | yes |
| frozen | boolean | yes |
| viewport | ViewportWindow | null | no |
requestedBackend |
ComputeBackendKind | null | no |
Response on success · apply_freeze_pane
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "apply_freeze_pane" |
yes |
subsetId |
string | yes |
| session | ContractSubsetSessionInfo | yes |
supportedSubset |
string | yes |
| delta | DeltaSummary | yes |
| frozen | boolean | yes |
topLeftCell |
string | null | no |
xSplit |
number | null | no |
ySplit |
number | null | no |
changedFreezePane |
boolean | yes |
dirtyCellCount |
number | yes |
currentSourceSaveReadiness |
ContractCurrentSourceSaveReadiness | null | no |
activeSheet |
ContractActiveSheetMeta | yes |
| geometry | ContractGeometrySubset | yes |
recalcNeeded |
boolean | yes |
| viewport | ViewportWindow | yes |
previewCells |
ContractPreviewCell[] | yes |
layoutMetrics |
ContractLayoutMetricsSubset | yes |
Minimal JSON template
{ "operation": "apply_freeze_pane", "subsetId": "<subsetId>", "sheetKey": "<sheetPath>", "row": 0, "col": 0, "frozen": false, "requestedBackend": "native-desktop"}copy_sheet_bounded
Section titled “copy_sheet_bounded”Copies a sheet within given bounds.
Request
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "copy_sheet_bounded" |
yes |
subsetId |
string | yes |
sheetKey |
string | yes |
| name | string | yes |
targetIndex |
number | null | no |
expectedRevision |
number | null | no |
| viewport | ViewportWindow | null | no |
requestedBackend |
ComputeBackendKind | null | no |
Response on success · copy_sheet_bounded
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "copy_sheet_bounded" |
yes |
subsetId |
string | yes |
| session | ContractSubsetSessionInfo | yes |
supportedSubset |
string | yes |
| delta | DeltaSummary | yes |
sourceSheet |
ContractActiveSheetMeta | yes |
copiedSheet |
ContractActiveSheetMeta | yes |
activeSheet |
ContractActiveSheetMeta | yes |
sheetCount |
number | yes |
workbookSheets |
ContractWorkbookSheetMeta[] | yes |
| geometry | ContractGeometrySubset | yes |
recalcNeeded |
boolean | yes |
| viewport | ViewportWindow | yes |
previewCells |
ContractPreviewCell[] | yes |
layoutMetrics |
ContractLayoutMetricsSubset | null | no |
workbookHistory |
ContractWorkbookHistoryProjection | yes |
sheetCopyClaim |
"live_verified" |
yes |
copyScope |
"same_workbook_cell_formula_style_merge_layout_and_safe_sheet_metadata" |
yes |
copiedSheetIdentityNew |
true | yes |
copiedSheetValuesPreserved |
true | yes |
formulaCopyClaim |
"live_verified" |
yes |
formulaCopyScope |
"same_sheet_formula_text_and_cached_value_preserved" |
yes |
styleCopyClaim |
"live_verified" |
yes |
styleCopyScope |
"existing_workbook_style_indexes_preserved" |
yes |
mergeLayoutCopyClaim |
"live_verified" |
yes |
mergeLayoutCopyScope |
"row_column_geometry_merges_freeze_views_tables_and_safe_sheet_xml_preserved" |
yes |
pqOutputTargetCopyClaim |
"no" |
yes |
vbaModuleCopyClaim |
"no" |
yes |
broadWorkbookCloneClaim |
"no" |
yes |
Minimal JSON template
{ "operation": "copy_sheet_bounded", "subsetId": "<subsetId>", "sheetKey": "<sheetPath>", "name": "<string>", "requestedBackend": "native-desktop"}copy_sheet_to_workbook_bounded
Section titled “copy_sheet_to_workbook_bounded”Copies a sheet into another workbook, within given bounds.
Request
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "copy_sheet_to_workbook_bounded" |
yes |
sourceSubsetId |
string | yes |
targetSubsetId |
string | yes |
sourceSheetKey |
string | yes |
| name | string | yes |
targetViewport |
ViewportWindow | null | no |
requestedBackend |
ComputeBackendKind | null | no |
Response on success · copy_sheet_to_workbook_bounded
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "copy_sheet_to_workbook_bounded" |
yes |
sourceSubsetId |
string | yes |
targetSubsetId |
string | yes |
| session | ContractSubsetSessionInfo | yes |
supportedSubset |
string | yes |
| delta | DeltaSummary | yes |
sourceSheet |
ContractActiveSheetMeta | yes |
copiedSheet |
ContractActiveSheetMeta | yes |
targetActiveSheet |
ContractActiveSheetMeta | yes |
targetSheetCount |
number | yes |
targetWorkbookSheets |
ContractWorkbookSheetMeta[] | yes |
targetGeometry |
ContractGeometrySubset | yes |
targetRecalcNeeded |
boolean | yes |
targetViewport |
ViewportWindow | yes |
targetPreviewCells |
ContractPreviewCell[] | yes |
targetLayoutMetrics |
ContractLayoutMetricsSubset | null | no |
sheetCopyClaim |
"live_verified" |
yes |
copyScope |
"bounded_cross_workbook_cell_formula_style_merge_layout" |
yes |
copiedSheetIdentityNew |
true | yes |
copiedSheetValuesPreserved |
true | yes |
formulaCopyClaim |
"live_verified" |
yes |
formulaCopyScope |
"same_sheet_formula_text_and_cached_value_preserved" |
yes |
styleCopyClaim |
"live_verified" |
yes |
styleCopyScope |
"existing_target_workbook_style_indexes_preserved" |
yes |
mergeLayoutCopyClaim |
"live_verified" |
yes |
mergeLayoutCopyScope |
"row_column_geometry_merges_and_freeze_preserved" |
yes |
pqOutputTargetCopyClaim |
"no" |
yes |
vbaModuleCopyClaim |
"no" |
yes |
broadWorkbookCloneClaim |
"no" |
yes |
Minimal JSON template
{ "operation": "copy_sheet_to_workbook_bounded", "sourceSubsetId": "<string>", "targetSubsetId": "<string>", "sourceSheetKey": "<string>", "name": "<string>", "requestedBackend": "native-desktop"}copy_sheet_values_only_bounded
Section titled “copy_sheet_values_only_bounded”Copies a sheet without formulas, as values only, within given bounds.
Request
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "copy_sheet_values_only_bounded" |
yes |
subsetId |
string | yes |
sheetKey |
string | yes |
| name | string | yes |
expectedRevision |
number | null | no |
| viewport | ViewportWindow | null | no |
requestedBackend |
ComputeBackendKind | null | no |
Response on success · copy_sheet_values_only_bounded
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "copy_sheet_values_only_bounded" |
yes |
subsetId |
string | yes |
| session | ContractSubsetSessionInfo | yes |
supportedSubset |
string | yes |
| delta | DeltaSummary | yes |
sourceSheet |
ContractActiveSheetMeta | yes |
copiedSheet |
ContractActiveSheetMeta | yes |
activeSheet |
ContractActiveSheetMeta | yes |
sheetCount |
number | yes |
workbookSheets |
ContractWorkbookSheetMeta[] | yes |
| geometry | ContractGeometrySubset | yes |
recalcNeeded |
boolean | yes |
| viewport | ViewportWindow | yes |
previewCells |
ContractPreviewCell[] | yes |
layoutMetrics |
ContractLayoutMetricsSubset | null | no |
workbookHistory |
ContractWorkbookHistoryProjection | yes |
sheetCopyClaim |
"live_verified" |
yes |
copyScope |
"values_only_same_workbook_sheet" |
yes |
copiedSheetIdentityNew |
true | yes |
copiedSheetValuesPreserved |
true | yes |
formulaCopyClaim |
"no" |
yes |
styleCopyClaim |
"no" |
yes |
mergeLayoutCopyClaim |
"no" |
yes |
pqOutputTargetCopyClaim |
"no" |
yes |
vbaModuleCopyClaim |
"no" |
yes |
broadWorkbookCloneClaim |
"no" |
yes |
Minimal JSON template
{ "operation": "copy_sheet_values_only_bounded", "subsetId": "<subsetId>", "sheetKey": "<sheetPath>", "name": "<string>", "requestedBackend": "native-desktop"}create_sheet_bounded
Section titled “create_sheet_bounded”Creates a sheet within given bounds.
Request
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "create_sheet_bounded" |
yes |
subsetId |
string | yes |
| name | string | yes |
targetIndex |
number | null | no |
expectedRevision |
number | null | no |
| viewport | ViewportWindow | null | no |
requestedBackend |
ComputeBackendKind | null | no |
Response on success · create_sheet_bounded
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "create_sheet_bounded" |
yes |
subsetId |
string | yes |
| session | ContractSubsetSessionInfo | yes |
supportedSubset |
string | yes |
| delta | DeltaSummary | yes |
createdSheet |
ContractActiveSheetMeta | yes |
activeSheet |
ContractActiveSheetMeta | yes |
sheetCount |
number | yes |
workbookSheets |
ContractWorkbookSheetMeta[] | yes |
| geometry | ContractGeometrySubset | yes |
recalcNeeded |
boolean | yes |
| viewport | ViewportWindow | yes |
previewCells |
ContractPreviewCell[] | yes |
layoutMetrics |
ContractLayoutMetricsSubset | null | no |
workbookHistory |
ContractWorkbookHistoryProjection | yes |
sheetCreateClaim |
"live_verified" |
yes |
sheetCopyClaim |
"live_verified" |
yes |
deleteReferencedSheetClaim |
"blocked_truthful_boundary" |
yes |
formulaReferenceDeleteRewriteClaim |
"no" |
yes |
Minimal JSON template
{ "operation": "create_sheet_bounded", "subsetId": "<subsetId>", "name": "<string>", "requestedBackend": "native-desktop"}custom_views_manager
Section titled “custom_views_manager”Workbook views: checking and planning an atomic edit to the workbook and its package.
Request
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "custom_views_manager" |
yes |
subsetId |
string | yes |
| intent | ContractCustomViewsIntent | yes |
requestedBackend |
ComputeBackendKind | null | no |
Response on success · custom_views_manager
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "custom_views_manager" |
yes |
subsetId |
string | yes |
| session | ContractSubsetSessionInfo | yes |
| result | ContractCustomViewsResult | yes |
Minimal JSON template
{ "operation": "custom_views_manager", "subsetId": "<subsetId>", "intent": "<ContractCustomViewsIntent>", "requestedBackend": "native-desktop"}delete_sheet_bounded
Section titled “delete_sheet_bounded”Deletes a sheet within given bounds.
Request
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "delete_sheet_bounded" |
yes |
subsetId |
string | yes |
sheetKey |
string | yes |
expectedRevision |
number | null | no |
| viewport | ViewportWindow | null | no |
requestedBackend |
ComputeBackendKind | null | no |
Response on success · delete_sheet_bounded
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "delete_sheet_bounded" |
yes |
subsetId |
string | yes |
| session | ContractSubsetSessionInfo | yes |
supportedSubset |
string | yes |
| delta | DeltaSummary | yes |
deletedSheet |
ContractActiveSheetMeta | yes |
activeSheet |
ContractActiveSheetMeta | yes |
sheetCount |
number | yes |
workbookSheets |
ContractWorkbookSheetMeta[] | yes |
| geometry | ContractGeometrySubset | yes |
recalcNeeded |
boolean | yes |
| viewport | ViewportWindow | yes |
previewCells |
ContractPreviewCell[] | yes |
layoutMetrics |
ContractLayoutMetricsSubset | null | no |
workbookHistory |
ContractWorkbookHistoryProjection | yes |
sheetDeleteClaim |
"live_verified" |
yes |
deleteScope |
"unreferenced_bounded_sheet_only" |
yes |
deleteReferencedSheetClaim |
"blocked_truthful_boundary" |
yes |
sheetCopyClaim |
"live_verified" |
yes |
formulaReferenceDeleteRewriteClaim |
"no" |
yes |
Minimal JSON template
{ "operation": "delete_sheet_bounded", "subsetId": "<subsetId>", "sheetKey": "<sheetPath>", "requestedBackend": "native-desktop"}move_sheet_to_workbook_bounded
Section titled “move_sheet_to_workbook_bounded”Moves a sheet into another workbook, within given bounds.
Request
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "move_sheet_to_workbook_bounded" |
yes |
sourceSubsetId |
string | yes |
targetSubsetId |
string | yes |
sourceSheetKey |
string | yes |
| name | string | yes |
sourceViewport |
ViewportWindow | null | no |
targetViewport |
ViewportWindow | null | no |
requestedBackend |
ComputeBackendKind | null | no |
Response on success · move_sheet_to_workbook_bounded
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "move_sheet_to_workbook_bounded" |
yes |
sourceSubsetId |
string | yes |
targetSubsetId |
string | yes |
| session | ContractSubsetSessionInfo | yes |
supportedSubset |
string | yes |
targetDelta |
DeltaSummary | yes |
sourceDelta |
DeltaSummary | yes |
sourceSheet |
ContractActiveSheetMeta | yes |
movedSheet |
ContractActiveSheetMeta | yes |
sourceActiveSheet |
ContractActiveSheetMeta | yes |
sourceSheetCount |
number | yes |
sourceWorkbookSheets |
ContractWorkbookSheetMeta[] | yes |
sourceGeometry |
ContractGeometrySubset | yes |
sourceRecalcNeeded |
boolean | yes |
sourceViewport |
ViewportWindow | yes |
sourcePreviewCells |
ContractPreviewCell[] | yes |
sourceLayoutMetrics |
ContractLayoutMetricsSubset | null | no |
targetActiveSheet |
ContractActiveSheetMeta | yes |
targetSheetCount |
number | yes |
targetWorkbookSheets |
ContractWorkbookSheetMeta[] | yes |
targetGeometry |
ContractGeometrySubset | yes |
targetRecalcNeeded |
boolean | yes |
targetViewport |
ViewportWindow | yes |
targetPreviewCells |
ContractPreviewCell[] | yes |
targetLayoutMetrics |
ContractLayoutMetricsSubset | null | no |
sheetMoveClaim |
"live_verified" |
yes |
moveScope |
"bounded_cross_workbook_unreferenced_sheet_cell_formula_style_merge_layout" |
yes |
sourceSheetRemoved |
true | yes |
targetSheetIdentityNew |
true | yes |
movedSheetValuesPreserved |
true | yes |
formulaCopyClaim |
"live_verified" |
yes |
formulaCopyScope |
"same_sheet_formula_text_and_cached_value_preserved" |
yes |
styleCopyClaim |
"live_verified" |
yes |
styleCopyScope |
"existing_target_workbook_style_indexes_preserved" |
yes |
mergeLayoutCopyClaim |
"live_verified" |
yes |
mergeLayoutCopyScope |
"row_column_geometry_merges_and_freeze_preserved" |
yes |
formulaReferenceMoveRewriteClaim |
"no" |
yes |
pqOutputTargetCopyClaim |
"no" |
yes |
vbaModuleCopyClaim |
"no" |
yes |
broadWorkbookCloneClaim |
"no" |
yes |
Minimal JSON template
{ "operation": "move_sheet_to_workbook_bounded", "sourceSubsetId": "<string>", "targetSubsetId": "<string>", "sourceSheetKey": "<string>", "name": "<string>", "requestedBackend": "native-desktop"}redo_sheet_lifecycle_bounded
Section titled “redo_sheet_lifecycle_bounded”Redoes a sheet-lifecycle action within given bounds.
Request
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "redo_sheet_lifecycle_bounded" |
yes |
subsetId |
string | yes |
| viewport | ViewportWindow | null | no |
requestedBackend |
ComputeBackendKind | null | no |
Response on success · redo_sheet_lifecycle_bounded
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "redo_sheet_lifecycle_bounded" |
yes |
subsetId |
string | yes |
| session | ContractSubsetSessionInfo | yes |
supportedSubset |
string | yes |
| delta | DeltaSummary | yes |
| action | string | yes |
sheetName |
string | yes |
activeSheet |
ContractActiveSheetMeta | yes |
sheetCount |
number | yes |
workbookSheets |
ContractWorkbookSheetMeta[] | yes |
| geometry | ContractGeometrySubset | yes |
recalcNeeded |
boolean | yes |
| viewport | ViewportWindow | yes |
previewCells |
ContractPreviewCell[] | yes |
layoutMetrics |
ContractLayoutMetricsSubset | null | no |
sheetLifecycleRedoClaim |
"live_verified" |
yes |
redoScope |
"last_undone_current_workbook_sheet_move_or_copy_snapshot_current_session" |
yes |
Minimal JSON template
{ "operation": "redo_sheet_lifecycle_bounded", "subsetId": "<subsetId>", "requestedBackend": "native-desktop"}rename_sheet_bounded
Section titled “rename_sheet_bounded”Renames a sheet within given bounds.
Request
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "rename_sheet_bounded" |
yes |
subsetId |
string | yes |
sheetKey |
string | yes |
newName |
string | yes |
expectedRevision |
number | null | no |
| viewport | ViewportWindow | null | no |
requestedBackend |
ComputeBackendKind | null | no |
Response on success · rename_sheet_bounded
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "rename_sheet_bounded" |
yes |
subsetId |
string | yes |
| session | ContractSubsetSessionInfo | yes |
supportedSubset |
string | yes |
| delta | DeltaSummary | yes |
renamedSheet |
ContractActiveSheetMeta | yes |
activeSheet |
ContractActiveSheetMeta | yes |
sheetCount |
number | yes |
workbookSheets |
ContractWorkbookSheetMeta[] | yes |
| geometry | ContractGeometrySubset | yes |
recalcNeeded |
boolean | yes |
| viewport | ViewportWindow | yes |
previewCells |
ContractPreviewCell[] | yes |
layoutMetrics |
ContractLayoutMetricsSubset | null | no |
workbookHistory |
ContractWorkbookHistoryProjection | yes |
sheetRenameClaim |
"live_verified" |
yes |
formulaReferenceAutoUpdateClaim |
"live_verified" |
yes |
formulaReferenceBehavior |
"updated_truthfully" |
yes |
Minimal JSON template
{ "operation": "rename_sheet_bounded", "subsetId": "<subsetId>", "sheetKey": "<sheetPath>", "newName": "<string>", "requestedBackend": "native-desktop"}reorder_sheet_bounded
Section titled “reorder_sheet_bounded”Reorders a sheet within given bounds.
Request
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "reorder_sheet_bounded" |
yes |
subsetId |
string | yes |
sheetKey |
string | yes |
targetIndex |
number | yes |
expectedRevision |
number | null | no |
| viewport | ViewportWindow | null | no |
requestedBackend |
ComputeBackendKind | null | no |
Response on success · reorder_sheet_bounded
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "reorder_sheet_bounded" |
yes |
subsetId |
string | yes |
| session | ContractSubsetSessionInfo | yes |
supportedSubset |
string | yes |
| delta | DeltaSummary | yes |
movedSheet |
ContractActiveSheetMeta | yes |
previousIndex |
number | yes |
targetIndex |
number | yes |
activeSheet |
ContractActiveSheetMeta | yes |
sheetCount |
number | yes |
workbookSheets |
ContractWorkbookSheetMeta[] | yes |
| geometry | ContractGeometrySubset | yes |
recalcNeeded |
boolean | yes |
| viewport | ViewportWindow | yes |
previewCells |
ContractPreviewCell[] | yes |
layoutMetrics |
ContractLayoutMetricsSubset | null | no |
workbookHistory |
ContractWorkbookHistoryProjection | yes |
sheetReorderClaim |
"live_verified" |
yes |
reorderScope |
"same_workbook_sheet_order_only" |
yes |
sheetIdentityPreservedAfterReorder |
true | yes |
formulaReferencePositionRewriteClaim |
"no" |
yes |
formulaReferencesRemainIdentityBased |
true | yes |
sheetCopyClaim |
"live_verified" |
yes |
Minimal JSON template
{ "operation": "reorder_sheet_bounded", "subsetId": "<subsetId>", "sheetKey": "<sheetPath>", "targetIndex": 0, "requestedBackend": "native-desktop"}set_sheet_code_name_bounded
Section titled “set_sheet_code_name_bounded”Sets a sheet’s code name within given bounds.
Request
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "set_sheet_code_name_bounded" |
yes |
subsetId |
string | yes |
sheetKey |
string | yes |
codeName |
string | yes |
| viewport | ViewportWindow | null | no |
requestedBackend |
ComputeBackendKind | null | no |
Response on success · set_sheet_code_name_bounded
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "set_sheet_code_name_bounded" |
yes |
subsetId |
string | yes |
| session | ContractSubsetSessionInfo | yes |
supportedSubset |
string | yes |
| delta | DeltaSummary | yes |
changedSheet |
ContractActiveSheetMeta | yes |
previousCodeName |
string | null | yes |
codeName |
string | yes |
activeSheet |
ContractActiveSheetMeta | yes |
sheetCount |
number | yes |
workbookSheets |
ContractWorkbookSheetMeta[] | yes |
| geometry | ContractGeometrySubset | yes |
recalcNeeded |
boolean | yes |
| viewport | ViewportWindow | yes |
previewCells |
ContractPreviewCell[] | yes |
layoutMetrics |
ContractLayoutMetricsSubset | null | no |
workbookHistory |
ContractWorkbookHistoryProjection | yes |
sheetCodeNameClaim |
"live_verified" |
yes |
codeNameScope |
"same_workbook_worksheet_sheetPr_codeName" |
yes |
Minimal JSON template
{ "operation": "set_sheet_code_name_bounded", "subsetId": "<subsetId>", "sheetKey": "<sheetPath>", "codeName": "<string>", "requestedBackend": "native-desktop"}set_sheet_right_to_left_bounded
Section titled “set_sheet_right_to_left_bounded”Sets right-to-left text on a sheet, within given bounds.
Request
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "set_sheet_right_to_left_bounded" |
yes |
subsetId |
string | yes |
sheetKey |
string | yes |
rightToLeft |
boolean | yes |
expectedRevision |
number | null | no |
| viewport | ViewportWindow | null | no |
requestedBackend |
ComputeBackendKind | null | no |
Response on success · set_sheet_right_to_left_bounded
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "set_sheet_right_to_left_bounded" |
yes |
subsetId |
string | yes |
| session | ContractSubsetSessionInfo | yes |
supportedSubset |
string | yes |
| delta | DeltaSummary | yes |
changedSheet |
ContractActiveSheetMeta | yes |
previousRightToLeft |
boolean | null | yes |
rightToLeft |
boolean | yes |
activeSheet |
ContractActiveSheetMeta | yes |
sheetCount |
number | yes |
workbookSheets |
ContractWorkbookSheetMeta[] | yes |
| geometry | ContractGeometrySubset | yes |
recalcNeeded |
boolean | yes |
| viewport | ViewportWindow | yes |
previewCells |
ContractPreviewCell[] | yes |
layoutMetrics |
ContractLayoutMetricsSubset | null | no |
workbookHistory |
ContractWorkbookHistoryProjection | yes |
sheetRightToLeftClaim |
"live_verified" |
yes |
rightToLeftScope |
"same_workbook_worksheet_sheetView_rightToLeft" |
yes |
Minimal JSON template
{ "operation": "set_sheet_right_to_left_bounded", "subsetId": "<subsetId>", "sheetKey": "<sheetPath>", "rightToLeft": false, "requestedBackend": "native-desktop"}set_sheet_tab_color_bounded
Section titled “set_sheet_tab_color_bounded”Sets a sheet tab’s color within given bounds.
Request
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "set_sheet_tab_color_bounded" |
yes |
subsetId |
string | yes |
sheetKey |
string | yes |
| rgb | string | null | yes |
| viewport | ViewportWindow | null | no |
requestedBackend |
ComputeBackendKind | null | no |
Response on success · set_sheet_tab_color_bounded
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "set_sheet_tab_color_bounded" |
yes |
subsetId |
string | yes |
| session | ContractSubsetSessionInfo | yes |
supportedSubset |
string | yes |
| delta | DeltaSummary | yes |
changedSheet |
ContractActiveSheetMeta | yes |
previousTabColorRgb |
string | null | yes |
tabColorRgb |
string | null | yes |
activeSheet |
ContractActiveSheetMeta | yes |
sheetCount |
number | yes |
workbookSheets |
ContractWorkbookSheetMeta[] | yes |
| geometry | ContractGeometrySubset | yes |
recalcNeeded |
boolean | yes |
| viewport | ViewportWindow | yes |
previewCells |
ContractPreviewCell[] | yes |
layoutMetrics |
ContractLayoutMetricsSubset | null | no |
workbookHistory |
ContractWorkbookHistoryProjection | yes |
sheetTabColorClaim |
"live_verified" |
yes |
tabColorScope |
"same_workbook_worksheet_sheetPr_tabColor_rgb" |
yes |
Minimal JSON template
{ "operation": "set_sheet_tab_color_bounded", "subsetId": "<subsetId>", "sheetKey": "<sheetPath>", "rgb": "<string>", "requestedBackend": "native-desktop"}set_sheet_visibility_bounded
Section titled “set_sheet_visibility_bounded”Sets a sheet’s visibility within given bounds.
Request
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "set_sheet_visibility_bounded" |
yes |
subsetId |
string | yes |
sheetKey |
string | yes |
visibilityState |
ContractSheetVisibilityState | yes |
| viewport | ViewportWindow | null | no |
requestedBackend |
ComputeBackendKind | null | no |
Response on success · set_sheet_visibility_bounded
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "set_sheet_visibility_bounded" |
yes |
subsetId |
string | yes |
| session | ContractSubsetSessionInfo | yes |
supportedSubset |
string | yes |
| delta | DeltaSummary | yes |
changedSheet |
ContractActiveSheetMeta | yes |
previousVisibilityState |
ContractSheetVisibilityState | yes |
visibilityState |
ContractSheetVisibilityState | yes |
activeSheet |
ContractActiveSheetMeta | yes |
sheetCount |
number | yes |
workbookSheets |
ContractWorkbookSheetMeta[] | yes |
| geometry | ContractGeometrySubset | yes |
recalcNeeded |
boolean | yes |
| viewport | ViewportWindow | yes |
previewCells |
ContractPreviewCell[] | yes |
layoutMetrics |
ContractLayoutMetricsSubset | null | no |
workbookHistory |
ContractWorkbookHistoryProjection | yes |
sheetVisibilityClaim |
"live_verified" |
yes |
visibilityScope |
"same_workbook_visible_hidden_very_hidden" |
yes |
veryHiddenClaim |
"live_verified" |
yes |
lastVisibleSheetHideClaim |
"blocked_truthful_boundary" |
yes |
Minimal JSON template
{ "operation": "set_sheet_visibility_bounded", "subsetId": "<subsetId>", "sheetKey": "<sheetPath>", "visibilityState": "<ContractSheetVisibilityState>", "requestedBackend": "native-desktop"}undo_delete_sheet_bounded
Section titled “undo_delete_sheet_bounded”Undoes sheet deletion within given bounds.
Request
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "undo_delete_sheet_bounded" |
yes |
subsetId |
string | yes |
| viewport | ViewportWindow | null | no |
requestedBackend |
ComputeBackendKind | null | no |
Response on success · undo_delete_sheet_bounded
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "undo_delete_sheet_bounded" |
yes |
subsetId |
string | yes |
| session | ContractSubsetSessionInfo | yes |
supportedSubset |
string | yes |
| delta | DeltaSummary | yes |
restoredSheet |
ContractActiveSheetMeta | yes |
restoredIndex |
number | yes |
activeSheet |
ContractActiveSheetMeta | yes |
sheetCount |
number | yes |
workbookSheets |
ContractWorkbookSheetMeta[] | yes |
| geometry | ContractGeometrySubset | yes |
recalcNeeded |
boolean | yes |
| viewport | ViewportWindow | yes |
previewCells |
ContractPreviewCell[] | yes |
layoutMetrics |
ContractLayoutMetricsSubset | null | no |
sheetUndoDeleteClaim |
"live_verified" |
yes |
undoDeleteScope |
"last_unreferenced_bounded_sheet_current_session" |
yes |
undoDeletePersistenceClaim |
"save_reopen_after_restore_live" |
yes |
formulaReferenceDeleteRewriteClaim |
"no" |
yes |
Minimal JSON template
{ "operation": "undo_delete_sheet_bounded", "subsetId": "<subsetId>", "requestedBackend": "native-desktop"}undo_sheet_lifecycle_bounded
Section titled “undo_sheet_lifecycle_bounded”Undoes a sheet-lifecycle action within given bounds.
Request
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "undo_sheet_lifecycle_bounded" |
yes |
subsetId |
string | yes |
| viewport | ViewportWindow | null | no |
requestedBackend |
ComputeBackendKind | null | no |
Response on success · undo_sheet_lifecycle_bounded
| Field | TypeScript type | Req. |
|---|---|---|
| operation | "undo_sheet_lifecycle_bounded" |
yes |
subsetId |
string | yes |
| session | ContractSubsetSessionInfo | yes |
supportedSubset |
string | yes |
| delta | DeltaSummary | yes |
| action | string | yes |
sheetName |
string | yes |
activeSheet |
ContractActiveSheetMeta | yes |
sheetCount |
number | yes |
workbookSheets |
ContractWorkbookSheetMeta[] | yes |
| geometry | ContractGeometrySubset | yes |
recalcNeeded |
boolean | yes |
| viewport | ViewportWindow | yes |
previewCells |
ContractPreviewCell[] | yes |
layoutMetrics |
ContractLayoutMetricsSubset | null | no |
sheetLifecycleUndoClaim |
"live_verified" |
yes |
undoScope |
"last_current_workbook_sheet_move_or_copy_snapshot_current_session" |
yes |
Minimal JSON template
{ "operation": "undo_sheet_lifecycle_bounded", "subsetId": "<subsetId>", "requestedBackend": "native-desktop"}