Формулы и вычисления

Пересчёт, режимы вычисления, трассировка зависимостей, аудит формул, именованные диапазоны и анализ «что если». Операций на странице: 15.

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

build_lookup_indices
calculate
consolidate_plan
data_analysis_toolpak
defined_name_values
defined_names_lifecycle
delete_defined_name_bounded
evaluate_formula_trace
formula_audit_watch
recalc_frontier
recalculate_used_range_bounded
set_calculation_options
trace_formula_dependencies
upsert_defined_name_bounded
what_if_analysis

build_lookup_indices

Строит lookup indices.

Request

Поле	Тип TypeScript	Обяз.
operation	“build_lookup_indices”	да
subsetId	string	да
ranges	CellRange[]	да
mode	LookupIndexMode	да
requestedBackend	ComputeBackendKind \| null	нет

Success payload · build_lookup_indices

Поле	Тип TypeScript	Обяз.
operation	“build_lookup_indices”	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
supportedSubset	string	да
mode	LookupIndexMode	да
duplicatePolicy	string	да
indexHandles	LookupIndexHandleInfo[]	да

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

{
  "operation": "build_lookup_indices",
  "subsetId": "<subsetId>",
  "ranges": [],
  "mode": "<LookupIndexMode>",
  "requestedBackend": "native-desktop"
}

calculate

Операция calculate.

Request

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

Success payload · calculate

Поле	Тип TypeScript	Обяз.
operation	“calculate”	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
supportedSubset	string	да
scope	ContractCalculationScope	да
formulaTrustSnapshot	ContractFormulaTrustSnapshot \| null	нет
delta	DeltaSummary	да
changedKeys	string[]	да
dirtyCellCount	number	да
completionState	“settled” \| “incomplete”	да
supportedFormulaCount	number	да
settledSupportedFormulaCount	number	да
supportedDirtyCellCount	number	да
supportedUnpublishedCellCount	number	да
boundaryFormulaCount	number	да
startedStatus	ContractCalculationStatus	да
resultStatus	ContractCalculationStatus	да
workbookGeneration	number	да
loadedSheetCountBefore	number	да
loadedSheetCountAfter	number	да
dependencyBoundarySheetCount	number	да
activeSheet	ContractActiveSheetMeta	да
geometry	ContractGeometrySubset	да
recalcNeeded	boolean	да
viewport	ViewportWindow	да
previewCells	ContractPreviewCell[]	да

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

{
  "operation": "calculate",
  "subsetId": "<subsetId>",
  "scope": "<ContractCalculationScope>",
  "requestedBackend": "native-desktop"
}

consolidate_plan

Операция consolidate plan.

Request

Поле	Тип TypeScript	Обяз.
operation	“consolidate_plan”	да
subsetId	string	да
sourceRanges	CellRange[]	да
destination	CellRange	да
function	ContractConsolidateFunction	нет
useTopRowLabels	boolean	нет
useLeftColumnLabels	boolean	нет
createLinks	boolean	нет
expectedRevision	number	нет
viewport	ViewportWindow \| null	нет
requestedBackend	ComputeBackendKind \| null	нет

Success payload · consolidate_plan

Поле	Тип TypeScript	Обяз.
operation	“consolidate_plan”	да
outputRange	CellRange	да
sourceValueCount	number	да
outputCellCount	number	да
function	ContractConsolidateFunction	да
useTopRowLabels	boolean	да
useLeftColumnLabels	boolean	да
createLinks	false	да
mutation	ContractConsolidationMutation	да

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

{
  "operation": "consolidate_plan",
  "subsetId": "<subsetId>",
  "sourceRanges": [],
  "destination": "<CellRange>",
  "requestedBackend": "native-desktop"
}

data_analysis_toolpak

Операция data analysis toolpak.

Request

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

Success payload · data_analysis_toolpak

Поле	Тип TypeScript	Обяз.
operation	“data_analysis_toolpak”	да
subsetId	string	да
targetSubsetId	string	да
session	ContractSubsetSessionInfo	да
delta	DeltaSummary	да
action	“run” \| “undo” \| “redo” \| “cancel”	да
status	string	да
tool	ContractDataAnalysisTool[“tool”] \| null	нет
applied	boolean	да
createdSheet	boolean	да
createdWorkbook	boolean	да
workbookGeneration	number	да
outputRange	CellRange \| null	нет
chartPlan	ContractDataAnalysisChartPlan \| null	нет
changedKeys	string[]	да
activeSheet	ContractActiveSheetMeta	да
geometry	ContractGeometrySubset	да
recalcNeeded	boolean	да
viewport	ViewportWindow	да
previewCells	ContractPreviewCell[]	да

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

