Перейти к содержимому
FastOffice

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

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

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

Запрос

Поле Тип TypeScript Обяз.
operation "advanced_filter_plan" да
subsetId string да
action ContractAdvancedFilterAction да
listRange CellRange да
criteriaRange CellRange | null нет
copyToRange CellRange | null нет
uniqueRecordsOnly boolean нет
requestedBackend ComputeBackendKind | null нет

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

Поле Тип TypeScript Обяз.
operation "advanced_filter_plan" да
matchedRows number[] да
hiddenRows number[] да
projectionCells ContractAdvancedFilterProjectedCell[] да
outputRange CellRange | null нет
sourceRowCount number да
resultRowCount number да
criteriaRowCount number да
uniqueRecordsOnly boolean да
formulaCriteriaUsed boolean да

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

{
"operation": "advanced_filter_plan",
"subsetId": "<subsetId>",
"action": "<ContractAdvancedFilterAction>",
"listRange": "<CellRange>",
"requestedBackend": "native-desktop"
}

Применяет outline subtotal.

Запрос

Поле Тип TypeScript Обяз.
operation "apply_outline_subtotal" да
subsetId string да
range CellRange да
action ContractOutlineSubtotalAction да
axis ContractOutlineAxis | null нет
level number | null нет
subtotal ContractSubtotalOptions | null нет
viewport ViewportWindow | null нет
requestedBackend ComputeBackendKind | null нет

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

Поле Тип TypeScript Обяз.
operation "apply_outline_subtotal" да
subsetId string да
session ContractSubsetSessionInfo да
supportedSubset string да
delta DeltaSummary да
action ContractOutlineSubtotalAction да
didChange boolean да
outlineState ContractOutlineSubtotalState да
layoutMetrics ContractLayoutMetricsSubset да
activeSheet ContractActiveSheetMeta да
geometry ContractGeometrySubset да
recalcNeeded boolean да
viewport ViewportWindow да
previewCells ContractPreviewCell[] да

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

{
"operation": "apply_outline_subtotal",
"subsetId": "<subsetId>",
"range": "<CellRange>",
"action": "<ContractOutlineSubtotalAction>",
"requestedBackend": "native-desktop"
}

Применяет range filter.

Запрос

Поле Тип TypeScript Обяз.
operation "apply_range_filter" да
subsetId string да
range CellRange да
action ContractRangeFilterAction нет
targetColumn number | null нет
criteria ContractRangeFilterColumnCriteria[] нет
headerPolicy ContractRemoveDuplicatesHeaderPolicy нет
viewport ViewportWindow | null нет
requestedBackend ComputeBackendKind | null нет

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

Поле Тип TypeScript Обяз.
operation "apply_range_filter" да
subsetId string да
delta DeltaSummary да
action ContractRangeFilterAction да
criteria ContractRangeFilterColumnCriteria[] да
hiddenRows number[] да
manualHiddenRows number[] да
filterHiddenRows number[] да
hiddenRowCount number да
visibleRowCount number да
workbookHistory ContractWorkbookHistoryProjection да
recalcNeeded boolean да

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

{
"operation": "apply_range_filter",
"subsetId": "<subsetId>",
"range": "<CellRange>",
"requestedBackend": "native-desktop"
}

Фиксирует delimited text import.

Запрос

Поле Тип TypeScript Обяз.
operation "commit_delimited_text_import" да
subsetId string да
edits CellInputEdit[] да
destination ContractDelimitedImportDestination да
expectedRevision number | null нет
readOnly boolean нет
cancelled boolean нет
viewport ViewportWindow | null нет
requestedBackend ComputeBackendKind | null нет

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

Поле Тип TypeScript Обяз.
operation "commit_delimited_text_import" да
subsetId string да
createdSheet boolean да
sheetKey string да
appliedEditCount number да
mutationCount number да
workbookHistory ContractWorkbookHistoryProjection да
projection ComputeResponsePayload да

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

