Листы и печать · часть 1

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

Домен разбит на несколько страниц: часть 1 · часть 2.

Операции на этой странице — 12

apply_freeze_pane
apply_sheet_background_patch
apply_worksheet_page_setup
compute_page_break_layout
copy_sheet_bounded
copy_sheet_to_workbook_bounded
copy_sheet_values_only_bounded
create_chart_sheet_bounded
create_sheet_bounded
custom_views_manager
delete_sheet_bounded
move_sheet_to_workbook_bounded

apply_freeze_pane

Применяет freeze pane.

Request

Поле	Тип TypeScript	Обяз.
operation	“apply_freeze_pane”	да
subsetId	string	да
sheetKey	string	да
row	number	да
col	number	да
frozen	boolean	да
viewport	ViewportWindow \| null	нет
requestedBackend	ComputeBackendKind \| null	нет

Success payload · apply_freeze_pane

Поле	Тип TypeScript	Обяз.
operation	“apply_freeze_pane”	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
supportedSubset	string	да
delta	DeltaSummary	да
frozen	boolean	да
topLeftCell	string \| null	нет
xSplit	number \| null	нет
ySplit	number \| null	нет
changedFreezePane	boolean	да
dirtyCellCount	number	да
currentSourceSaveReadiness	ContractCurrentSourceSaveReadiness \| null	нет
activeSheet	ContractActiveSheetMeta	да
geometry	ContractGeometrySubset	да
recalcNeeded	boolean	да
viewport	ViewportWindow	да
previewCells	ContractPreviewCell[]	да
layoutMetrics	ContractLayoutMetricsSubset	да

Минимальный JSON-шаблон

{
  "operation": "apply_freeze_pane",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "row": 0,
  "col": 0,
  "frozen": false,
  "requestedBackend": "native-desktop"
}

apply_sheet_background_patch

Применяет sheet background patch.

Request

Поле	Тип TypeScript	Обяз.
operation	“apply_sheet_background_patch”	да
subsetId	string	да
packageBytesBase64	string	да
patch	ContractXlsxSheetBackgroundPatch	да
requestedBackend	ComputeBackendKind \| null	нет

Success payload · apply_sheet_background_patch

Поле	Тип TypeScript	Обяз.
operation	“apply_sheet_background_patch”	да
packageBytesBase64	string	да
byteCount	number	да
applied	boolean	да

Минимальный JSON-шаблон

{
  "operation": "apply_sheet_background_patch",
  "subsetId": "<subsetId>",
  "packageBytesBase64": "<base64>",
  "patch": "<ContractXlsxSheetBackgroundPatch>",
  "requestedBackend": "native-desktop"
}

apply_worksheet_page_setup

Применяет worksheet page setup.

Request

Поле	Тип TypeScript	Обяз.
operation	“apply_worksheet_page_setup”	да
subsetId	string	да
sheetKey	string	да
pageSetup	ContractWorksheetPageSetup	да
expectedRevision	number \| null	нет
viewport	ViewportWindow \| null	нет
requestedBackend	ComputeBackendKind \| null	нет

Success payload · apply_worksheet_page_setup

Поле	Тип TypeScript	Обяз.
operation	“apply_worksheet_page_setup”	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
supportedSubset	string	да
delta	DeltaSummary	да
changedPageSetup	boolean	да
pageSetup	ContractWorksheetPageSetup	да
workbookHistory	ContractWorkbookHistoryProjection	да
dirtyCellCount	number	да
currentSourceSaveReadiness	ContractCurrentSourceSaveReadiness \| null	нет
activeSheet	ContractActiveSheetMeta	да
geometry	ContractGeometrySubset	да
recalcNeeded	boolean	да
viewport	ViewportWindow	да
previewCells	ContractPreviewCell[]	да
layoutMetrics	ContractLayoutMetricsSubset	да

Минимальный JSON-шаблон

{
  "operation": "apply_worksheet_page_setup",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "pageSetup": "<ContractWorksheetPageSetup>",
  "requestedBackend": "native-desktop"
}

compute_page_break_layout

Вычисляет page break layout.

Request