{
  "operation": "data_analysis_toolpak",
  "subsetId": "<subsetId>",
  "intent": "<ContractDataAnalysisAction>",
  "requestedBackend": "native-desktop"
}

defined_name_values

Операция defined name values.

Request

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

Success payload · defined_name_values

Поле	Тип TypeScript	Обяз.
operation	“defined_name_values”	да
subsetId	string	да
values	ContractDefinedNameValue[]	да

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

{
  "operation": "defined_name_values",
  "subsetId": "<subsetId>",
  "requestedBackend": "native-desktop"
}

defined_names_lifecycle

Операция defined names lifecycle.

Request

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

Success payload · defined_names_lifecycle

Поле	Тип TypeScript	Обяз.
operation	“defined_names_lifecycle”	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
result	ContractDefinedNamesResult	да
activeSheet	ContractActiveSheetMeta	да
sheetCount	number	да
workbookSheets	ContractWorkbookSheetMeta[]	да
geometry	ContractGeometrySubset	да
recalcNeeded	boolean	да
viewport	ViewportWindow	да
previewCells	ContractPreviewCell[]	да
layoutMetrics	ContractLayoutMetricsSubset	нет

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

{
  "operation": "defined_names_lifecycle",
  "subsetId": "<subsetId>",
  "intent": "<ContractDefinedNamesIntent>",
  "requestedBackend": "native-desktop"
}

delete_defined_name_bounded

Удаляет defined name bounded.

Request

Поле	Тип TypeScript	Обяз.
operation	“delete_defined_name_bounded”	да
subsetId	string	да
name	string	да
scope	“workbook” \| “sheet”	да
scopeSheetKey	string \| null	нет
viewport	ViewportWindow \| null	нет
requestedBackend	ComputeBackendKind \| null	нет

Success payload · delete_defined_name_bounded

Поле	Тип TypeScript	Обяз.
operation	“delete_defined_name_bounded”	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
supportedSubset	string	да
delta	DeltaSummary	да
deletedName	string	да
activeSheet	ContractActiveSheetMeta	да
sheetCount	number	да
workbookSheets	ContractWorkbookSheetMeta[]	да
geometry	ContractGeometrySubset	да
recalcNeeded	boolean	да
viewport	ViewportWindow	да
previewCells	ContractPreviewCell[]	да
layoutMetrics	ContractLayoutMetricsSubset	нет
definedNameDeleteClaim	string	да

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

{
  "operation": "delete_defined_name_bounded",
  "subsetId": "<subsetId>",
  "name": "<string>",
  "scope": "workbook",
  "requestedBackend": "native-desktop"
}

evaluate_formula_trace

Вычисляет/оценивает formula trace.

Request

Поле	Тип TypeScript	Обяз.
operation	“evaluate_formula_trace”	да
subsetId	string	да
action	ContractFormulaEvaluationAction	да
anchorKey	string	нет
traceId	string	нет
expectedWorkbookGeneration	number	нет
activeSheetKey	string	да
requestedBackend	ComputeBackendKind \| null	нет

Success payload · evaluate_formula_trace

Поле	Тип TypeScript	Обяз.
operation	“evaluate_formula_trace”	да
subsetId	string	да
traceId	string \| null	да
requestWorkbookGeneration	number \| null	да
workbookGeneration	number	да
deterministicTraceHash	string	да
anchorKey	string	да
resolvedAnchorKey	string	да
formulaSource	string \| null	да
currentStep	ContractFormulaEvaluationStep \| null	да
stepIndex	number	да
stepCount	number	да
stack	ContractFormulaEvaluationStackFrame[]	да
value	ContractFormulaEvaluationValue	да
trust	ContractFormulaEvaluationTrust	да
referenceTargetKey	string \| null	да
diagnostic	ContractFormulaEvaluationDiagnostic \| null	да
outcome	ContractFormulaEvaluationOutcome	да
actions	ContractFormulaEvaluationActions	да
persistence	ContractFormulaAuditingStatePersistence	нет

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

{
  "operation": "evaluate_formula_trace",
  "subsetId": "<subsetId>",
  "action": "<ContractFormulaEvaluationAction>",
  "activeSheetKey": "<string>",
  "requestedBackend": "native-desktop"
}