{
"operation": "commit_delimited_text_import",
"subsetId": "<subsetId>",
"edits": [],
"destination": "<ContractDelimitedImportDestination>",
"requestedBackend": "native-desktop"
}

Запрос

Поле Тип TypeScript Обяз. Примечание из контракта
operation "data_cleanup" да
subsetId string да
action ContractDataCleanupAction да
intent 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 | null нет
requestedBackend ComputeBackendKind | null нет

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

Поле Тип TypeScript Обяз.
operation "data_cleanup" да
subsetId string да
session ContractSubsetSessionInfo да
delta DeltaSummary да
kind "text_to_columns" | “remove_duplicates” | “remove_duplicates_copy” да
previewToken string да
applied boolean да
sourceRange CellRange да
outputRange CellRange да
duplicateCount number да
remainingCount number да
headerRowCount number да
resultRowCount number да
resultColCount number да
copyOutput boolean да
duplicateRowSpans ContractDataCleanupRowSpan[] да
audit ContractDataCleanupAudit да
tableName string | null нет
tableRef string | null нет
tableDataBodyRef string | null нет
previewRows ContractDataCleanupPreviewRow[] да
workbookHistory ContractWorkbookHistoryProjection да
changedKeys string[] да
dirtyCellCount number да
activeSheet ContractActiveSheetMeta да
geometry ContractGeometrySubset да
recalcNeeded boolean да
viewport ViewportWindow да
previewCells ContractPreviewCell[] да

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

{
"operation": "data_cleanup",
"subsetId": "<subsetId>",
"action": "<ContractDataCleanupAction>",
"intent": "<ContractDataCleanupIntent>",
"requestedBackend": "native-desktop"
}

Запрос

Поле Тип TypeScript Обяз.
operation “drawing_object_action” да
subsetId string да
action ContractDrawingObjectAction да
expectedRevision number да
readOnly boolean нет
viewport 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 да
activeSheet ContractActiveSheetMeta да
geometry ContractGeometrySubset да
viewport ViewportWindow да
previewCells ContractPreviewCell[] да
surfaceObjects ContractSheetObject[] да
objectInventory ContractWorkbookObjectInventoryEntry[] да
inkProjection ContractReviewInkProjectionItem[] да
layoutMetrics ContractLayoutMetricsSubset нет

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

{
"operation": "drawing_object_action",
"subsetId": "<subsetId>",
"action": "<ContractDrawingObjectAction>",
"expectedRevision": 0
}

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

Поле Тип TypeScript Обяз.
operation “drawing_object_history_replay” да
subsetId string да
direction ContractWorkbookHistoryDirection да
dirty boolean да
workbookHistory ContractWorkbookHistoryProjection да
activeSheet ContractActiveSheetMeta да
geometry ContractGeometrySubset да
viewport ViewportWindow да
previewCells ContractPreviewCell[] да
surfaceObjects ContractSheetObject[] да
objectInventory ContractWorkbookObjectInventoryEntry[] да
inkProjection ContractReviewInkProjectionItem[] да
layoutMetrics ContractLayoutMetricsSubset нет

Вычисляет/оценивает data validation input.

Запрос

Поле Тип TypeScript Обяз. Примечание из контракта
operation "evaluate_data_validation_input" да
subsetId string да
inputs ContractDataValidationRawInput[] да
companionEdits CellInputEdit[] нет
programmaticEdits 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 | null нет
viewport ViewportWindow | null нет
requestedBackend ComputeBackendKind | null нет

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

Поле Тип TypeScript Обяз.
operation "evaluate_data_validation_input" да
subsetId string да
session ContractSubsetSessionInfo да
verdict ContractDataValidationVerdictKind да
verdicts ContractDataValidationVerdict[] да
continuationToken string | null нет
allowedDecisions ContractDataValidationDecision[] нет
committed ComputeResponsePayload | null нет

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