Поле	Тип TypeScript	Обяз.	Примечание из контракта
operation	“compute_page_break_layout”	да
subsetId	string	да
sheetKey	string	да
usedRowEnd	number	да	Bottom-right corner of the used range (0-based, inclusive) that pagination must cover.
usedColEnd	number	да
pageSetup	ContractPageBreakPageSetup	да
manualRowBreaks	number[]	да	Row indices (0-based) where the user inserted a manual page break BEFORE that row.
manualColBreaks	number[]	да	Column indices (0-based) where the user inserted a manual page break BEFORE that column.
requestedBackend	ComputeBackendKind \| null	нет

Success payload · compute_page_break_layout

Поле	Тип TypeScript	Обяз.
operation	“compute_page_break_layout”	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
rowBreaks	ContractPageBreakLine[]	да
colBreaks	ContractPageBreakLine[]	да
pagesAcross	number	да
pagesDown	number	да
pageCount	number	да

Минимальный JSON-шаблон

{
  "operation": "compute_page_break_layout",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "usedRowEnd": 0,
  "usedColEnd": 0,
  "pageSetup": "<ContractPageBreakPageSetup>",
  "manualRowBreaks": 0,
  "manualColBreaks": 0,
  "requestedBackend": "native-desktop"
}

copy_sheet_bounded

Копирует sheet bounded.

Request

Поле	Тип TypeScript	Обяз.
operation	“copy_sheet_bounded”	да
subsetId	string	да
sheetKey	string	да
name	string	да
targetIndex	number \| null	нет
expectedRevision	number \| null	нет
viewport	ViewportWindow \| null	нет
requestedBackend	ComputeBackendKind \| null	нет

Success payload · copy_sheet_bounded

Поле	Тип TypeScript	Обяз.
operation	“copy_sheet_bounded”	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
supportedSubset	string	да
delta	DeltaSummary	да
sourceSheet	ContractActiveSheetMeta	да
copiedSheet	ContractActiveSheetMeta	да
activeSheet	ContractActiveSheetMeta	да
sheetCount	number	да
workbookSheets	ContractWorkbookSheetMeta[]	да
geometry	ContractGeometrySubset	да
recalcNeeded	boolean	да
viewport	ViewportWindow	да
previewCells	ContractPreviewCell[]	да
layoutMetrics	ContractLayoutMetricsSubset \| null	нет
workbookHistory	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-шаблон

{
  "operation": "copy_sheet_bounded",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "name": "<string>",
  "requestedBackend": "native-desktop"
}

copy_sheet_to_workbook_bounded

Копирует sheet to workbook bounded.

Request

Поле	Тип TypeScript	Обяз.
operation	“copy_sheet_to_workbook_bounded”	да
sourceSubsetId	string	да
targetSubsetId	string	да
sourceSheetKey	string	да
name	string	да
targetViewport	ViewportWindow \| null	нет
requestedBackend	ComputeBackendKind \| null	нет

Success payload · copy_sheet_to_workbook_bounded

Поле	Тип TypeScript	Обяз.
operation	“copy_sheet_to_workbook_bounded”	да
sourceSubsetId	string	да
targetSubsetId	string	да
session	ContractSubsetSessionInfo	да
supportedSubset	string	да
delta	DeltaSummary	да
sourceSheet	ContractActiveSheetMeta	да
copiedSheet	ContractActiveSheetMeta	да
targetActiveSheet	ContractActiveSheetMeta	да
targetSheetCount	number	да
targetWorkbookSheets	ContractWorkbookSheetMeta[]	да
targetGeometry	ContractGeometrySubset	да
targetRecalcNeeded	boolean	да
targetViewport	ViewportWindow	да
targetPreviewCells	ContractPreviewCell[]	да
targetLayoutMetrics	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-шаблон

{
  "operation": "copy_sheet_to_workbook_bounded",
  "sourceSubsetId": "<string>",
  "targetSubsetId": "<string>",
  "sourceSheetKey": "<string>",
  "name": "<string>",
  "requestedBackend": "native-desktop"
}

copy_sheet_values_only_bounded

Копирует sheet values only bounded.

Request