formula_audit_watch

Операция formula audit watch.

Request

Поле	Тип TypeScript	Обяз.
operation	“formula_audit_watch”	да
subsetId	string	да
action	ContractFormulaAuditWatchAction	да
expectedWorkbookGeneration	number	да
activeSheetKey	string	да
targetKey	string	нет
findingKind	ContractFormulaAuditFindingKind	нет
requestedBackend	ComputeBackendKind \| null	нет

Success payload · formula_audit_watch

Поле	Тип TypeScript	Обяз.
operation	“formula_audit_watch”	да
subsetId	string	да
requestWorkbookGeneration	number	да
workbookGeneration	number	да
deterministicSnapshotHash	string	да
calculationMode	ContractWorkbookCalculationMode	да
outcome	ContractFormulaAuditOutcome	да
didChange	boolean	да
findings	ContractFormulaAuditFinding[]	да
watches	ContractFormulaAuditWatchRow[]	да
counts	ContractFormulaAuditCounts	да
actions	ContractFormulaAuditActions	да
persistence	ContractFormulaAuditingStatePersistence	нет

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

{
  "operation": "formula_audit_watch",
  "subsetId": "<subsetId>",
  "action": "<ContractFormulaAuditWatchAction>",
  "expectedWorkbookGeneration": 0,
  "activeSheetKey": "<string>",
  "requestedBackend": "native-desktop"
}

recalc_frontier

Пересчитывает frontier.

Request

Поле	Тип TypeScript	Обяз.
operation	“recalc_frontier”	да
subsetId	string	да
frontierKeys	string[]	да
viewport	ViewportWindow \| null	нет
requestedBackend	ComputeBackendKind \| null	нет

Success payload · recalc_frontier

Поле	Тип TypeScript	Обяз.
operation	“recalc_frontier”	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
supportedSubset	string	да
delta	DeltaSummary	да
changedKeys	string[]	да
dirtyCellCount	number	да
activeSheet	ContractActiveSheetMeta	да
geometry	ContractGeometrySubset	да
recalcNeeded	boolean	да
viewport	ViewportWindow	да
previewCells	ContractPreviewCell[]	да

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

{
  "operation": "recalc_frontier",
  "subsetId": "<subsetId>",
  "frontierKeys": [],
  "requestedBackend": "native-desktop"
}

recalculate_used_range_bounded

Пересчитывает used range bounded.

Request

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

Success payload · recalculate_used_range_bounded

Поле	Тип TypeScript	Обяз.
operation	“recalculate_used_range_bounded”	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
supportedSubset	string	да
delta	DeltaSummary	да
changedSheet	ContractActiveSheetMeta	да
previousUsedRange	string	да
usedRange	string	да
activeSheet	ContractActiveSheetMeta	да
sheetCount	number	да
workbookSheets	ContractWorkbookSheetMeta[]	да
geometry	ContractGeometrySubset	да
recalcNeeded	boolean	да
viewport	ViewportWindow	да
previewCells	ContractPreviewCell[]	да
layoutMetrics	ContractLayoutMetricsSubset \| null	нет
workbookHistory	ContractWorkbookHistoryProjection	да
usedRangeRecalculateClaim	“live_verified”	да
usedRangeRecalculateScope	“same_workbook_worksheet_dimension_from_present_cells_and_metadata”	да
usedRangeDirtyCleared	true	да

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

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

set_calculation_options

Устанавливает calculation options.

Request

Поле	Тип TypeScript	Обяз.
operation	“set_calculation_options”	да
subsetId	string	да
calculationMode	Exclude< ContractWorkbookCalculationMode, “unknown” > \| null	нет
recalculateBeforeSave	boolean \| null	нет
iterativeCalculationEnabled	boolean \| null	нет
maximumIterations	number \| null	нет
maximumChange	number \| null	нет
historyAction	ContractCalculationOptionsHistoryAction	нет
expectedWorkbookGeneration	number \| null	нет
viewport	ViewportWindow \| null	нет
requestedBackend	ComputeBackendKind \| null	нет

Success payload · set_calculation_options