{
"operation": "evaluate_data_validation_input",
"subsetId": "<subsetId>",
"inputs": [],
"requestedBackend": "native-desktop"
}

Запрос

Поле Тип TypeScript Обяз.
operation “external-range-properties-apply” да
subsetId string да
expectedRevision number нет
identity ContractExternalRangeIdentity да
properties ContractExternalRangeProperties да

Ответ при успехе · external-range-properties-apply

Поле Тип TypeScript Обяз.
operation “external-range-properties-apply” да
applied boolean да
reason string нет
detail string нет
workbookHistory ContractWorkbookHistoryProjection нет
ranges ContractExternalRangeEntry[] да

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

{
"operation": "external-range-properties-apply",
"subsetId": "<subsetId>",
"identity": "<ContractExternalRangeIdentity>",
"properties": "<ContractExternalRangeProperties>"
}

Запрос

Поле Тип TypeScript Обяз.
operation “external-range-properties-inventory” да
subsetId string да

Ответ при успехе · external-range-properties-inventory

Поле Тип TypeScript Обяз.
operation “external-range-properties-inventory” да
ranges ContractExternalRangeEntry[] да

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

{
"operation": "external-range-properties-inventory",
"subsetId": "<subsetId>"
}

Завершает object selection pane package.

Запрос

Поле Тип TypeScript Обяз.
operation "finalize_object_selection_pane_package" да
subsetId string да
sourcePackageBytesBase64 string да
candidatePackageBytesBase64 string да
objectProtectionMutations ContractSheetObjectMutationIntent[] да
commands ContractObjectSelectionPanePackageCommand[] да
drawingTextEdits ContractDrawingTextEditSemantics[] да
adoptCurrentSource boolean да
requestedBackend 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-шаблон

{
"operation": "finalize_object_selection_pane_package",
"subsetId": "<subsetId>",
"sourcePackageBytesBase64": "<base64>",
"candidatePackageBytesBase64": "<base64>",
"objectProtectionMutations": [],
"commands": [],
"drawingTextEdits": [],
"adoptCurrentSource": false,
"requestedBackend": "native-desktop"
}

Запрос

Поле Тип TypeScript Обяз.
operation "form_controls" да
subsetId string да
intent ContractFormControlsAction да
viewport ViewportWindow | null нет
requestedBackend ComputeBackendKind | null нет

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

Поле Тип TypeScript Обяз.
operation "form_controls" да
subsetId string да
session ContractSubsetSessionInfo да
delta DeltaSummary да
action string да
status string да
controls ContractFormControlView[] да
objectInventory ContractWorkbookObjectInventoryEntry[] да
linkedCellWrite ContractFormControlLinkedCellWrite | null нет
changedKeys string[] да
dirtyCellCount number да
activeSheet ContractActiveSheetMeta да
geometry ContractGeometrySubset да
recalcNeeded boolean да
viewport ViewportWindow да
previewCells ContractPreviewCell[] да

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

{
"operation": "form_controls",
"subsetId": "<subsetId>",
"intent": "<ContractFormControlsAction>",
"requestedBackend": "native-desktop"
}

Запрос

Поле Тип TypeScript Обяз.
operation “mutate_table_hyperlink_artifacts” да
subsetId string да
action ContractTableHyperlinkAction да
expectedRevision number да
readOnly boolean нет
protected boolean нет
viewport ViewportWindow | null нет

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

Поле Тип TypeScript Обяз.
operation “mutate_table_hyperlink_artifacts” да
subsetId string да
session ContractSubsetSessionInfo да
delta DeltaSummary да
action string да
tableMetadata ContractTableMetadataProjection да
workbookTableMetadata ContractTableMetadataProjection да
hyperlinkMetadata ContractHyperlinkMetadataProjection да
workbookHyperlinkMetadata ContractHyperlinkMetadataProjection да
activeSheet ContractActiveSheetMeta да
geometry ContractGeometrySubset да
recalcNeeded boolean да
viewport ViewportWindow да
previewCells ContractPreviewCell[] да
workbookHistory ContractWorkbookHistoryProjection да

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

