Types: general and utility
Compute Contract type definitions — everything that doesn't belong to a single topic: transport, refusals, shared enumerations. Names: 171.
Definitions of the names from the “TypeScript type” column on the operation pages.
Other dictionary topics: session, workbook, and sheets · cells and ranges · formulas and calculation · formatting · data and sheet objects · pivot tables · charts and graphics · printing and page layout · Power Query · VBA and macros · protection and review · general and utility.
Types on this page — 171
ComputeBackendKindContractCreatedDocumentObjectContractCurrentSourceSaveReadinessContractCurrentSourceSaveReadinessScopeContractCustomViewApplyTransactionContractCustomViewDefinitionContractCustomViewSnapshotContractCustomViewsIntentContractCustomViewsResultContractCustomViewsStatusContractDataAnalysisActionContractDataAnalysisDestinationContractDataAnalysisRandomDistributionContractDataAnalysisSamplingMethodContractDataAnalysisToolContractDataCleanupActionContractDataCleanupIntentContractDataCleanupPreviewValueContractDelimitedInterpretationContractDelimitedLineEndingContractDelimitedLocaleContractDelimitedOpenDelimiterContractDelimitedOpenLayoutContractDelimitedOpenOptionsContractDelimitedQuotePolicyContractDelimitedSaveDelimiterContractDelimitedSaveEncodingContractDelimitedSaveOptionsContractDirectionPlaceholderKindContractDocumentPropertiesIntentContractDocumentPropertiesResultContractDocumentPropertyMutationContractDocumentPropertyRecordContractDocumentPropertyScopeContractDocumentPropertyStatisticContractDocumentPropertyValueContractEntityConversionDispositionContractEntityConversionRefusalContractEntityConversionRefusalCodeContractEntityDataTypeKindContractEntityFieldValueContractEntityProviderIdentityContractEntityResolutionStateContractErrorCodeContractFidelityClassContractFileRecoveryActionContractFileRecoveryActionKindContractFileRecoveryBoundsContractFileRecoveryDiagnosticContractFileRecoveryDiagnosticCodeContractFileRecoveryModeContractFileRecoveryPlanContractFileRecoveryPlanStatusContractFileRecoveryPublicationContractFileRecoverySeverityContractFormControlInteractionContractFormControlKindContractFormControlViewContractFormControlsActionContractHyperlinkMetadataEntryContractHyperlinkMetadataProjectionContractLegacyNotePayloadContractLegacyNotePayloadSourceContractLinkedPicturePayloadContractNavigationEdgeDirectionContractObjectAnchorContractObjectAnchorKindContractObjectAnchorOriginContractObjectExtentContractObjectFamilyStatusPlaceholderContractObjectPlaceholderFamilyContractObjectPlaceholderPresenceContractObjectPlaceholderScopeContractObjectPlaceholderStatusContractObjectSelectionPaneCommandContractObjectSelectionPanePackageCommandContractOpenDocumentObjectCreationContractParallelRecalcInstrumentationContractParamEdgeContractParamValueReprContractParameterDTOContractParameterKindContractPasteModeContractPersistedParamOptionsBindingContractPreviewDataBarContractPreviewGradientStopContractPreviewHorizontalAlignContractPreviewHyperlinkContractPreviewUnderlineKindContractPreviewValueKindContractPreviewVerticalAlignContractRecalcRequiredReasonContractReplaceEditContractSaveKindContractSmartArtPayloadContractSmartArtRenderStatusContractSourceTrustActionContractSourceTrustAuthorityContractSourceTrustDecisionContractSourceTrustDirectoryIdentityContractSourceTrustDocumentGrantContractSourceTrustFileStateContractSourceTrustGrantBindingContractSourceTrustLocationGrantContractSourceTrustModeContractSourceTrustObservationContractSourceTrustProvenanceContractSourceTrustReasonContractSourceTrustStoreStateContractStructuredReferenceTrustMetadataContractTrustCenterPolicyContractTrustCenterPolicyStateContractWhatIfActionContractWhatIfValueContractWordArtPayloadContractWordArtRenderStatusContractWritingModePlaceholderContractXlsbDirtySaveProfileContractXlsxDataViewStatePatchContractXlsxDataViewStateViewPatchContractXlsxDelimitedDataConnectionDeletePatchContractXlsxDelimitedDataConnectionPatchContractXlsxLegacyNoteMutationPatchContractXlsxSavePatchContractXlsxWorksheetViewPatchFileIdentityDescriptorFileKindDescriptorFileRefreshDescriptorFileSourceDescriptorFoldExplainPlanFoldExplainRemoteFoldExplainRemoteOptionsFoldExplainStageFoldPlacementFolderNavigatorEntryWireFolderNavigatorFileDiagnosticWireFolderNavigatorOutcomeFolderSourceDescriptorFoldingVerdictInspectorAstNodeInspectorBindingInspectorBuiltinRefInspectorDiagnosticInspectorLineageInspectorOutcomeLookupIndexHandleInfoLookupIndexModeMExpressionOutcomeMWireAstNodeMWireDiagnosticMWireErrorMWireFieldMWireFunctionTypeMWireListTypeMWireMetadataFieldMWireMetadataRecordMWirePositionMWireRecordTypeMWireSpanMWireTypeMWireTypeFieldMWireValueMWireValueVariantRequestedBackendFieldSourceGridDescriptorSourceRequestDescriptorStepMutationStepMutationOutcomeStepMutationResultWebSourceResolverEntryWebSourceTestAllowlist
ComputeBackendKind
Section titled “ComputeBackendKind”type ComputeBackendKind = "wasm" | "native-desktop" | "service-host";ContractCreatedDocumentObject
Section titled “ContractCreatedDocumentObject”interface ContractCreatedDocumentObject { stableId: string; nonVisualId: number; sheetPath: string; drawingPath: string; family: "image" | "shape" | "text-box" | "chart" | "pivot-table"; name: string; anchor: ContractObjectAnchor; relationshipId?: string | null;}ContractCurrentSourceSaveReadiness
Section titled “ContractCurrentSourceSaveReadiness”interface ContractCurrentSourceSaveReadiness { scope: ContractCurrentSourceSaveReadinessScope; failureCode?: string | null; failureMessage?: string | null; failureDetails?: string | null;}ContractCurrentSourceSaveReadinessScope
Section titled “ContractCurrentSourceSaveReadinessScope”type ContractCurrentSourceSaveReadinessScope = (typeof CONTRACT_CURRENT_SOURCE_SAVE_READINESS_SCOPE_IDS)[number];ContractCustomViewApplyTransaction
Section titled “ContractCustomViewApplyTransaction”interface ContractCustomViewApplyTransaction { transactionId: string; viewId: string; windowId: string; registryRevision: number; previousWindow?: ContractCustomViewWindowSnapshot; nextWindow: ContractCustomViewWindowSnapshot; sheetStates: ContractCustomViewSheetSnapshot[]; includePrintSettings: boolean; includeHiddenRowCol: boolean; workbookChanged: boolean; contentFingerprintBefore: string; contentFingerprintAfter: string;}ContractCustomViewDefinition
Section titled “ContractCustomViewDefinition”interface ContractCustomViewDefinition { id: string; name: string; includePrintSettings: boolean; includeHiddenRowCol: boolean; snapshot: ContractCustomViewSnapshot;}ContractCustomViewSnapshot
Section titled “ContractCustomViewSnapshot”interface ContractCustomViewSnapshot { window: ContractCustomViewWindowSnapshot; sheets: ContractCustomViewSheetSnapshot[];}ContractCustomViewsIntent
Section titled “ContractCustomViewsIntent”type ContractCustomViewsIntent = | { action: "list"; windowId: string } | { action: "add"; windowId: string; name: string; window: ContractCustomViewWindowSnapshot; includePrintSettings: boolean; includeHiddenRowCol: boolean; expectedRegistryRevision?: number; expectedRevision?: number; readOnly?: boolean; } | { action: "show"; windowId: string; viewId: string; expectedRegistryRevision?: number; expectedRevision?: number; readOnly?: boolean; } | { action: "delete"; windowId: string; viewId: string; expectedRegistryRevision?: number; expectedRevision?: number; readOnly?: boolean; };ContractCustomViewsResult
Section titled “ContractCustomViewsResult”interface ContractCustomViewsResult { status: ContractCustomViewsStatus; registryRevision: number; views: ContractCustomViewDefinition[]; activeViewId?: string; applyTransaction?: ContractCustomViewApplyTransaction; reason?: string; workbookChanged: boolean; workbookHistory?: ContractWorkbookHistoryProjection;}ContractCustomViewsStatus
Section titled “ContractCustomViewsStatus”type ContractCustomViewsStatus = "listed" | "added" | "shown" | "deleted" | "undone" | "redone" | "blocked";ContractDataAnalysisAction
Section titled “ContractDataAnalysisAction”type ContractDataAnalysisAction = | { action: "preview"; analysis: ContractDataAnalysisTool; } | { action: "run"; analysis: ContractDataAnalysisTool; destination: ContractDataAnalysisDestination; } | { action: "undo" } | { action: "redo" } | { action: "cancel" };ContractDataAnalysisDestination
Section titled “ContractDataAnalysisDestination”type ContractDataAnalysisDestination = | { mode: "existing_range"; anchor: CellRange } | { mode: "new_worksheet"; name?: string | null } | { mode: "new_workbook"; name?: string | null };ContractDataAnalysisRandomDistribution
Section titled “ContractDataAnalysisRandomDistribution”type ContractDataAnalysisRandomDistribution = | { distribution: "uniform"; lowerBound: number; upperBound: number } | { distribution: "normal"; mean: number; standardDeviation: number } | { distribution: "bernoulli"; probability: number } | { distribution: "binomial"; numberOfTrials: number; probability: number } | { distribution: "poisson"; lambda: number } | { distribution: "patterned"; fromValue: number; toValue: number; step: number; repeatEach: number; repeatSequence: number; } | { distribution: "discrete"; valueProbabilityRange: CellRange };ContractDataAnalysisSamplingMethod
Section titled “ContractDataAnalysisSamplingMethod”type ContractDataAnalysisSamplingMethod = | { method: "periodic"; period: number } | { method: "random";sampleCount: number };ContractDataAnalysisTool
Section titled “ContractDataAnalysisTool”type ContractDataAnalysisTool = | { tool: "analyze_insights"; inputRange: CellRange; question?: string; insertion?: ContractAnalyzeInsightsInsertion; selectedInsightId?: string | null; locale?: string | null; expectedRevision?: number | null; requestGeneration?: number | null; } | { tool: "forecast_sheet"; timelineRange: CellRange; valuesRange: CellRange; forecastEnd?: string; seasonality?: number; confidenceLevel?: number; dataCompletion?: 0 | 1; aggregation?: number; labels?: boolean; includeStatistics?: boolean; chartType?: "line" | "column"; locale?: string | null; expectedRevision?: number | null; requestGeneration?: number | null; } | { tool: "regression"; yRange: CellRange; xRange: CellRange; labels?: boolean; constantIsZero?: boolean; confidenceLevel?: number; residuals?: boolean; standardizedResiduals?: boolean; predictedValues?: boolean; } | { tool: "descriptive_statistics"; inputRange: CellRange; groupedBy?: ContractDataAnalysisGrouping; labels?: boolean; summaryStatistics?: boolean; confidenceLevelForMean?: number | null; } | { tool: "correlation" | "covariance"; inputRange: CellRange; groupedBy?: ContractDataAnalysisGrouping; labels?: boolean; } | { tool: "histogram"; inputRange: CellRange; binRange: CellRange; labels?: boolean; cumulativePercentage?: boolean; pareto?: boolean; chartOutput?: boolean; } | { tool: "moving_average"; inputRange: CellRange; interval: number; labels?: boolean; standardErrors?: boolean; } | { tool: "anova_single_factor"; inputRange: CellRange; groupedBy?: ContractDataAnalysisGrouping; labels?: boolean; alpha?: number; } | { tool: | "anova_two_factor_without_replication" | "anova_two_factor_with_replication"; inputRange: CellRange; rowsPerSample?: number; labels?: boolean; alpha?: number; } | { tool: | "t_test_paired_two_sample_for_means" | "t_test_two_sample_equal_variances" | "t_test_two_sample_unequal_variances"; variable1Range: CellRange; variable2Range: CellRange; labels?: boolean; hypothesizedMeanDifference?: number; alpha?: number; } | { tool: "z_test_two_sample_for_means"; variable1Range: CellRange; variable2Range: CellRange; knownVariance1: number; knownVariance2: number; labels?: boolean; hypothesizedMeanDifference?: number; alpha?: number; } | { tool: "f_test_two_sample_for_variances"; variable1Range: CellRange; variable2Range: CellRange; labels?: boolean; alpha?: number; } | { tool: "exponential_smoothing"; inputRange: CellRange; groupedBy?: ContractDataAnalysisGrouping; labels?: boolean; dampingFactor: number; standardErrors?: boolean; chartOutput?: boolean; } | { tool: "fourier_analysis"; inputRange: CellRange; labels?: boolean; inverse?: boolean; } | { tool: "random_number_generation"; numberOfVariables: number; numberOfRandomNumbers: number; distribution: ContractDataAnalysisRandomDistribution; randomSeed?: number | null; } | { tool: "rank_and_percentile"; inputRange: CellRange; groupedBy?: ContractDataAnalysisGrouping; labels?: boolean; } | { tool: "sampling"; inputRange: CellRange; labels?: boolean; sampling: ContractDataAnalysisSamplingMethod; };ContractDataCleanupAction
Section titled “ContractDataCleanupAction”type ContractDataCleanupAction = "preview" | "apply";ContractDataCleanupIntent
Section titled “ContractDataCleanupIntent”type ContractDataCleanupIntent = | { kind: "text_to_columns_delimited"; source: CellRange; destinationRow?: number | null; destinationCol?: number | null; delimiter: string; textQualifier?: boolean; columnFormats?: ContractTextToColumnsColumnFormat[]; decimalSeparator?: string | null; thousandsSeparator?: string | null; overwriteDestination?: boolean; } | { kind: "text_to_columns_fixed_width"; source: CellRange; destinationRow?: number | null; destinationCol?: number | null; breakLines: number[]; columnFormats?: ContractTextToColumnsColumnFormat[]; decimalSeparator?: string | null; thousandsSeparator?: string | null; overwriteDestination?: boolean; } | { kind: "text_to_columns_delimited_advanced"; source: CellRange; destinationRow?: number | null; destinationCol?: number | null; delimiter: string; textQualifier?: boolean; columnFormats?: ContractTextToColumnsColumnFormat[]; overwriteDestination?: boolean; advancedOptions: ContractTextToColumnsAdvancedOptions; } | { kind: "text_to_columns_fixed_width_advanced"; source: CellRange; destinationRow?: number | null; destinationCol?: number | null; breakLines: number[]; columnFormats?: ContractTextToColumnsColumnFormat[]; overwriteDestination?: boolean; advancedOptions: ContractTextToColumnsAdvancedOptions; } | { kind: "remove_duplicates"; source: CellRange; headerPolicy?: ContractRemoveDuplicatesHeaderPolicy; keyColumns?: number[]; tableName?: string | null; } | { kind: "remove_duplicates_copy"; source: CellRange; destinationRow: number; destinationCol: number; headerPolicy?: ContractRemoveDuplicatesHeaderPolicy; keyColumns?: number[]; tableName?: string | null; };ContractDataCleanupPreviewValue
Section titled “ContractDataCleanupPreviewValue”interface ContractDataCleanupPreviewValue { kind: "blank" | "empty_string" | "boolean" | "date" | "number" | "error" | "text"; value: string;}ContractDelimitedInterpretation
Section titled “ContractDelimitedInterpretation”type ContractDelimitedInterpretation = (typeof CONTRACT_DELIMITED_INTERPRETATION_IDS)[number];ContractDelimitedLineEnding
Section titled “ContractDelimitedLineEnding”type ContractDelimitedLineEnding = (typeof CONTRACT_DELIMITED_LINE_ENDING_IDS)[number];ContractDelimitedLocale
Section titled “ContractDelimitedLocale”type ContractDelimitedLocale = string;ContractDelimitedOpenDelimiter
Section titled “ContractDelimitedOpenDelimiter”type ContractDelimitedOpenDelimiter = ContractDelimitedSaveDelimiter;ContractDelimitedOpenLayout
Section titled “ContractDelimitedOpenLayout”type ContractDelimitedOpenLayout = (typeof CONTRACT_DELIMITED_OPEN_LAYOUT_IDS)[number];ContractDelimitedOpenOptions
Section titled “ContractDelimitedOpenOptions”interface ContractDelimitedOpenOptions { layout?: ContractDelimitedOpenLayout | null; fixedWidthBreaks?: number[] | null; delimiter?: ContractDelimitedOpenDelimiter | null; customDelimiter?: string | null;
delimiterSet?: string | null; textQualifier?: ContractDelimitedTextQualifier | null; consecutiveDelimitersAsOne?: boolean | null; encoding?: ContractDelimitedSaveEncoding | null; interpretation?: ContractDelimitedInterpretation | null;
locale?: ContractDelimitedLocale | null;
decimalSeparator?: string | null;
thousandsSeparator?: string | null;
columnFormats?: ContractDelimitedColumnFormat[] | null;
startRow?: number | null;}ContractDelimitedQuotePolicy
Section titled “ContractDelimitedQuotePolicy”type ContractDelimitedQuotePolicy = (typeof CONTRACT_DELIMITED_QUOTE_POLICY_IDS)[number];ContractDelimitedSaveDelimiter
Section titled “ContractDelimitedSaveDelimiter”type ContractDelimitedSaveDelimiter = (typeof CONTRACT_DELIMITED_SAVE_DELIMITER_IDS)[number];ContractDelimitedSaveEncoding
Section titled “ContractDelimitedSaveEncoding”type ContractDelimitedSaveEncoding = (typeof CONTRACT_DELIMITED_SAVE_ENCODING_IDS)[number];ContractDelimitedSaveOptions
Section titled “ContractDelimitedSaveOptions”interface ContractDelimitedSaveOptions { delimiter?: ContractDelimitedSaveDelimiter | null; customDelimiter?: string | null; encoding?: ContractDelimitedSaveEncoding | null; quotePolicy?: ContractDelimitedQuotePolicy | null; lineEnding?: ContractDelimitedLineEnding | null;
formattingLossConfirmed?: boolean;}ContractDirectionPlaceholderKind
Section titled “ContractDirectionPlaceholderKind”type ContractDirectionPlaceholderKind = "default-ltr-session-placeholder";ContractDocumentPropertiesIntent
Section titled “ContractDocumentPropertiesIntent”type ContractDocumentPropertiesIntent = | { action: "list" } | { action: "apply"; expectedRevision?: number | null; mutations: ContractDocumentPropertyMutation[]; readOnly?: boolean; protected?: boolean; } | { action: "undo" | "redo"; expectedRevision: number; readOnly?: boolean; protected?: boolean; };ContractDocumentPropertiesResult
Section titled “ContractDocumentPropertiesResult”interface ContractDocumentPropertiesResult { status: "listed" | "applied" | "undone" | "redone" | "unchanged"; didChange: boolean; hasUnsavedSessionEdits: boolean; revision: number; undoAvailable: boolean; redoAvailable: boolean; capability: ContractDocumentPropertiesCapability; reasonCode?: string | null; core: ContractDocumentPropertyRecord[]; extended: ContractDocumentPropertyRecord[]; custom: ContractDocumentPropertyRecord[]; statistics: ContractDocumentPropertyStatistic[];}ContractDocumentPropertyMutation
Section titled “ContractDocumentPropertyMutation”type ContractDocumentPropertyMutation = | { kind: "set_known"; propertyId: string; value: ContractDocumentPropertyValue | null; } | { kind: "upsert_custom"; propertyId?: string | null; name: string; value: Exclude<ContractDocumentPropertyValue, { kind: "opaque" }>; } | { kind: "delete_custom"; propertyId: string };ContractDocumentPropertyRecord
Section titled “ContractDocumentPropertyRecord”interface ContractDocumentPropertyRecord { propertyId: string; scope: ContractDocumentPropertyScope; name: string; editable: boolean; value: ContractDocumentPropertyValue | null;}ContractDocumentPropertyScope
Section titled “ContractDocumentPropertyScope”type ContractDocumentPropertyScope = "core" | "extended" | "custom";ContractDocumentPropertyStatistic
Section titled “ContractDocumentPropertyStatistic”interface ContractDocumentPropertyStatistic { statisticId: string; value: number;}ContractDocumentPropertyValue
Section titled “ContractDocumentPropertyValue”type ContractDocumentPropertyValue = | { kind: "text"; value: string } | { kind: "integer"; decimal: string } | { kind: "real"; value: number } | { kind: "boolean"; value: boolean } | { kind: "date_time"; utc: string } | { kind: "opaque"; typeName: string };ContractEntityConversionDisposition
Section titled “ContractEntityConversionDisposition”type ContractEntityConversionDisposition = "resolved" | "refused";ContractEntityConversionRefusal
Section titled “ContractEntityConversionRefusal”interface ContractEntityConversionRefusal { code: ContractEntityConversionRefusalCode; message: string;}ContractEntityConversionRefusalCode
Section titled “ContractEntityConversionRefusalCode”type ContractEntityConversionRefusalCode = "entity-provider-unavailable";ContractEntityDataTypeKind
Section titled “ContractEntityDataTypeKind”type ContractEntityDataTypeKind = "stocks" | "currencies" | "geography";ContractEntityFieldValue
Section titled “ContractEntityFieldValue”interface ContractEntityFieldValue { fieldId: string; label: string; displayValue: string;}ContractEntityProviderIdentity
Section titled “ContractEntityProviderIdentity”interface ContractEntityProviderIdentity { providerId: string; attribution: string;}ContractEntityResolutionState
Section titled “ContractEntityResolutionState”type ContractEntityResolutionState = "resolved" | "unresolved" | "stale";ContractErrorCode
Section titled “ContractErrorCode”type ContractErrorCode = "DIV0" | "NA" | string;ContractFidelityClass
Section titled “ContractFidelityClass”type ContractFidelityClass = (typeof CONTRACT_FIDELITY_CLASS_IDS)[number];ContractFileRecoveryAction
Section titled “ContractFileRecoveryAction”interface ContractFileRecoveryAction { kind: ContractFileRecoveryActionKind; part: string; relationshipId?: string; message: string;}ContractFileRecoveryActionKind
Section titled “ContractFileRecoveryActionKind”type ContractFileRecoveryActionKind = | "rebuild_content_types" | "synthesize_root_relationships" | "drop_missing_relationship" | "deduplicate_relationships" | "remove_calc_chain" | "synthesize_styles" | "rebuild_shared_strings" | "normalize_sheet_ids" | "repair_worksheet";ContractFileRecoveryBounds
Section titled “ContractFileRecoveryBounds”interface ContractFileRecoveryBounds { maxArchiveBytes: number; maxEntryCount: number; maxPartBytes: number; maxTotalUncompressedBytes: number; maxXmlBytes: number; maxCompressionRatio: number; maxPlanActions: number; maxSheets: number; maxSalvagedCellsPerSheet: number;}ContractFileRecoveryDiagnostic
Section titled “ContractFileRecoveryDiagnostic”interface ContractFileRecoveryDiagnostic { code: ContractFileRecoveryDiagnosticCode; severity: ContractFileRecoverySeverity; part: string; message: string;}ContractFileRecoveryDiagnosticCode
Section titled “ContractFileRecoveryDiagnosticCode”type ContractFileRecoveryDiagnosticCode = | "zip_path_traversal" | "zip_duplicate_entry" | "zip_bomb_limit" | "zip_malformed" | "xml_oversized" | "unsafe_xml_construct" | "macro_or_active_content" | "digital_signature" | "external_relationship" | "ambiguous_topology" | "missing_content_types" | "malformed_content_types" | "missing_root_relationships" | "malformed_relationships" | "duplicate_relationship_id" | "missing_relationship_target" | "duplicate_sheet_id" | "missing_optional_part" | "malformed_optional_part" | "malformed_worksheet" | "salvage_limit" | "no_repair_needed";ContractFileRecoveryMode
Section titled “ContractFileRecoveryMode”type ContractFileRecoveryMode = "repair" | "extract_data";ContractFileRecoveryPlan
Section titled “ContractFileRecoveryPlan”interface ContractFileRecoveryPlan { planId: string; sourceSha256: string; sourceByteCount: number; status: ContractFileRecoveryPlanStatus; canRepair: boolean; canExtractData: boolean; diagnostics: ContractFileRecoveryDiagnostic[]; actions: ContractFileRecoveryAction[]; bounds: ContractFileRecoveryBounds;}ContractFileRecoveryPlanStatus
Section titled “ContractFileRecoveryPlanStatus”type ContractFileRecoveryPlanStatus = "repairable" | "extract_only" | "blocked" | "no_repair_needed";ContractFileRecoveryPublication
Section titled “ContractFileRecoveryPublication”interface ContractFileRecoveryPublication { planId: string; sourceSha256: string; outputSha256: string; outputByteCount: number; outputPath: string; mode: ContractFileRecoveryMode; actionCount: number;}ContractFileRecoverySeverity
Section titled “ContractFileRecoverySeverity”type ContractFileRecoverySeverity = "info" | "warning" | "error" | "blocked";ContractFormControlInteraction
Section titled “ContractFormControlInteraction”type ContractFormControlInteraction = | "toggle" | "select-index" | "increment" | "decrement" | "page-increment" | "page-decrement" | "set-value";ContractFormControlKind
Section titled “ContractFormControlKind”type ContractFormControlKind = | "check-box" | "option-button" | "list-box" | "combo-box" | "spin-button" | "scroll-bar";ContractFormControlView
Section titled “ContractFormControlView”interface ContractFormControlView { stableId: string; sheetKey: string; sheetName: string; kind: ContractFormControlKind; name: string; anchor: ContractObjectAnchor; linkedCell?: string | null; inputRange?: string | null; optionGroup?: string | null; selectedIndex?: number | null; inputCount: number; checked?: boolean | null; value: number; min: number; max: number; step: number; pageStep: number; visible: boolean; locked: boolean; printObject: boolean; revision: number; authored: boolean;}ContractFormControlsAction
Section titled “ContractFormControlsAction”type ContractFormControlsAction = | { action: "list" } | { action: "create"; kind: ContractFormControlKind; sheetKey: string; name: string; anchor: ContractObjectAnchor; linkedCell?: string | null; inputRange?: string | null; optionGroup?: string | null; min?: number; max?: number; step?: number; pageStep?: number; } | { action: "update_properties"; stableId: string; expectedRevision: number; name: string; linkedCell?: string | null; inputRange?: string | null; optionGroup?: string | null; min: number; max: number; step: number; pageStep: number; } | { action: "interact"; stableId: string; expectedRevision: number; interaction: ContractFormControlInteraction; value?: number | null; } | { action: "set_geometry"; stableId: string; expectedRevision: number; anchor: ContractObjectAnchor; } | { action: "set_visibility"; stableId: string; expectedRevision: number; visible: boolean; } | { action: "set_flags"; stableId: string; expectedRevision: number; locked: boolean; printObject: boolean; } | { action: "undo" } | { action: "redo" };ContractHyperlinkMetadataEntry
Section titled “ContractHyperlinkMetadataEntry”interface ContractHyperlinkMetadataEntry { stableId: string; sheetName: string; sheetPath: string; row: number; col: number; target: string; location?: string | null; display?: string | null; tooltip?: string | null; targetMode?: string | null;}ContractHyperlinkMetadataProjection
Section titled “ContractHyperlinkMetadataProjection”interface ContractHyperlinkMetadataProjection { scope: "active-sheet" | "workbook"; source: "rust-authoritative-hyperlink-model"; activeSheetPath: string; hyperlinkCount: number; hyperlinks: ContractHyperlinkMetadataEntry[];}ContractLegacyNotePayload
Section titled “ContractLegacyNotePayload”interface ContractLegacyNotePayload { source: ContractLegacyNotePayloadSource; cellRef: string; annotationId?: string | null; author?: string | null; visible?: boolean | null; text: string; richTextRuns?: ContractCommentRichTextRun[] | null;}ContractLegacyNotePayloadSource
Section titled “ContractLegacyNotePayloadSource”type ContractLegacyNotePayloadSource = "legacy-comments-vml";ContractLinkedPicturePayload
Section titled “ContractLinkedPicturePayload”interface ContractLinkedPicturePayload { sourceRange: string; sourceSheetKey?: string | null; mode?: "bounded-camera-tool" | string | null;}ContractNavigationEdgeDirection
Section titled “ContractNavigationEdgeDirection”type ContractNavigationEdgeDirection = "up" | "down" | "left" | "right";ContractObjectAnchor
Section titled “ContractObjectAnchor”interface ContractObjectAnchor { kind: ContractObjectAnchorKind;
placement?: ContractObjectAnchorKind | null; from?: ContractObjectAnchorCell | null; to?: ContractObjectAnchorCell | null; origin?: ContractObjectAnchorOrigin | null; ext?: ContractObjectExtent | null;
groupRel?: { x: number; y: number; w: number; h: number; xEmu?: number; yEmu?: number; cxEmu?: number; cyEmu?: number; } | null;}ContractObjectAnchorKind
Section titled “ContractObjectAnchorKind”type ContractObjectAnchorKind = "two-cell" | "one-cell" | "absolute";ContractObjectAnchorOrigin
Section titled “ContractObjectAnchorOrigin”interface ContractObjectAnchorOrigin { xEmu: number; yEmu: number;}ContractObjectExtent
Section titled “ContractObjectExtent”interface ContractObjectExtent { cxEmu: number; cyEmu: number;}ContractObjectFamilyStatusPlaceholder
Section titled “ContractObjectFamilyStatusPlaceholder”interface ContractObjectFamilyStatusPlaceholder { family: ContractObjectPlaceholderFamily; presence: ContractObjectPlaceholderPresence; status: ContractObjectPlaceholderStatus;}ContractObjectPlaceholderFamily
Section titled “ContractObjectPlaceholderFamily”type ContractObjectPlaceholderFamily = "comments-notes";ContractObjectPlaceholderPresence
Section titled “ContractObjectPlaceholderPresence”type ContractObjectPlaceholderPresence = "present";ContractObjectPlaceholderScope
Section titled “ContractObjectPlaceholderScope”type ContractObjectPlaceholderScope = "active-sheet";ContractObjectPlaceholderStatus
Section titled “ContractObjectPlaceholderStatus”type ContractObjectPlaceholderStatus = "legacy-vml-preserved-only";ContractObjectSelectionPaneCommand
Section titled “ContractObjectSelectionPaneCommand”type ContractObjectSelectionPaneCommand = | { kind: "rename"; name: string } | { kind: "set-accessibility"; title: string | null; description: string | null; decorative: boolean; } | { kind: "set-visibility"; visible: boolean } | { kind: "set-print-object"; printObject: boolean } | { kind: "set-chart-format"; formatting: ContractChartFormatting } | { kind: "arrange"; action: "front" | "back" | "forward" | "backward" } | { kind: "align"; action: "left" | "center" | "right" | "top" | "middle" | "bottom" } | { kind: "distribute"; action: "horizontally" | "vertically" } | { kind: "group"; groupId: string } | { kind: "ungroup" } | { kind: "regroup" } | { kind: "geometry"; x: number | null; y: number | null; width: number | null; height: number | null; aspectLocked: boolean | null; } | { kind: "rotate"; deltaDeg: number } | { kind: "flip"; action: "horizontal" | "vertical" } | { kind: "crop"; crop: { leftPct: number; topPct: number; rightPct: number; bottomPct: number; }; } | { kind: "fit-picture" } | { kind: "fill-picture" } | { kind: "reset-picture" } | { kind: "replace-picture"; media: { mimeType: "image/png" | "image/jpeg" | "image/gif"; dataBase64: string; byteCount: number; widthPx: number; heightPx: number; sha256: string; }; } | { kind: "delete" } | { kind: "copy-within-workbook"; newStableId: string; newNonVisualId: string; newName: string; rowDelta: number; colDelta: number; };ContractObjectSelectionPanePackageCommand
Section titled “ContractObjectSelectionPanePackageCommand”interface ContractObjectSelectionPanePackageCommand { sheetId: string; objectStableIds: string[]; primaryStableId?: string | null; expectedRevision: number; command: ContractObjectSelectionPaneCommand; geometryAnchor?: ContractObjectAnchor | null; groupId?: string | null; orderedStableIds?: string[]; memberStableIds?: string[];}ContractOpenDocumentObjectCreation
Section titled “ContractOpenDocumentObjectCreation”type ContractOpenDocumentObjectCreation = | { family: "image"; name: string; description?: string; mimeType: "image/png" | "image/jpeg" | "image/gif"; dataBase64: string; sha256: string; linkedSourceRange?: string | null; replacementRange?: ContractOpenDocumentReplacementRange | null; anchor: ContractObjectAnchor; } | { family: "shape"; name: string; preset: "rect" | "roundRect" | "ellipse"; text?: string; fillRgb: string; lineRgb: string; anchor: ContractObjectAnchor; } | { family: "text-box"; name: string; text?: string; fillRgb: string; lineRgb: string; anchor: ContractObjectAnchor; } | { family: "chart"; name: string; title?: string; chartType: "column" | "bar" | "line"; series: ContractOpenDocumentChartSeries[]; anchor: ContractObjectAnchor; } | { family: "geometry-update"; stableId: string; name: string; objectFamily: "image" | "shape" | "text-box" | "chart"; anchor: ContractObjectAnchor; } | { family: "pivot-table"; name: string; ref: string; sourceSheetName: string; sourceTableName: string; sourceRef: string; rowField: string; columnField: string; valueField: string; summaryFunction: "sum"; };ContractParallelRecalcInstrumentation
Section titled “ContractParallelRecalcInstrumentation”interface ContractParallelRecalcInstrumentation { requestedWorkerCount: number; usedWorkerCount: number; readyFrontierCount: number; parallelFrontierCount: number; evaluatedComponentCount: number; parallelComponentCount: number; serializedComponentCount: number; sccComponentCount: number; volatileBoundaryCount: number; dynamicBoundaryCount: number; externalBoundaryCount: number; maximumConcurrentWorkers: number; cancelledFrontierCount: number; supersededFrontierCount: number; scheduleHash: string;}ContractParamEdge
Section titled “ContractParamEdge”interface ContractParamEdge { queryStableId: string; paramId: string;}ContractParamValueRepr
Section titled “ContractParamValueRepr”interface ContractParamValueRepr { kind: ContractParameterKind; canonicalM: string;}ContractParameterDTO
Section titled “ContractParameterDTO”interface ContractParameterDTO { id: string; name: string; kind: ContractParameterKind; currentValue: ContractParamValueRepr; required: boolean; allowedValues?: ContractParamValueRepr[] | null; numericRange?: ContractParameterNumericRange | null;}ContractParameterKind
Section titled “ContractParameterKind”type ContractParameterKind = "text" | "number" | "logical" | "date" | "null";ContractPasteMode
Section titled “ContractPasteMode”type ContractPasteMode = "all" | "values" | "formulas" | "formats";ContractPersistedParamOptionsBinding
Section titled “ContractPersistedParamOptionsBinding”interface ContractPersistedParamOptionsBinding { delimiterParam?: string | null; headerParam?: string | null; rowCountParam?: string | null; filterLiteralParam?: string | null; filterColumn?: string | null;}ContractPreviewDataBar
Section titled “ContractPreviewDataBar”interface ContractPreviewDataBar { color: string; ratio: number;}ContractPreviewGradientStop
Section titled “ContractPreviewGradientStop”interface ContractPreviewGradientStop { position: number; color: string;}ContractPreviewHorizontalAlign
Section titled “ContractPreviewHorizontalAlign”type ContractPreviewHorizontalAlign = | "left" | "center" | "right" | "fill" | "justify" | "centerAcrossSelection" | "distributed";ContractPreviewHyperlink
Section titled “ContractPreviewHyperlink”interface ContractPreviewHyperlink { target: string; location?: string | null; display?: string | null; tooltip?: string | null; targetMode?: string | null;}ContractPreviewUnderlineKind
Section titled “ContractPreviewUnderlineKind”type ContractPreviewUnderlineKind = "single" | "double" | "singleAccounting" | "doubleAccounting";ContractPreviewValueKind
Section titled “ContractPreviewValueKind”type ContractPreviewValueKind = "displayText" | "emptyString" | "boolean" | "error";ContractPreviewVerticalAlign
Section titled “ContractPreviewVerticalAlign”type ContractPreviewVerticalAlign = "top" | "center" | "bottom" | "justify" | "distributed";ContractRecalcRequiredReason
Section titled “ContractRecalcRequiredReason”type ContractRecalcRequiredReason = | "source_cell_changed" | "sheet_lifecycle_changed" | "unsupported_dependency" | "volatile_formula" | "manual_calc_mode" | "imported_cache_without_trust_evidence" | "calc_chain_missing_or_advisory_only" | "external_workbook_not_loaded" | "external_link_missing" | "external_link_policy_blocked" | "external_ref_shape_unsupported" | "external_cached_value_without_freshness_evidence";ContractReplaceEdit
Section titled “ContractReplaceEdit”interface ContractReplaceEdit { cellKey: string; sheetName: string; address: string; oldValue: string; newValue: string;}ContractSaveKind
Section titled “ContractSaveKind”type ContractSaveKind = (typeof CONTRACT_SAVE_KIND_IDS)[number];ContractSmartArtPayload
Section titled “ContractSmartArtPayload”interface ContractSmartArtPayload { status: ContractSmartArtRenderStatus; layout?: string | null; nodes: Array<{ id: string; text: string }>; themeReferences: string[];}ContractSmartArtRenderStatus
Section titled “ContractSmartArtRenderStatus”type ContractSmartArtRenderStatus = "live-supported" | "unsupported-layout" | "broken-topology";ContractSourceTrustAction
Section titled “ContractSourceTrustAction”type ContractSourceTrustAction = | "evaluate_open" | "view" | "edit" | "paste" | "fill" | "refresh" | "macros" | "ole" | "active_x" | "save_original" | "save_copy" | "enable_editing" | "trust_document" | "external_links" | "data_connections";ContractSourceTrustAuthority
Section titled “ContractSourceTrustAuthority”type ContractSourceTrustAuthority = | "none" | "local_source" | "session_grant" | "editing_session" | "trusted_location" | "trusted_document" | "trust_center_policy";ContractSourceTrustDecision
Section titled “ContractSourceTrustDecision”interface ContractSourceTrustDecision { mode: ContractSourceTrustMode; authority: ContractSourceTrustAuthority; reason?: ContractSourceTrustReason; action: ContractSourceTrustAction; allowed: boolean; mutationAllowed: boolean; grant?: ContractSourceTrustGrantBinding; session?: ContractSourceTrustSessionBinding; matchedGrantId?: string; trustStoreState: ContractSourceTrustStoreState; trustStoreRevision: number; trustStoreHash: string; allowedActions: ContractSourceTrustAction[]; blockedActions: ContractSourceTrustAction[]; policy: ContractTrustCenterPolicy; policyState: ContractTrustCenterPolicyState; audit: ContractTrustCenterAuditEntry;}ContractSourceTrustDirectoryIdentity
Section titled “ContractSourceTrustDirectoryIdentity”interface ContractSourceTrustDirectoryIdentity { deviceId: string; fileId: string;}ContractSourceTrustDocumentGrant
Section titled “ContractSourceTrustDocumentGrant”interface ContractSourceTrustDocumentGrant { grantId: string; sourceIdentity: string; byteSha256: string; revisionToken: string;}ContractSourceTrustFileState
Section titled “ContractSourceTrustFileState”type ContractSourceTrustFileState = | "current" | "read_only" | "missing" | "moved" | "symlink" | "corrupt" | "zero_byte" | "stale_revision" | "identity_changed";ContractSourceTrustGrantBinding
Section titled “ContractSourceTrustGrantBinding”interface ContractSourceTrustGrantBinding { sourceIdentity: string; byteSha256: string; revisionToken: string;}ContractSourceTrustLocationGrant
Section titled “ContractSourceTrustLocationGrant”interface ContractSourceTrustLocationGrant { grantId: string; directoryIdentity: ContractSourceTrustDirectoryIdentity; includeSubfolders: boolean;}ContractSourceTrustMode
Section titled “ContractSourceTrustMode”type ContractSourceTrustMode = "trusted_edit" | "protected_view" | "read_only" | "blocked";ContractSourceTrustObservation
Section titled “ContractSourceTrustObservation”interface ContractSourceTrustObservation { sourceIdentity: string; byteSha256: string; revisionToken: string; provenance: ContractSourceTrustProvenance; fileState: ContractSourceTrustFileState; parentDirectories?: ContractSourceTrustDirectoryIdentity[]; locationGrants?: ContractSourceTrustLocationGrant[]; documentGrants?: ContractSourceTrustDocumentGrant[]; trustStoreState?: ContractSourceTrustStoreState; trustStoreRevision?: number; trustStoreHash?: string; policyState?: ContractTrustCenterPolicyState; policy?: ContractTrustCenterPolicy;}ContractSourceTrustProvenance
Section titled “ContractSourceTrustProvenance”type ContractSourceTrustProvenance = "local_trusted" | "downloaded" | "quarantined" | "recovery" | "unknown";ContractSourceTrustReason
Section titled “ContractSourceTrustReason”type ContractSourceTrustReason = | "downloaded_source_untrusted" | "quarantined_source_untrusted" | "recovery_source_requires_trust" | "unknown_source_untrusted" | "explicit_grant_required" | "source_read_only" | "source_missing" | "source_moved" | "source_symlink" | "source_corrupt" | "source_zero_byte" | "source_stale_revision" | "source_identity_changed" | "source_external_replacement_observed" | "grant_source_identity_mismatch" | "grant_byte_hash_mismatch" | "grant_revision_mismatch" | "action_blocked_by_mode" | "trust_policy_malformed" | "trust_policy_permission_denied" | "trust_policy_concurrent_writer" | "trust_policy_stale_response" | "trust_policy_unavailable" | "vba_execution_unavailable" | "active_content_execution_unavailable" | "external_links_policy_blocked" | "data_connections_policy_blocked" | "protected_view_policy_disabled" | "trusted_locations_policy_disabled" | "source_trust_allowed" | "external_links_manual_policy_allowed" | "data_connections_manual_policy_allowed";ContractSourceTrustStoreState
Section titled “ContractSourceTrustStoreState”type ContractSourceTrustStoreState = | "current" | "permission_denied" | "corrupt" | "concurrent_writer" | "stale_response" | "unavailable";ContractStructuredReferenceTrustMetadata
Section titled “ContractStructuredReferenceTrustMetadata”interface ContractStructuredReferenceTrustMetadata { label: string; tableName?: string | null; shape: string; columnName?: string | null; targetSheetKey?: string | null; targetRange?: string | null; resolutionState: string;}ContractTrustCenterPolicy
Section titled “ContractTrustCenterPolicy”interface ContractTrustCenterPolicy { schemaVersion: 1; macroPolicy: ContractTrustCenterMacroPolicy; externalLinksPolicy: ContractTrustCenterExternalPolicy; dataConnectionsPolicy: ContractTrustCenterExternalPolicy; trustedLocationsEnabled: boolean; protectDownloaded: boolean; protectQuarantined: boolean; protectRecovery: boolean; protectUnknown: boolean;}ContractTrustCenterPolicyState
Section titled “ContractTrustCenterPolicyState”type ContractTrustCenterPolicyState = | "current" | "malformed" | "permission_denied" | "concurrent_writer" | "stale_response" | "unavailable";ContractWhatIfAction
Section titled “ContractWhatIfAction”type ContractWhatIfAction = | ({ action: "goal_seek_preview" } & GoalSeekFields) | ({ action: "goal_seek_apply"; previewToken: string } & GoalSeekFields) | { action: "cancel"; previewToken: string } | { action: "scenario_list"; sheetKey: string } | { action: "scenario_merge"; sourceSheetKey: string; targetSheetKey: string; expectedWorkbookRevision?: number | null; readOnly?: boolean; } | { action: "scenario_summary"; sheetKey: string; resultCells?: ContractWhatIfCellRef[]; reportKind?: "summary" | "pivot_table"; reportLocale?: string; expectedWorkbookRevision?: number | null; readOnly?: boolean; } | { action: "scenario_upsert"; sheetKey: string; name: string; comment?: string | null; locked?: boolean; hidden?: boolean; inputs: ContractWhatIfScenarioInput[]; expectedWorkbookRevision?: number | null; readOnly?: boolean; } | { action: "scenario_delete"; sheetKey: string; name: string; expectedWorkbookRevision?: number | null; readOnly?: boolean; } | { action: "scenario_show"; sheetKey: string; name: string; expectedWorkbookRevision?: number | null; readOnly?: boolean; } | ({ action: "data_table_preview" } & DataTableFields) | ({ action: "data_table_apply"; previewToken: string } & DataTableFields);ContractWhatIfValue
Section titled “ContractWhatIfValue”type ContractWhatIfValue = | { kind: "blank" } | { kind: "empty_string" } | { kind: "number"; value: number } | { kind: "text"; value: string } | { kind: "boolean"; value: boolean } | { kind: "error"; value: string };ContractWordArtPayload
Section titled “ContractWordArtPayload”interface ContractWordArtPayload { status: ContractWordArtRenderStatus; textTransform: string; themeReferences: string[];}ContractWordArtRenderStatus
Section titled “ContractWordArtRenderStatus”type ContractWordArtRenderStatus = "live-supported" | "unsupported-transform";ContractWritingModePlaceholder
Section titled “ContractWritingModePlaceholder”type ContractWritingModePlaceholder = "horizontal-tb";ContractXlsbDirtySaveProfile
Section titled “ContractXlsbDirtySaveProfile”type ContractXlsbDirtySaveProfile = (typeof CONTRACT_XLSB_DIRTY_SAVE_PROFILE_IDS)[number];ContractXlsxDataViewStatePatch
Section titled “ContractXlsxDataViewStatePatch”interface ContractXlsxDataViewStatePatch { activeSheetPath: string; activeViewId?: "A" | "B" | "none" | null; views: ContractXlsxDataViewStateViewPatch[]; source?: "fastsheet-data-view-manager-v1" | string | null;}ContractXlsxDataViewStateViewPatch
Section titled “ContractXlsxDataViewStateViewPatch”interface ContractXlsxDataViewStateViewPatch { viewId: "A" | "B"; selectedRangeLabel: string; filterRegion?: string | null; sortKey?: "amount" | "score" | "none" | null; sortDescending?: boolean | null; active?: boolean | null; status?: string | null;}ContractXlsxDelimitedDataConnectionDeletePatch
Section titled “ContractXlsxDelimitedDataConnectionDeletePatch”interface ContractXlsxDelimitedDataConnectionDeletePatch { sourcePath: string; targetSheetPath: string; targetRef?: string | null; targetTableName?: string | null;}ContractXlsxDelimitedDataConnectionPatch
Section titled “ContractXlsxDelimitedDataConnectionPatch”interface ContractXlsxDelimitedDataConnectionPatch { kind?: | "text-csv-connection" | "web-csv-connection" | "database-json-query" | "power-query-transform" | string | null; name?: string | null; sourcePath: string; sourceUri?: string | null; fileName?: string | null; loadKind?: "table" | "connection-only" | string | null; layout?: ContractDelimitedOpenLayout | null; fixedWidthBreaks?: number[] | null; delimiters?: string[] | null; customDelimiter?: string | null; textQualifier?: ContractDelimitedTextQualifier | null; consecutiveDelimitersAsOne?: boolean | null; delimiter?: string | null; encoding?: ContractDelimitedSaveEncoding | null; interpretation?: ContractDelimitedInterpretation | null; locale?: ContractDelimitedLocale | null; decimalSeparator?: string | null; thousandsSeparator?: string | null; columnRules?: ContractXlsxDelimitedColumnRulePatch[] | null; importStartRow?: number | null; header?: "auto" | "present" | "absent" | null; destination?: "selected-anchor" | "new-sheet" | null; destinationAnchor?: string | null; targetSheetPath: string; targetRef: string; targetTableName?: string | null; tablePath?: string | null; startRow: number; startCol: number; rowCount: number; columnCount: number; delimiterLabel?: string | null; query?: string | null; sourceRange?: string | null; transform?: string | null; refreshOnOpen?: boolean | null; importedAt?: string | null; refreshedAt?: string | null; refreshState?: "imported" | "refreshed" | string | null;}ContractXlsxLegacyNoteMutationPatch
Section titled “ContractXlsxLegacyNoteMutationPatch”interface ContractXlsxLegacyNoteMutationPatch { activeSheetPath: string; cellRef: string; action: "upsert" | "delete"; annotationId?: string | null; text?: string | null; author?: string | null; visible?: boolean | null; richTextRuns?: ContractCommentRichTextRun[] | null;}ContractXlsxSavePatch
Section titled “ContractXlsxSavePatch”interface ContractXlsxSavePatch { objectSelectionPaneCommands?: ContractObjectSelectionPanePackageCommand[] | null;
workbookAccessibilityFixes?: ContractWorkbookAccessibilityPackageFix[] | null;
fileSharingReadOnlyRecommended?: boolean | null; dataValidationListRules?: ContractXlsxDataValidationListRulePatch[] | null; dataValidationRules?: ContractXlsxDataValidationRulePatch[] | null; dataValidationClearRules?: ContractXlsxDataValidationClearRulePatch[] | null; dataValidationMessageRules?: ContractXlsxDataValidationMessageRulePatch[] | null; chartCreations?: ContractXlsxChartCreationPatch[] | null; drawingImageCreations?: ContractXlsxDrawingImageCreationPatch[] | null; sheetBackground?: ContractXlsxSheetBackgroundPatch | null; chartObjectMoves?: ContractXlsxChartObjectMovePatch[] | null; drawingObjectMoves?: ContractXlsxDrawingObjectMovePatch[] | null; drawingObjectDeletions?: ContractXlsxDrawingObjectDeletionPatch[] | null; drawingObjectMetadataUpdates?: ContractXlsxDrawingObjectMetadataPatch[] | null; drawingObjectZOrderUpdates?: ContractXlsxDrawingObjectZOrderPatch[] | null; drawingObjectImageTransforms?: ContractXlsxDrawingObjectImageTransformPatch[] | null; drawingObjectGroups?: ContractXlsxDrawingObjectGroupPatch[] | null; drawingObjectUngroups?: ContractXlsxDrawingObjectUngroupPatch[] | null; textBoxSheets?: ContractXlsxTextBoxSheetPatch[] | null; shapeSheets?: ContractXlsxShapeSheetPatch[] | null; chartSeriesUpdates?: ContractXlsxChartSeriesUpdatePatch[] | null; chartMutations?: ContractXlsxChartMutationPatch[] | null; workbookActiveSheets?: ContractXlsxWorkbookActiveSheetPatch[] | null; workbookViewSelections?: ContractXlsxWorkbookViewSelectionPatch[] | null; dataViewStates?: ContractXlsxDataViewStatePatch[] | null; delimitedDataConnections?: ContractXlsxDelimitedDataConnectionPatch[] | null; delimitedDataConnectionDeletes?: ContractXlsxDelimitedDataConnectionDeletePatch[] | null; worksheetViews?: ContractXlsxWorksheetViewPatch[] | null; worksheetPrintOptions?: ContractXlsxWorksheetPrintOptionsPatch[] | null; worksheetPageSetups?: ContractXlsxWorksheetPageSetupPatch[] | null; worksheetHeaderFooters?: ContractXlsxWorksheetHeaderFooterPatch[] | null; worksheetHeaderFooterClears?: ContractXlsxWorksheetHeaderFooterClearPatch[] | null; worksheetPageBreaks?: ContractXlsxWorksheetPageBreakPatch[] | null; worksheetPageBreakResets?: ContractXlsxWorksheetPageBreakResetPatch[] | null; definedNames?: ContractXlsxDefinedNamePatch[] | null; definedNameDeletes?: ContractXlsxDefinedNameDeletePatch[] | null; printAreas?: ContractXlsxPrintAreaPatch[] | null; printAreaClears?: ContractXlsxPrintAreaClearPatch[] | null; printAreaAdds?: ContractXlsxPrintAreaPatch[] | null; printTitles?: ContractXlsxPrintTitlesPatch[] | null; printTitleClears?: ContractXlsxPrintTitlesClearPatch[] | null; workbookTheme?: ContractXlsxWorkbookThemePatch | null; workbookThemeColors?: ContractXlsxWorkbookThemeColorsPatch | null; rowOutlineGroups?: ContractXlsxRowOutlineGroupPatch[] | null; rowOutlineUngroups?: ContractXlsxRowOutlineUngroupPatch[] | null; rowOutlineRanges?: ContractXlsxRowOutlineRangePatch[] | null; columnOutlineGroups?: ContractXlsxColumnOutlineGroupPatch[] | null; columnOutlineUngroups?: ContractXlsxColumnOutlineUngroupPatch[] | null; columnOutlineRanges?: ContractXlsxColumnOutlineRangePatch[] | null; cellShifts?: ContractXlsxCellShiftPatch[] | null; cellCopies?: ContractXlsxCellCopyPatch[] | null; cellFormatPatches?: ContractXlsxCellFormatPatch[] | null; trackTransfers?: ContractXlsxTrackTransferPatch[] | null; sheetFormats?: ContractXlsxSheetFormatPatch[] | null; richTextRunUpdates?: ContractXlsxRichTextRunPatch[] | null; legacyNoteMutations?: ContractXlsxLegacyNoteMutationPatch[] | null; threadedCommentMutations?: ContractXlsxThreadedCommentMutationPatch[] | null; pivotTableCreations?: ContractXlsxPivotTableCreationPatch[] | null; pivotTableDeletions?: ContractXlsxPivotTableDeletionPatch[] | null; pivotTableRefreshes?: ContractXlsxPivotTableRefreshPatch[] | null; pivotTableValueSummaries?: ContractXlsxPivotTableValueSummaryPatch[] | null; pivotTableShowValuesAs?: ContractXlsxPivotTableShowValuesAsPatch[] | null; pivotTableFieldSorts?: ContractXlsxPivotTableFieldSortPatch[] | null; pivotTableFieldFilters?: ContractXlsxPivotTableFieldFilterPatch[] | null; pivotTableClearFilters?: ContractXlsxPivotTableClearFiltersPatch[] | null; pivotTableClearAll?: ContractXlsxPivotTableClearAllPatch[] | null; pivotTableMoves?: ContractXlsxPivotTableMovePatch[] | null; pivotTableFieldRemovals?: ContractXlsxPivotTableFieldRemovalPatch[] | null; pivotTableFieldMoves?: ContractXlsxPivotTableFieldMovePatch[] | null; pivotTableFieldAdditions?: ContractXlsxPivotTableFieldAdditionPatch[] | null; pivotTableValueFieldAdditions?: ContractXlsxPivotTableValueFieldAdditionPatch[] | null; pivotTableCalculatedFields?: ContractXlsxPivotTableCalculatedFieldPatch[] | null; pivotTableItemGroups?: ContractXlsxPivotTableItemGroupPatch[] | null; pivotTableSourceChanges?: ContractXlsxPivotTableSourceChangePatch[] | null; pivotTableItemDetails?: ContractXlsxPivotTableItemDetailPatch[] | null; pivotTableReportLayouts?: ContractXlsxPivotTableReportLayoutPatch[] | null; pivotTableStyles?: ContractXlsxPivotTableStylePatch[] | null; pivotTableFieldSettings?: ContractXlsxPivotTableFieldSettingsPatch[] | null; workbookProtection?: ContractXlsxWorkbookProtectionPatch | null;}ContractXlsxWorksheetViewPatch
Section titled “ContractXlsxWorksheetViewPatch”interface ContractXlsxWorksheetViewPatch { activeSheetPath: string; gridLinesVisible?: boolean | null; headingsVisible?: boolean | null; workbookViewMode?: "normal" | "page-layout" | "page-break-preview" | null; scrollTopLeftCell?: string | null; zoomScale?: number | null; sheetViews?: ContractWorkbookNamedView[] | null; sheetViewActiveId?: string | null; customViews?: ContractWorkbookNamedView[] | null; customViewActiveId?: string | null;}FileIdentityDescriptor
Section titled “FileIdentityDescriptor”interface FileIdentityDescriptor { canonicalPath: string; byteLen: number; contentStamp: string;}FileKindDescriptor
Section titled “FileKindDescriptor”type FileKindDescriptor = "csv" | "workbook";FileRefreshDescriptor
Section titled “FileRefreshDescriptor”interface FileRefreshDescriptor { savedIdentity: FileIdentityDescriptor;}FileSourceDescriptor
Section titled “FileSourceDescriptor”interface FileSourceDescriptor { workbookId: string; queryId: string; fileKind: FileKindDescriptor; pickPath: string; selector?: WorkbookSelectorDescriptor; maxBytes?: number; expectedIdentity?: FileIdentityDescriptor; refresh?: FileRefreshDescriptor; revoked?: boolean;}FoldExplainPlan
Section titled “FoldExplainPlan”interface FoldExplainPlan { stages: FoldExplainStage[];
foldBoundaryIndex: number;
remote?: FoldExplainRemote;
planHash: string;
nativeSql?: string;}FoldExplainRemote
Section titled “FoldExplainRemote”interface FoldExplainRemote { transport: "odata"; options: FoldExplainRemoteOptions;}FoldExplainRemoteOptions
Section titled “FoldExplainRemoteOptions”interface FoldExplainRemoteOptions { select?: string; filter?: string; orderby?: string; top?: number; skip?: number;}FoldExplainStage
Section titled “FoldExplainStage”interface FoldExplainStage { op: string; placement: FoldPlacement;
reason?: string;
detail: string;}FoldPlacement
Section titled “FoldPlacement”type FoldPlacement = "folded" | "local-remainder" | "blocked";FolderNavigatorEntryWire
Section titled “FolderNavigatorEntryWire”interface FolderNavigatorEntryWire { id: string; name: string; extension: string; size: number; fingerprint: number;}FolderNavigatorFileDiagnosticWire
Section titled “FolderNavigatorFileDiagnosticWire”interface FolderNavigatorFileDiagnosticWire { file_id: string; reason_code: string;}FolderNavigatorOutcome
Section titled “FolderNavigatorOutcome”type FolderNavigatorOutcome = | { status: "entries"; entries: FolderNavigatorEntryWire[] } | { status: "preview"; table: Extract< ContractPowerQueryTransformOutcome, { status: "evaluated" } >; } | { status: "combined"; table: Extract< ContractPowerQueryTransformOutcome, { status: "evaluated" } >; diagnostics: FolderNavigatorFileDiagnosticWire[]; } | { status: "refresh_plan"; added: string[]; changed: string[]; deleted: string[]; restored: string[]; unchanged_count: number; lineage_json: string; digest: number; } | { status: "package_ledger_digest"; digest: number } | { status: "blocked"; reason: string; detail: string };FolderSourceDescriptor
Section titled “FolderSourceDescriptor”interface FolderSourceDescriptor { workbookId: string; queryId: string; rootPath: string; includeGlob?: string; excludeGlob?: string; recursive?: boolean; maxFiles?: number; maxTotalBytes?: number; revoked?: boolean;}FoldingVerdict
Section titled “FoldingVerdict”interface FoldingVerdict { state: "folded" | "partially-folded" | "local"; viewNativeQueryEnabled: boolean; nativeQuery?: FoldingNativeQuery;}InspectorAstNode
Section titled “InspectorAstNode”interface InspectorAstNode { nodeId: number; kind: string; detail?: string; span: MWireSpan; sourceSlice: string; children: InspectorAstNode[];}InspectorBinding
Section titled “InspectorBinding”interface InspectorBinding { name: string; span: MWireSpan;
scopeDepth: number;
shadowsOuter: boolean;
isClosureCaptured: boolean;
references: string[];
kind: string;}InspectorBuiltinRef
Section titled “InspectorBuiltinRef”interface InspectorBuiltinRef { name: string; isRegistered: boolean;
migrationClass: string;}InspectorDiagnostic
Section titled “InspectorDiagnostic”interface InspectorDiagnostic { phase: string; severity: string; code: string; message: string; span: MWireSpan;
astNodeId?: number;}InspectorLineage
Section titled “InspectorLineage”interface InspectorLineage { referencedBuiltins: InspectorBuiltinRef[];
referencedIdentifiers: string[];
capability: string;}InspectorOutcome
Section titled “InspectorOutcome”interface InspectorOutcome {
status: string; value?: MWireValue; error?: MWireError;
valueKind?: string;}LookupIndexHandleInfo
Section titled “LookupIndexHandleInfo”interface LookupIndexHandleInfo { handle: number; mode: LookupIndexMode; range: CellRange; rowCount: number; colCount: number;}LookupIndexMode
Section titled “LookupIndexMode”type LookupIndexMode = "table-first-column" | "one-dimensional-scan";MExpressionOutcome
Section titled “MExpressionOutcome”type MExpressionOutcome = | { status: "ok"; value: MWireValue; diagnostics: MWireDiagnostic[]; ast?: MWireAstNode; } | { status: "diagnostics"; diagnostics: MWireDiagnostic[]; ast?: MWireAstNode; } | { status: "eval-error"; error: MWireError; diagnostics: MWireDiagnostic[]; ast?: MWireAstNode; };MWireAstNode
Section titled “MWireAstNode”interface MWireAstNode { kind: string; detail?: string; span: MWireSpan; children: MWireAstNode[];}MWireDiagnostic
Section titled “MWireDiagnostic”interface MWireDiagnostic { phase: "lex" | "parse" | "bind" | "eval"; severity: "error" | "warning"; code: string; message: string; span: MWireSpan;}MWireError
Section titled “MWireError”interface MWireError { reason: string; message: string; span: MWireSpan;}MWireField
Section titled “MWireField”interface MWireField { name: string; value: MWireValue;}MWireFunctionType
Section titled “MWireFunctionType”interface MWireFunctionType { required: MWireType[]; optional: MWireType[]; returns: MWireType;}MWireListType
Section titled “MWireListType”interface MWireListType { item: MWireType;}MWireMetadataField
Section titled “MWireMetadataField”interface MWireMetadataField { name: string; value: MWireValue;}MWireMetadataRecord
Section titled “MWireMetadataRecord”interface MWireMetadataRecord { fields: MWireMetadataField[];}MWirePosition
Section titled “MWirePosition”interface MWirePosition { line: number; column: number;}MWireRecordType
Section titled “MWireRecordType”interface MWireRecordType { fields: MWireTypeField[]; open: boolean;}MWireSpan
Section titled “MWireSpan”interface MWireSpan { startByte: number; endByte: number; start: MWirePosition; end: MWirePosition;}MWireType
Section titled “MWireType”interface MWireType { kind: "type"; name: MWireTypeName; nullable: boolean; display: string;
record?: MWireRecordType;
table?: MWireTableRowType;
function?: MWireFunctionType;
list?: MWireListType;}MWireTypeField
Section titled “MWireTypeField”interface MWireTypeField { name: string; optional: boolean; type: MWireType;}MWireValue
Section titled “MWireValue”type MWireValue = MWireValueVariant & { meta?: MWireMetadataRecord; };MWireValueVariant
Section titled “MWireValueVariant”type MWireValueVariant = | { kind: "null" } | { kind: "logical"; value: boolean } | { kind: "number"; value: string; isInteger: boolean } | { kind: "text"; value: string } | { kind: "list"; items: MWireValue[] } | { kind: "record"; fields: MWireField[] } | { kind: "function"; builtinName?: string; isClosure: boolean } | { kind: "error"; reason: string; message: string; span: MWireSpan } | { kind: "table"; columns: string[]; rows: MWireValue[][]; schema: MWireTableSchema; } | MWireType | { kind: "integer"; value: string } | { kind: "date"; year: number; month: number; day: number } | { kind: "datetime"; year: number; month: number; day: number; hour: number; minute: number; second: number; nano: number; } | { kind: "datetimezone"; year: number; month: number; day: number; hour: number; minute: number; second: number; nano: number; offsetMinutes: number; } | { kind: "time"; hour: number; minute: number; second: number; nano: number } | { kind: "duration"; negative: boolean; days: number; hours: number; minutes: number; seconds: number; nano: number; } | { kind: "binary"; byteLength: number; base64: string };RequestedBackendField
Section titled “RequestedBackendField”interface RequestedBackendField { requestedBackend?: ComputeBackendKind | null;}SourceGridDescriptor
Section titled “SourceGridDescriptor”interface SourceGridDescriptor { rows: SourceCellDescriptor[][];}SourceRequestDescriptor
Section titled “SourceRequestDescriptor”interface SourceRequestDescriptor { sheetName: string; sheetExists: boolean; rangeRows: number; rangeColumns: number; promoteHeaders: boolean;}StepMutation
Section titled “StepMutation”type StepMutation = | { kind: "insert"; afterStepId?: string; displayName: string; canonicalM: string; } | { kind: "edit"; stepId: string; canonicalM: string; } | { kind: "delete"; stepId: string; } | { kind: "rename"; stepId: string; newName: string; } | { kind: "reorder"; stepId: string; targetIndex: number; };StepMutationOutcome
Section titled “StepMutationOutcome”interface StepMutationOutcome {
status: "ok" | "blocked";
steps: AppliedStep[];
selectedStepId?: string;
reason?: string;
detail?: string;}StepMutationResult
Section titled “StepMutationResult”interface StepMutationResult {
projection: AppliedStepsProjection;
outcome: StepMutationOutcome;}WebSourceResolverEntry
Section titled “WebSourceResolverEntry”interface WebSourceResolverEntry { host: string; ips: string[];}WebSourceTestAllowlist
Section titled “WebSourceTestAllowlist”interface WebSourceTestAllowlist { allowHttp?: boolean; extraAllowedHosts?: string[]; extraAllowedPorts?: number[]; resolver?: WebSourceResolverEntry[];}