Поле	Тип TypeScript	Обяз.
operation	“copy_sheet_values_only_bounded”	да
subsetId	string	да
sheetKey	string	да
name	string	да
expectedRevision	number \| null	нет
viewport	ViewportWindow \| null	нет
requestedBackend	ComputeBackendKind \| null	нет

Success payload · copy_sheet_values_only_bounded

Поле	Тип TypeScript	Обяз.
operation	“copy_sheet_values_only_bounded”	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
supportedSubset	string	да
delta	DeltaSummary	да
sourceSheet	ContractActiveSheetMeta	да
copiedSheet	ContractActiveSheetMeta	да
activeSheet	ContractActiveSheetMeta	да
sheetCount	number	да
workbookSheets	ContractWorkbookSheetMeta[]	да
geometry	ContractGeometrySubset	да
recalcNeeded	boolean	да
viewport	ViewportWindow	да
previewCells	ContractPreviewCell[]	да
layoutMetrics	ContractLayoutMetricsSubset \| null	нет
workbookHistory	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-шаблон

{
  "operation": "copy_sheet_values_only_bounded",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "name": "<string>",
  "requestedBackend": "native-desktop"
}

create_chart_sheet_bounded

Создаёт chart sheet bounded.

Request

Поле	Тип TypeScript	Обяз.
operation	“create_chart_sheet_bounded”	да
subsetId	string	да
sourceSheetKey	string	да
sourceChartStableId	string	да
name	string	да
targetIndex	number \| null	нет
viewport	ViewportWindow \| null	нет
requestedBackend	ComputeBackendKind \| null	нет

Success payload · create_chart_sheet_bounded

Поле	Тип TypeScript	Обяз.
operation	“create_chart_sheet_bounded”	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
supportedSubset	string	да
delta	DeltaSummary	да
createdSheet	ContractActiveSheetMeta	да
activeSheet	ContractActiveSheetMeta	да
sheetCount	number	да
workbookSheets	ContractWorkbookSheetMeta[]	да
geometry	ContractGeometrySubset	да
recalcNeeded	boolean	да
viewport	ViewportWindow	да
previewCells	ContractPreviewCell[]	да
surfaceObjects	ContractSheetObject[]	да
layoutMetrics	ContractLayoutMetricsSubset \| null	нет
nativeChartsheetClaim	“live_verified”	да
lifecycleClaim	“live_verified”	да
macroSheetParityClaim	“no”	да
dialogSheetParityClaim	“no”	да

Минимальный JSON-шаблон

{
  "operation": "create_chart_sheet_bounded",
  "subsetId": "<subsetId>",
  "sourceSheetKey": "<string>",
  "sourceChartStableId": "<string>",
  "name": "<string>",
  "requestedBackend": "native-desktop"
}

create_sheet_bounded

Создаёт sheet bounded.

Request

Поле	Тип TypeScript	Обяз.
operation	“create_sheet_bounded”	да
subsetId	string	да
name	string	да
targetIndex	number \| null	нет
expectedRevision	number \| null	нет
viewport	ViewportWindow \| null	нет
requestedBackend	ComputeBackendKind \| null	нет

Success payload · create_sheet_bounded

Поле	Тип TypeScript	Обяз.
operation	“create_sheet_bounded”	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
supportedSubset	string	да
delta	DeltaSummary	да
createdSheet	ContractActiveSheetMeta	да
activeSheet	ContractActiveSheetMeta	да
sheetCount	number	да
workbookSheets	ContractWorkbookSheetMeta[]	да
geometry	ContractGeometrySubset	да
recalcNeeded	boolean	да
viewport	ViewportWindow	да
previewCells	ContractPreviewCell[]	да
layoutMetrics	ContractLayoutMetricsSubset \| null	нет
workbookHistory	ContractWorkbookHistoryProjection	да
sheetCreateClaim	“live_verified”	да
sheetCopyClaim	“live_verified”	да
deleteReferencedSheetClaim	“blocked_truthful_boundary”	да
formulaReferenceDeleteRewriteClaim	“no”	да

Минимальный JSON-шаблон

{
  "operation": "create_sheet_bounded",
  "subsetId": "<subsetId>",
  "name": "<string>",
  "requestedBackend": "native-desktop"
}

custom_views_manager