{
"operation": "mutate_table_hyperlink_artifacts",
"subsetId": "<subsetId>",
"action": "<ContractTableHyperlinkAction>",
"expectedRevision": 0
}

Изменяет table model.

Запрос

Поле Тип TypeScript Обяз.
operation "mutate_table_model" да
subsetId string да
mutation ContractTableModelMutation да
viewport ViewportWindow | null нет
requestedBackend ComputeBackendKind | null нет

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

Поле Тип TypeScript Обяз.
operation "mutate_table_model" да
subsetId string да
session ContractSubsetSessionInfo да
delta DeltaSummary да
action string да
tableMetadata ContractTableMetadataProjection да
workbookTableMetadata ContractTableMetadataProjection да
activeSheet ContractActiveSheetMeta да
geometry ContractGeometrySubset да
recalcNeeded boolean да
viewport ViewportWindow да
previewCells ContractPreviewCell[] да
workbookHistory ContractWorkbookHistoryProjection да

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

{
"operation": "mutate_table_model",
"subsetId": "<subsetId>",
"mutation": "<ContractTableModelMutation>",
"requestedBackend": "native-desktop"
}

Открывает document object creation.

Запрос

Поле Тип TypeScript Обяз.
operation "open_document_object_creation" да
subsetId string да
sheetPath string да
creation ContractOpenDocumentObjectCreation да
readOnly boolean нет
expectedRevision number | null нет
requestedBackend ComputeBackendKind | null нет

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

Поле Тип TypeScript Обяз.
operation "open_document_object_creation" да
subsetId string да
createdObject ContractCreatedDocumentObject да
byteCount number да
dirty boolean да
undoDepth number да
redoDepth number да
authoritativeRevision number да
historyOwner "drawing_objects" да

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

{
"operation": "open_document_object_creation",
"subsetId": "<subsetId>",
"sheetPath": "<sheetPath>",
"creation": "<ContractOpenDocumentObjectCreation>",
"requestedBackend": "native-desktop"
}

Читает data validation rules.

Запрос

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

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

Поле Тип TypeScript Обяз.
operation "read_data_validation_rules" да
subsetId string да
session ContractSubsetSessionInfo да
sheetKey string да
dataValidationMetadata ContractDataValidationMetadata да

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

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

Устанавливает data validation rules.

Запрос

Поле Тип TypeScript Обяз. Примечание из контракта
operation "set_data_validation_rules" да
subsetId string да
sheetKey string да
rules 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 | null нет

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

Поле Тип TypeScript Обяз.
operation "set_data_validation_rules" да
subsetId string да
session ContractSubsetSessionInfo да
sheetKey string да
appliedRuleCount number да
dataValidationMetadata ContractDataValidationMetadata да
workbookHistory ContractWorkbookHistoryProjection да

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

{
"operation": "set_data_validation_rules",
"subsetId": "<subsetId>",
"sheetKey": "<sheetPath>",
"rules": [],
"requestedBackend": "native-desktop"
}

Устанавливает range filter enabled.

Запрос

Поле Тип TypeScript Обяз. Примечание из контракта
operation "set_range_filter_enabled" да То же, что кнопка «Данные ▸ Фильтр»: включает или снимает автофильтр для выбранной таблицы или листа.
subsetId string да
range CellRange да
enabled boolean да
viewport ViewportWindow | null нет
requestedBackend ComputeBackendKind | null нет

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

Поле Тип TypeScript Обяз.
operation "set_range_filter_enabled" да
subsetId string да
delta DeltaSummary да
autoFilterRef string нет
unhiddenRowCount number да
targetKind "range" | “table” да
tableMetadata ContractTableMetadataProjection да
workbookTableMetadata ContractTableMetadataProjection да
workbookHistory ContractWorkbookHistoryProjection да
recalcNeeded boolean да

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

