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

Параметры страницы, разрывы, фон листа и печать листов с диаграммами. Термины — в глоссарии.

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

• apply_sheet_background_patch
• apply_worksheet_page_setup
• compute_page_break_layout
• create_chart_sheet_bounded
• mutate_worksheet_page_breaks
• preview_chart_sheet_print
• set_chart_sheet_print_bounded

apply_sheet_background_patch

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

Запрос

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

Ответ при успехе · 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.

Запрос

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

Ответ при успехе · 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.

Запрос

Поле	Тип TypeScript	Обяз.	Примечание из контракта
operation	"compute_page_break_layout"	да
subsetId	string	да
sheetKey	string	да
usedRowEnd	number	да	Правый нижний угол занятой области, которую должна покрыть разбивка на страницы. Отсчёт с нуля, границы включаются.
usedColEnd	number	да
pageSetup	ContractPageBreakPageSetup	да
manualRowBreaks	number[]	да	Номера строк, перед которыми пользователь поставил разрыв страницы вручную. Отсчёт с нуля.
manualColBreaks	number[]	да	Номера столбцов, перед которыми пользователь поставил разрыв страницы вручную. Отсчёт с нуля.
requestedBackend	ComputeBackendKind | null	нет

Ответ при успехе · 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"
}

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 | null	нет
requestedBackend	ComputeBackendKind | null	нет

Ответ при успехе · 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"
}

mutate_worksheet_page_breaks

В опубликованный выпуск пока не вошла

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

Из типизированного контракта

Поля восстановлены по типам Compute Contract. Текстового описания у этой операции пока нет.

Запрос

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

Ответ при успехе · mutate_worksheet_page_breaks

Поле	Тип TypeScript	Обяз.
operation	“mutate_worksheet_page_breaks”	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
delta	DeltaSummary	да
changedPageBreaks	boolean	да
effectiveScale	number	да
areas	ContractPageBreakAreaProjection[]	да
rowBreaks	ContractPageBreakLine[]	да
colBreaks	ContractPageBreakLine[]	да
pagesAcross	number	да
pagesDown	number	да
pageCount	number	да
workbookHistory	ContractWorkbookHistoryProjection	да
dirtyCellCount	number	да
recalcNeeded	boolean	да
activeSheet	ContractActiveSheetMeta	да
geometry	ContractGeometrySubset	да
viewport	ViewportWindow	да
previewCells	ContractPreviewCell[]	да
layoutMetrics	ContractLayoutMetricsSubset	да

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

{
  "operation": "mutate_worksheet_page_breaks",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetKey>",
  "intent": "<ContractWorksheetPageBreakIntent>",
  "expectedRevision": 0
}

preview_chart_sheet_print

Формирует preview для chart sheet print.

Запрос

Поле	Тип TypeScript	Обяз.
operation	"preview_chart_sheet_print"	да
subsetId	string	да
sheetKey	string	да
requestedBackend	ComputeBackendKind | null	нет

Ответ при успехе · preview_chart_sheet_print

Поле	Тип TypeScript	Обяз.
operation	"preview_chart_sheet_print"	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
delta	DeltaSummary	да
chartSheet	ContractActiveSheetMeta	да
workbookSheets	ContractWorkbookSheetMeta[]	да
settings	ContractChartSheetPrintSettings	да
preview	ContractChartSheetPrintPreview	да
nativeChartsheetClaim	"live_verified"	да
printPreviewClaim	"live_verified"	да
macroSheetParityClaim	"no"	да
dialogSheetParityClaim	"no"	да

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

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

set_chart_sheet_print_bounded

Устанавливает chart sheet print bounded.

Запрос

Поле	Тип TypeScript	Обяз.
operation	"set_chart_sheet_print_bounded"	да
subsetId	string	да
sheetKey	string	да
settings	ContractChartSheetPrintSettings	да
viewport	ViewportWindow | null	нет
requestedBackend	ComputeBackendKind | null	нет

Ответ при успехе · set_chart_sheet_print_bounded

Поле	Тип TypeScript	Обяз.
operation	"set_chart_sheet_print_bounded"	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
delta	DeltaSummary	да
didChange	boolean	да
chartSheet	ContractActiveSheetMeta	да
workbookSheets	ContractWorkbookSheetMeta[]	да
settings	ContractChartSheetPrintSettings	да
preview	ContractChartSheetPrintPreview	да
nativeChartsheetClaim	"live_verified"	да
printPreviewClaim	"live_verified"	да
macroSheetParityClaim	"no"	да
dialogSheetParityClaim	"no"	да

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

{
  "operation": "set_chart_sheet_print_bounded",
  "subsetId": "<subsetId>",
  "sheetKey": "<sheetPath>",
  "settings": "<ContractChartSheetPrintSettings>",
  "requestedBackend": "native-desktop"
}