Операция custom views manager.

Request

Поле	Тип TypeScript	Обяз.
operation	“custom_views_manager”	да
subsetId	string	да
intent	ContractCustomViewsIntent	да
requestedBackend	ComputeBackendKind \| null	нет

Success payload · custom_views_manager

Поле	Тип TypeScript	Обяз.
operation	“custom_views_manager”	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
result	ContractCustomViewsResult	да

Минимальный JSON-шаблон

{
  "operation": "custom_views_manager",
  "subsetId": "<subsetId>",
  "intent": "<ContractCustomViewsIntent>",
  "requestedBackend": "native-desktop"
}

delete_sheet_bounded

Удаляет sheet bounded.

Request

Поле	Тип TypeScript	Обяз.
operation	“delete_sheet_bounded”	да
subsetId	string	да
sheetKey	string	да
expectedRevision	number \| null	нет
viewport	ViewportWindow \| null	нет
requestedBackend	ComputeBackendKind \| null	нет

Success payload · delete_sheet_bounded

Поле	Тип TypeScript	Обяз.
operation	“delete_sheet_bounded”	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
supportedSubset	string	да
delta	DeltaSummary	да
deletedSheet	ContractActiveSheetMeta	да
activeSheet	ContractActiveSheetMeta	да
sheetCount	number	да
workbookSheets	ContractWorkbookSheetMeta[]	да
geometry	ContractGeometrySubset	да
recalcNeeded	boolean	да
viewport	ViewportWindow	да
previewCells	ContractPreviewCell[]	да
layoutMetrics	ContractLayoutMetricsSubset \| null	нет
workbookHistory	ContractWorkbookHistoryProjection	да
sheetDeleteClaim	“live_verified”	да
deleteScope	“unreferenced_bounded_sheet_only”	да
deleteReferencedSheetClaim	“blocked_truthful_boundary”	да
sheetCopyClaim	“live_verified”	да
formulaReferenceDeleteRewriteClaim	“no”	да

Минимальный JSON-шаблон

{
  "operation": "delete_sheet_bounded",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "requestedBackend": "native-desktop"
}

move_sheet_to_workbook_bounded

Перемещает sheet to workbook bounded.

Request

Поле	Тип TypeScript	Обяз.
operation	“move_sheet_to_workbook_bounded”	да
sourceSubsetId	string	да
targetSubsetId	string	да
sourceSheetKey	string	да
name	string	да
sourceViewport	ViewportWindow \| null	нет
targetViewport	ViewportWindow \| null	нет
requestedBackend	ComputeBackendKind \| null	нет

Success payload · move_sheet_to_workbook_bounded

Поле	Тип TypeScript	Обяз.
operation	“move_sheet_to_workbook_bounded”	да
sourceSubsetId	string	да
targetSubsetId	string	да
session	ContractSubsetSessionInfo	да
supportedSubset	string	да
targetDelta	DeltaSummary	да
sourceDelta	DeltaSummary	да
sourceSheet	ContractActiveSheetMeta	да
movedSheet	ContractActiveSheetMeta	да
sourceActiveSheet	ContractActiveSheetMeta	да
sourceSheetCount	number	да
sourceWorkbookSheets	ContractWorkbookSheetMeta[]	да
sourceGeometry	ContractGeometrySubset	да
sourceRecalcNeeded	boolean	да
sourceViewport	ViewportWindow	да
sourcePreviewCells	ContractPreviewCell[]	да
sourceLayoutMetrics	ContractLayoutMetricsSubset \| null	нет
targetActiveSheet	ContractActiveSheetMeta	да
targetSheetCount	number	да
targetWorkbookSheets	ContractWorkbookSheetMeta[]	да
targetGeometry	ContractGeometrySubset	да
targetRecalcNeeded	boolean	да
targetViewport	ViewportWindow	да
targetPreviewCells	ContractPreviewCell[]	да
targetLayoutMetrics	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-шаблон

{
  "operation": "move_sheet_to_workbook_bounded",
  "sourceSubsetId": "<string>",
  "targetSubsetId": "<string>",
  "sourceSheetKey": "<string>",
  "name": "<string>",
  "requestedBackend": "native-desktop"
}