{
"operation": "set_range_filter_enabled",
"subsetId": "<subsetId>",
"range": "<CellRange>",
"enabled": false,
"requestedBackend": "native-desktop"
}

Запрос

Поле Тип TypeScript Обяз.
operation "slicer_timeline" да
subsetId string да
intent ContractSlicerTimelineAction да
expectedCacheGeneration number | null нет
requestGeneration number | null нет
viewport ViewportWindow | null нет
requestedBackend ComputeBackendKind | null нет

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

Поле Тип TypeScript Обяз.
operation "slicer_timeline" да
subsetId string да
session ContractSubsetSessionInfo да
delta DeltaSummary да
action string да
status string да
controls ContractSlicerTimelineControlView[] да
changedRows number[] да
hiddenRows number[] да
refreshTargets string[] да
connectedTargets ContractSlicerTimelineTargetView[] да
filterConnections ContractPivotFilterConnectionView[] да
refreshStatus ContractPivotRefreshStatusView | null нет
dirtyCellCount number да
activeSheet ContractActiveSheetMeta да
geometry ContractGeometrySubset да
recalcNeeded boolean да
viewport ViewportWindow да
previewCells ContractPreviewCell[] да

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

{
"operation": "slicer_timeline",
"subsetId": "<subsetId>",
"intent": "<ContractSlicerTimelineAction>",
"requestedBackend": "native-desktop"
}

Сортирует filter index update.

Запрос

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

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

Поле Тип TypeScript Обяз.
operation "sort_filter_index_update" да
delta DeltaSummary да
indexVersion number да

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

{
"operation": "sort_filter_index_update",
"subsetId": "<subsetId>",
"range": "<CellRange>",
"requestedBackend": "native-desktop"
}

Запрос

Поле Тип TypeScript Обяз.
operation “sparkline_actions” да
subsetId string да
mode ContractSparklinePlanMode да
action ContractSparklineAction да
expectedRevision number да
readOnly boolean нет
viewport ViewportWindow | null нет

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

Поле Тип TypeScript Обяз.
operation “sparkline_actions” да
subsetId string да
mode ContractSparklinePlanMode да
applied boolean да
dirty boolean да
authoritativeRevision number да
workbookHistory ContractWorkbookHistoryProjection да
projection ContractSparklineProjectionEntry[] да
activeSheet ContractActiveSheetMeta да
geometry ContractGeometrySubset да
viewport ViewportWindow да
previewCells ContractPreviewCell[] да
layoutMetrics ContractLayoutMetricsSubset нет

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

{
"operation": "sparkline_actions",
"subsetId": "<subsetId>",
"mode": "<ContractSparklinePlanMode>",
"action": "<ContractSparklineAction>",
"expectedRevision": 0
}

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

Поле Тип TypeScript Обяз.
operation “sparkline_history_replay” да
subsetId string да
direction ContractWorkbookHistoryDirection да
dirty boolean да
workbookHistory ContractWorkbookHistoryProjection да
projection ContractSparklineProjectionEntry[] да
activeSheet ContractActiveSheetMeta да
geometry ContractGeometrySubset да
viewport ViewportWindow да
previewCells ContractPreviewCell[] да
layoutMetrics ContractLayoutMetricsSubset нет

Обновляет table model.

Запрос

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

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

Поле Тип TypeScript Обяз.
operation "update_table_model" да
subsetId string да
stableId string да
tableCount number да
tableMetadata ContractTableMetadataProjection да
workbookTableMetadata ContractTableMetadataProjection да

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

{
"operation": "update_table_model",
"subsetId": "<subsetId>",
"table": "<ContractTableMetadataEntry>",
"requestedBackend": "native-desktop"
}

Ассистент документации

Ответ собран из документации и может быть неточным — сверяйтесь с источниками.