Сеанс и книга
Открытие подмножества книги, сохранение, окно просмотра, восстановление, свойства, сравнение и слияние ревизий. Операций на странице: 17.
Открытие подмножества книги, сохранение, окно просмотра, восстановление, свойства, сравнение и слияние ревизий. Термины — в глоссарии.
Запрос
| Поле | Тип TypeScript | Обяз. |
|---|---|---|
| operation | "open_workbook_subset_from_bytes" |
да |
sourceName |
string | да |
sourceBytesBase64 |
string | да |
| viewport | ViewportWindow | null | нет |
delimitedOpenOptions |
ContractDelimitedOpenOptions | null | нет |
requestedBackend |
ComputeBackendKind | null | нет |
Ответ при успехе · open_workbook_subset
| Поле | Тип TypeScript | Обяз. | Примечание из контракта |
|---|---|---|---|
| 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 | нет | |
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 | нет | Готовность области данных: показывать её можно только после того, как ядро объявило её готовой. |
Минимальный JSON-шаблон
{ "operation": "open_workbook_subset_from_bytes", "sourceName": "book.xlsx", "sourceBytesBase64": "<base64>", "requestedBackend": "native-desktop"}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 | да |
requestedBackend |
ComputeBackendKind | null | нет |
Ответ при успехе · publish_file_open_recovery
| Поле | Тип TypeScript | Обяз. |
|---|---|---|
| operation | "publish_file_open_recovery" |
да |
| publication | ContractFileRecoveryPublication | да |
Минимальный 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»Воспроизводит workbook history.
Запрос
| Поле | Тип TypeScript | Обяз. |
|---|---|---|
| operation | "replay_workbook_history" |
да |
subsetId |
string | да |
| direction | ContractWorkbookHistoryDirection | да |
| viewport | ViewportWindow | null | нет |
requestedBackend |
ComputeBackendKind | null | нет |
Ответ при успехе · replay_workbook_history
| Поле | Тип TypeScript | Обяз. |
|---|---|---|
| operation | "replay_workbook_history" |
да |
subsetId |
string | да |
| session | ContractSubsetSessionInfo | да |
| direction | ContractWorkbookHistoryDirection | да |
historyOwner |
ContractWorkbookHistoryOwner | да |
undoDepth |
number | да |
redoDepth |
number | да |
| revision | number | да |
| replayed | ComputeResponsePayload | да |
Минимальный JSON-шаблон
{ "operation": "replay_workbook_history", "subsetId": "<subsetId>", "direction": "<ContractWorkbookHistoryDirection>", "requestedBackend": "native-desktop"}save_workbook_subset
Заголовок раздела «save_workbook_subset»Сохраняет workbook subset.
Запрос
| Поле | Тип TypeScript | Обяз. |
|---|---|---|
| operation | "save_workbook_subset" |
да |
subsetId |
string | да |
destinationUri |
string | да |
preserveCachedValues |
boolean | да |
delimitedSaveOptions |
ContractDelimitedSaveOptions | null | нет |
xlsxSavePatch |
ContractXlsxSavePatch | null | нет |
requestedBackend |
ComputeBackendKind | null | нет |
Ответ при успехе · save_workbook_subset
| Поле | Тип TypeScript | Обяз. |
|---|---|---|
| operation | "save_workbook_subset" |
да |
subsetId |
string | да |
| session | ContractSubsetSessionInfo | да |
saveRoute |
ContractCurrentSubsetSaveRoute | да |
wroteBytes |
number | да |
recalcNeeded |
boolean | да |
Минимальный 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»Сохраняет workbook subset to bytes.
Запрос
| Поле | Тип TypeScript | Обяз. |
|---|---|---|
| operation | "save_workbook_subset_to_bytes" |
да |
subsetId |
string | да |
saveFormat |
ContractFileFormat | null | нет |
preserveCachedValues |
boolean | да |
delimitedSaveOptions |
ContractDelimitedSaveOptions | null | нет |
requestedBackend |
ComputeBackendKind | null | нет |
Ответ при успехе · save_workbook_subset_to_bytes
| Поле | Тип TypeScript | Обяз. |
|---|---|---|
| operation | "save_workbook_subset_to_bytes" |
да |
subsetId |
string | да |
| session | ContractSubsetSessionInfo | да |
saveRoute |
ContractCurrentSubsetSaveRoute | да |
formulaTrustSnapshot |
ContractFormulaTrustSnapshot | null | нет |
savedFormat |
ContractFileFormat | да |
byteCount |
number | да |
bytesBase64 |
string | да |
recalcNeeded |
boolean | да |
Минимальный JSON-шаблон
{ "operation": "save_workbook_subset_to_bytes", "subsetId": "<subsetId>", "preserveCachedValues": false, "requestedBackend": "native-desktop"}synchronize_workbook_viewport
Заголовок раздела «synchronize_workbook_viewport»Синхронизирует workbook viewport.
Запрос
| Поле | Тип TypeScript | Обяз. | Примечание из контракта |
|---|---|---|---|
| operation | "synchronize_workbook_viewport" |
да | |
subsetId |
string | да | |
sourceUri |
string | да | |
| viewport | ViewportWindow | null | нет | |
recordHistory |
false | да | Изменение вида — не правка пользователя и в историю не попадает. |
expectedReadinessGeneration |
number | null | нет | Опускать поле стоит только в старом коде. Обычный порядок — привязать показ к тому поколению данных, которое вы видели перед запросом. |
requestedBackend |
ComputeBackendKind | null | нет |
Ответ при успехе · synchronize_workbook_viewport
| Поле | Тип TypeScript | Обяз. | Примечание из контракта |
|---|---|---|---|
| operation | "synchronize_workbook_viewport" |
да | |
subsetId |
string | да | |
viewportReadiness |
ContractViewportReadiness | да | |
| projection | OpenWorkbookSubsetProjectionPayload | null | нет | Есть только при state=ready. В ответах об отложенном, отменённом, вытесненном или неудавшемся запросе пустого состояния, выдаваемого за готовые данные, не бывает. |
Минимальный JSON-шаблон
{ "operation": "synchronize_workbook_viewport", "subsetId": "<subsetId>", "sourceUri": "file:///path/book.xlsx", "recordHistory": false, "requestedBackend": "native-desktop"}workbook_accessibility
Заголовок раздела «workbook_accessibility»Запрос
| Поле | Тип TypeScript | Обяз. |
|---|---|---|
| operation | "workbook_accessibility" |
да |
subsetId |
string | да |
requestId |
string | да |
expectedRevision |
number | да |
expectedGeneration |
number | да |
readOnly |
boolean | нет |
| protected | boolean | нет |
| intent | ContractWorkbookAccessibilityIntent | да |
requestedBackend |
ComputeBackendKind | null | нет |
Ответ при успехе · workbook_accessibility
| Поле | Тип TypeScript | Обяз. |
|---|---|---|
| operation | "workbook_accessibility" |
да |
subsetId |
string | да |
| session | ContractSubsetSessionInfo | да |
| result | ContractWorkbookAccessibilityResult | да |
Минимальный JSON-шаблон
{ "operation": "workbook_accessibility", "subsetId": "<subsetId>", "requestId": "<string>", "expectedRevision": 0, "expectedGeneration": 0, "intent": "<ContractWorkbookAccessibilityIntent>", "requestedBackend": "native-desktop"}workbook_links_manager
Заголовок раздела «workbook_links_manager»Запрос
| Поле | Тип TypeScript | Обяз. |
|---|---|---|
| operation | "workbook_links_manager" |
да |
subsetId |
string | да |
| intent | ContractWorkbookLinksIntent | да |
requestedBackend |
ComputeBackendKind | null | нет |
Ответ при успехе · workbook_links_manager
| Поле | Тип TypeScript | Обяз. |
|---|---|---|
| operation | "workbook_links_manager" |
да |
subsetId |
string | да |
| session | ContractSubsetSessionInfo | да |
| result | ContractWorkbookLinksResult | да |
Минимальный JSON-шаблон
{ "operation": "workbook_links_manager", "subsetId": "<subsetId>", "intent": "<ContractWorkbookLinksIntent>", "requestedBackend": "native-desktop"}workbook_window_session_command
Заголовок раздела «workbook_window_session_command»Запрос
| Поле | Тип TypeScript | Обяз. |
|---|---|---|
| operation | "workbook_window_session_command" |
да |
subsetId |
string | да |
| intent | ContractWorkbookWindowSessionAction | да |
requestedBackend |
ComputeBackendKind | null | нет |
Ответ при успехе · workbook_window_session_command
| Поле | Тип TypeScript | Обяз. |
|---|---|---|
| operation | "workbook_window_session_command" |
да |
| projection | ContractWorkbookWindowSessionProjection | да |
Минимальный JSON-шаблон
{ "operation": "workbook_window_session_command", "subsetId": "<subsetId>", "intent": "<ContractWorkbookWindowSessionAction>", "requestedBackend": "native-desktop"}