Поле	Тип TypeScript	Обяз.
operation	“set_calculation_options”	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
previousCalculationMode	ContractWorkbookCalculationMode	да
calculationMode	ContractWorkbookCalculationMode	да
previousIterativeSettings	ContractIterativeCalculationSettings	да
iterativeSettings	ContractIterativeCalculationSettings	да
recalculateBeforeSave	boolean \| null	нет
historyAction	ContractCalculationOptionsHistoryAction	да
workbookGeneration	number	да
undoAvailable	boolean	да
redoAvailable	boolean	да
optionsChanged	boolean	да
formulaTrustSnapshot	ContractFormulaTrustSnapshot \| null	нет
calculationPerformed	boolean	да
changedKeys	string[]	да
dirtyCellCount	number	да
activeSheet	ContractActiveSheetMeta	да
geometry	ContractGeometrySubset	да
recalcNeeded	boolean	да
viewport	ViewportWindow	да
previewCells	ContractPreviewCell[]	да

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

{
  "operation": "set_calculation_options",
  "subsetId": "<subsetId>",
  "requestedBackend": "native-desktop"
}

trace_formula_dependencies

Трассирует formula dependencies.

Request

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

Success payload · trace_formula_dependencies

Поле	Тип TypeScript	Обяз.
operation	“trace_formula_dependencies”	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
supportedSubset	string	да
anchorKey	string	да
anchorFormula	string \| null	да
anchorStatus	FormulaSubsetStatus	да
directPrecedentKeys	string[]	да
directDependentKeys	string[]	да
unsupportedReferences	string[]	да
graphVersion	number	нет
graphHash	string	нет
maxDepth	number	нет
edges	ContractFormulaTraceEdge[]	нет
precedentTruncated	boolean	нет
dependentTruncated	boolean	нет
cycleGroups	string[][]	нет
missingOrDeletedReferences	string[]	нет
persistence	ContractFormulaAuditingStatePersistence	нет

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

{
  "operation": "trace_formula_dependencies",
  "subsetId": "<subsetId>",
  "anchorKey": "<string>",
  "requestedBackend": "native-desktop"
}

upsert_defined_name_bounded

Создаёт или обновляет defined name bounded.

Request

Поле	Тип TypeScript	Обяз.
operation	“upsert_defined_name_bounded”	да
subsetId	string	да
name	string	да
refersTo	string	да
scope	“workbook” \| “sheet”	да
scopeSheetKey	string \| null	нет
previousName	string \| null	нет
comment	string \| null	нет
viewport	ViewportWindow \| null	нет
requestedBackend	ComputeBackendKind \| null	нет

Success payload · upsert_defined_name_bounded

Поле	Тип TypeScript	Обяз.
operation	“upsert_defined_name_bounded”	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
supportedSubset	string	да
delta	DeltaSummary	да
upsertedName	string	да
refersTo	string	да
activeSheet	ContractActiveSheetMeta	да
sheetCount	number	да
workbookSheets	ContractWorkbookSheetMeta[]	да
geometry	ContractGeometrySubset	да
recalcNeeded	boolean	да
viewport	ViewportWindow	да
previewCells	ContractPreviewCell[]	да
layoutMetrics	ContractLayoutMetricsSubset	нет
definedNameUpsertClaim	string	да

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

{
  "operation": "upsert_defined_name_bounded",
  "subsetId": "<subsetId>",
  "name": "<string>",
  "refersTo": "<string>",
  "scope": "workbook",
  "requestedBackend": "native-desktop"
}

what_if_analysis

Операция what if analysis.

Request

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

Success payload · what_if_analysis

Поле	Тип TypeScript	Обяз.
operation	“what_if_analysis”	да
subsetId	string	да
session	ContractSubsetSessionInfo	да
delta	DeltaSummary	да
action	string	да
status	string	да
previewToken	string \| null	нет
applied	boolean	да
iterations	number	да
solution	number \| null	нет
resultValue	ContractWhatIfValue \| null	нет
tableValues	ContractWhatIfValue[][]	да
scenarios	ContractWhatIfScenarioView[]	да
workbookHistory	ContractWorkbookHistoryProjection	да
changedKeys	string[]	да
dirtyCellCount	number	да
activeSheet	ContractActiveSheetMeta	да
geometry	ContractGeometrySubset	да
recalcNeeded	boolean	да
viewport	ViewportWindow	да
previewCells	ContractPreviewCell[]	да

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

{
  "operation": "what_if_analysis",
  "subsetId": "<subsetId>",
  "intent": "<ContractWhatIfAction>",
  "requestedBackend": "native-desktop"
}