Types: formatting
Compute Contract type definitions — styles, fonts, themes, borders, conditional formatting, rows and columns. Names: 70.
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 — 70
ColumnProfileColumnValueFrequencyContractApplyThemeFontsPatchContractCellStyleDefinitionContractCellStyleFormattingContractCellStyleMutationContractCellStylesManagerActionContractCellStylesManagerAuthorityContractColumnWidthContractConditionalComparisonContractConditionalFormattingManagerActionContractConditionalFormattingManagerAuthorityContractConditionalFormattingOpaqueRuleContractConditionalPopulationKindContractConditionalRangeContractConditionalRankDirectionContractConditionalRuleContractConditionalRuleKindContractConditionalRuleVisualContractConditionalScalarContractDataCleanupPreviewRowContractDataCleanupRowSpanContractDelimitedColumnFormatContractFileFormatContractFormatCapabilitiesContractMergeCellsModeContractNormalStyleFontContractPreviewBorderSideContractPreviewBorderStyleContractPreviewBordersContractPreviewConditionalFillKindContractPreviewConditionalIconContractPreviewFontVerticalAlignContractPreviewFormattingContractPreviewGradientFillContractPreviewPatternFillContractPreviewPatternFillKindContractRangeFilterColumnCriteriaContractRowHeightContractTableColumnMetadataContractTableStyleDefinitionContractTableStyleElementDefinitionContractTableStyleMutationContractTableStyleOptionsContractTableStylesManagerActionContractTableStylesManagerAuthorityContractTableTotalColumnContractTextToColumnsAdvancedOptionsContractTextToColumnsColumnFormatContractXlsxCellFormatPatchContractXlsxColumnOutlineGroupPatchContractXlsxColumnOutlineRangePatchContractXlsxColumnOutlineUngroupPatchContractXlsxDelimitedColumnRulePatchContractXlsxRowOutlineGroupPatchContractXlsxRowOutlineRangePatchContractXlsxRowOutlineUngroupPatchFlashFillCandidateViewFlashFillExampleFlashFillInferenceFlashFillModeFlashFillPreviewCellFlashFillRefusalContextFlashFillTargetRowFlashFillValueFlashFillValueKindMWireTableRowTypeSortRangeRowsDirectionSortRangeRowsLevelSortRangeRowsNumericTextMode
ColumnProfile
Section titled “ColumnProfile”interface ColumnProfile {
name: string;
typeName: ContractPowerQueryCellKind | "mixed" | "null";
nullCount: number;
errorCount: number;
emptyCount: number;
validCount: number;
distinctCount: number;
distinctCapped: boolean;
distribution: ColumnValueFrequency[];
validRatio: number;
errorRatio: number;
emptyRatio: number;}ColumnValueFrequency
Section titled “ColumnValueFrequency”interface ColumnValueFrequency { value: string; kind: ContractPowerQueryCellKind; count: number;}ContractApplyThemeFontsPatch
Section titled “ContractApplyThemeFontsPatch”interface ContractApplyThemeFontsPatch { majorTypeface: string; minorTypeface: string;}ContractCellStyleDefinition
Section titled “ContractCellStyleDefinition”interface ContractCellStyleDefinition { identity: string; name: string; builtIn: boolean; builtinId?: number | null; editable: boolean; deletable: boolean; duplicable: boolean; category: string; formatting: ContractCellStyleFormatting; xfId: number; applicationStyleIndex: number; usageCount: number; opaque: boolean; rawXmlDigest: string;}ContractCellStyleFormatting
Section titled “ContractCellStyleFormatting”type ContractCellStyleFormatting = Omit< ContractPreviewFormatting, "dataBar" | "conditionalIcon" | "conditionalFillKind" >;ContractCellStyleMutation
Section titled “ContractCellStyleMutation”type ContractCellStyleMutation = | { kind: "create"; draftIdentity: string; name: string; basedOnIdentity?: string | null; formatting?: ContractCellStyleFormatting | null; } | { kind: "modify"; identity: string; name: string; formatting: ContractCellStyleFormatting; expectedRawXmlDigest: string; } | { kind: "duplicate"; identity: string; draftIdentity: string; name: string; } | { kind: "delete"; identity: string; expectedRawXmlDigest: string; };ContractCellStylesManagerAction
Section titled “ContractCellStylesManagerAction”type ContractCellStylesManagerAction = | { action: "inspect" } | { action: "commit"; mutations: ContractCellStyleMutation[]; expectedOpaqueStyleIdentities?: string[]; } | { action: "applyStyle"; identity: string; target: CellRange } | { action: "mergeFromWorkbook"; sourceSubsetId: string; identities?: string[]; };ContractCellStylesManagerAuthority
Section titled “ContractCellStylesManagerAuthority”interface ContractCellStylesManagerAuthority { canApply: boolean; readOnly: boolean; protected: boolean; sourceKindLive: boolean; refusalCode?: string | null;}ContractColumnWidth
Section titled “ContractColumnWidth”interface ContractColumnWidth { col: number; width: number;}ContractConditionalComparison
Section titled “ContractConditionalComparison”type ContractConditionalComparison = "greaterThan" | "lessThan" | "equalTo";ContractConditionalFormattingManagerAction
Section titled “ContractConditionalFormattingManagerAction”type ContractConditionalFormattingManagerAction = | { action: "inspect" } | { action: "apply"; rules: ContractConditionalRule[]; expectedOpaqueRuleIdentities?: string[]; };ContractConditionalFormattingManagerAuthority
Section titled “ContractConditionalFormattingManagerAuthority”interface ContractConditionalFormattingManagerAuthority { canApply: boolean; readOnly: boolean; protected: boolean; sourceKindLive: boolean; refusalCode?: string | null;}ContractConditionalFormattingOpaqueRule
Section titled “ContractConditionalFormattingOpaqueRule”interface ContractConditionalFormattingOpaqueRule { identity: string; ruleType: string; priority: number; stopIfTrue: boolean; appliesTo: string; formulas: string[]; rawXmlDigest: string; editable: false; refusalCode: "conditional-formatting-opaque-rule-read-only" | string;}ContractConditionalPopulationKind
Section titled “ContractConditionalPopulationKind”type ContractConditionalPopulationKind = "duplicate" | "unique";ContractConditionalRange
Section titled “ContractConditionalRange”interface ContractConditionalRange { rowStart: number; rowEnd: number; colStart: number; colEnd: number;}ContractConditionalRankDirection
Section titled “ContractConditionalRankDirection”type ContractConditionalRankDirection = "top" | "bottom";ContractConditionalRule
Section titled “ContractConditionalRule”interface ContractConditionalRule { id: string; priority: number; stopIfTrue: boolean; appliesTo: ContractConditionalRange[]; kind: ContractConditionalRuleKind; visual: ContractConditionalRuleVisual; pivotScope?: ContractPivotConditionalRuleScope | null;}ContractConditionalRuleKind
Section titled “ContractConditionalRuleKind”type ContractConditionalRuleKind = | { type: "compare"; operator: ContractConditionalComparison; operand: ContractConditionalScalar; } | { type: "between"; lower: ContractConditionalScalar; upper: ContractConditionalScalar; } | { type: "textContains"; value: string } | { type: "population"; value: ContractConditionalPopulationKind } | { type: "rank"; direction: ContractConditionalRankDirection; amount: number; percent: boolean; } | { type: "average"; above: boolean } | { type: "twoColorScale" } | { type: "threeColorScale" } | { type: "dataBar" } | { type: "iconSet" } | { type: "formula"; value: string };ContractConditionalRuleVisual
Section titled “ContractConditionalRuleVisual”interface ContractConditionalRuleVisual { dxfId?: number | null; fillColor?: string | null; fontColor?: string | null; bold: boolean; dataBarColor?: string | null; colorScaleColors: string[]; iconSet?: string | null;}ContractConditionalScalar
Section titled “ContractConditionalScalar”type ContractConditionalScalar = | { kind: "blank" } | { kind: "emptyString" } | { kind: "number"; value: number } | { kind: "text"; value: string } | { kind: "boolean"; value: boolean } | { kind: "error"; value: string };ContractDataCleanupPreviewRow
Section titled “ContractDataCleanupPreviewRow”interface ContractDataCleanupPreviewRow { sourceRow: number; values: ContractDataCleanupPreviewValue[]; duplicate?: boolean;}ContractDataCleanupRowSpan
Section titled “ContractDataCleanupRowSpan”interface ContractDataCleanupRowSpan { rowStart: number; rowEnd: number;}ContractDelimitedColumnFormat
Section titled “ContractDelimitedColumnFormat”interface ContractDelimitedColumnFormat { sourceIndex: number; format: ContractTextToColumnsColumnFormat;}ContractFileFormat
Section titled “ContractFileFormat”type ContractFileFormat = (typeof CONTRACT_FILE_FORMAT_IDS)[number];ContractFormatCapabilities
Section titled “ContractFormatCapabilities”interface ContractFormatCapabilities { fileFormat: ContractFileFormat; containerFamily: ContractContainerFamily; openCapability: ContractCapabilityLevel; editCapability: ContractCapabilityLevel; saveCapability: ContractSaveCapability; saveKind: ContractSaveKind; fidelityClass: ContractFidelityClass; nonGoals: ContractFormatNonGoal[];}ContractMergeCellsMode
Section titled “ContractMergeCellsMode”type ContractMergeCellsMode = "merge" | "merge-and-center" | "merge-across";ContractNormalStyleFont
Section titled “ContractNormalStyleFont”interface ContractNormalStyleFont { family: string; explicitFamily: string | null; themeScheme: string | null; sizePoints: number; bold: boolean; italic: boolean;}ContractPreviewBorderSide
Section titled “ContractPreviewBorderSide”interface ContractPreviewBorderSide { style: ContractPreviewBorderStyle; color?: string | null;}ContractPreviewBorderStyle
Section titled “ContractPreviewBorderStyle”type ContractPreviewBorderStyle = | "thin" | "hair" | "dotted" | "dashed" | "dashDot" | "dashDotDot" | "medium" | "mediumDashed" | "mediumDashDot" | "mediumDashDotDot" | "slantDashDot" | "thick" | "double";ContractPreviewBorders
Section titled “ContractPreviewBorders”interface ContractPreviewBorders { left?: ContractPreviewBorderSide | null; right?: ContractPreviewBorderSide | null; top?: ContractPreviewBorderSide | null; bottom?: ContractPreviewBorderSide | null; diagonalUp?: ContractPreviewBorderSide | null; diagonalDown?: ContractPreviewBorderSide | null;}ContractPreviewConditionalFillKind
Section titled “ContractPreviewConditionalFillKind”type ContractPreviewConditionalFillKind = "cellIs" | "containsText" | "colorScale";ContractPreviewConditionalIcon
Section titled “ContractPreviewConditionalIcon”interface ContractPreviewConditionalIcon { glyph: string; color: string; label?: string | null;}ContractPreviewFontVerticalAlign
Section titled “ContractPreviewFontVerticalAlign”type ContractPreviewFontVerticalAlign = "baseline" | "superscript" | "subscript";ContractPreviewFormatting
Section titled “ContractPreviewFormatting”interface ContractPreviewFormatting { fillColor?: string | null; gradientFill?: ContractPreviewGradientFill | null; patternFill?: ContractPreviewPatternFill | null; dataBar?: ContractPreviewDataBar | null; conditionalIcon?: ContractPreviewConditionalIcon | null; conditionalFillKind?: ContractPreviewConditionalFillKind | null; numberFormat?: string | null; fontColor?: string | null; fontFamily?: string | null; fontSize?: number | null; bold?: boolean; italic?: boolean; fontVerticalAlign?: ContractPreviewFontVerticalAlign | null; underlineKind?: ContractPreviewUnderlineKind | null; underline?: boolean; strike?: boolean; horizontalAlign?: ContractPreviewHorizontalAlign | null; verticalAlign?: ContractPreviewVerticalAlign | null; wrapText?: boolean; shrinkToFit?: boolean; textRotation?: number | null; indent?: number | null; borders?: ContractPreviewBorders | null; locked?: boolean | null; hidden?: boolean | null;}ContractPreviewGradientFill
Section titled “ContractPreviewGradientFill”interface ContractPreviewGradientFill { degree?: number | null; stops: ContractPreviewGradientStop[];}ContractPreviewPatternFill
Section titled “ContractPreviewPatternFill”interface ContractPreviewPatternFill { kind: ContractPreviewPatternFillKind; fgColor?: string | null; bgColor?: string | null;}ContractPreviewPatternFillKind
Section titled “ContractPreviewPatternFillKind”type ContractPreviewPatternFillKind = | "solid" | "darkGray" | "mediumGray" | "lightGray" | "gray125" | "gray0625" | "darkHorizontal" | "darkVertical" | "darkDown" | "darkUp" | "darkGrid" | "darkTrellis" | "lightHorizontal" | "lightVertical" | "lightDown" | "lightUp" | "lightGrid" | "lightTrellis";ContractRangeFilterColumnCriteria
Section titled “ContractRangeFilterColumnCriteria”type ContractRangeFilterColumnCriteria = { column: number; } & ContractRangeFilterPredicate;ContractRowHeight
Section titled “ContractRowHeight”interface ContractRowHeight { row: number; height: number;}ContractTableColumnMetadata
Section titled “ContractTableColumnMetadata”interface ContractTableColumnMetadata { id: number | null; name: string; dataRange?: string | null; calculatedColumnFormula?: string | null; totalsRowFunction?: string | null; totalsRowFormula?: string | null;}ContractTableStyleDefinition
Section titled “ContractTableStyleDefinition”interface ContractTableStyleDefinition { identity: string; name: string; builtIn: boolean; category: "light" | "medium" | "dark" | "custom" | string; displayOrder: number; isDefault: boolean; supported: boolean; opaque: boolean; editable: boolean; deletable: boolean; duplicable: boolean; appliedTableCount: number; elements: ContractTableStyleElementDefinition[]; rawXmlDigest: string;}ContractTableStyleElementDefinition
Section titled “ContractTableStyleElementDefinition”interface ContractTableStyleElementDefinition { elementType: string; stripeSize?: number | null; dxfId?: number | null; formatting?: ContractCellStyleFormatting | null; opaque: boolean; rawXmlDigest: string;}ContractTableStyleMutation
Section titled “ContractTableStyleMutation”type ContractTableStyleMutation = | { kind: "create"; draftIdentity: string; name: string; basedOnIdentity?: string | null; elements?: ContractTableStyleElementDefinition[] } | { kind: "modify"; identity: string; name: string; elements: ContractTableStyleElementDefinition[]; expectedRawXmlDigest: string } | { kind: "duplicate"; identity: string; draftIdentity: string; name: string } | { kind: "delete"; identity: string; expectedRawXmlDigest: string } | { kind: "setDefault"; identity: string };ContractTableStyleOptions
Section titled “ContractTableStyleOptions”interface ContractTableStyleOptions { showHeaderRow: boolean; showTotalRow: boolean; showFirstColumn: boolean; showLastColumn: boolean; showRowStripes: boolean; showColumnStripes: boolean;}ContractTableStylesManagerAction
Section titled “ContractTableStylesManagerAction”type ContractTableStylesManagerAction = | { action: "inspect"; tableStableId?: string | null } | { action: "commit"; mutations: ContractTableStyleMutation[]; expectedOpaqueStyleIdentities?: string[] } | { action: "applyStyle"; tableStableId: string; identity: string; options: ContractTableStyleOptions };ContractTableStylesManagerAuthority
Section titled “ContractTableStylesManagerAuthority”interface ContractTableStylesManagerAuthority { canApply: boolean; readOnly: boolean; protected: boolean; sourceKindLive: boolean; tableMissing: boolean; refusalCode?: string | null;}ContractTableTotalColumn
Section titled “ContractTableTotalColumn”interface ContractTableTotalColumn { columnName: string; function?: string | null; formula?: string | null; label?: string | null;}ContractTextToColumnsAdvancedOptions
Section titled “ContractTextToColumnsAdvancedOptions”interface ContractTextToColumnsAdvancedOptions { decimalSeparator?: string | null; thousandsSeparator?: string | null;}ContractTextToColumnsColumnFormat
Section titled “ContractTextToColumnsColumnFormat”type ContractTextToColumnsColumnFormat = "general" | "text" | "skip" | "date_mdy" | "date_dmy" | "date_ymd";ContractXlsxCellFormatPatch
Section titled “ContractXlsxCellFormatPatch”interface ContractXlsxCellFormatPatch { activeSheetPath: string; cellRef: string; fillColor?: string | null; patternFill?: ContractPreviewPatternFill | null; fontColor?: string | null; fontFamily?: string | null; fontSize?: number | null; numberFormat?: string | null; bold?: boolean | null; italic?: boolean | null; fontVerticalAlign?: ContractPreviewFontVerticalAlign | null; underline?: boolean | null; strike?: boolean | null; horizontalAlign?: string | null; verticalAlign?: string | null; wrapText?: boolean | null; shrinkToFit?: boolean | null; locked?: boolean | null; hidden?: boolean | null; borders?: ContractPreviewBorders | null; textRotation?: number | null; borderPreset?: string | null; diagonalUp?: boolean | null; diagonalDown?: boolean | null;}ContractXlsxColumnOutlineGroupPatch
Section titled “ContractXlsxColumnOutlineGroupPatch”interface ContractXlsxColumnOutlineGroupPatch { activeSheetPath: string; colStart: number; colEnd: number; outlineLevel?: number | null; hidden?: boolean | null;}ContractXlsxColumnOutlineRangePatch
Section titled “ContractXlsxColumnOutlineRangePatch”interface ContractXlsxColumnOutlineRangePatch { activeSheetPath: string; colStart: number; colEnd: number; outlineLevel?: number | null; hidden?: boolean | null; summaryBelow?: boolean | null; summaryRight?: boolean | null;}ContractXlsxColumnOutlineUngroupPatch
Section titled “ContractXlsxColumnOutlineUngroupPatch”interface ContractXlsxColumnOutlineUngroupPatch { activeSheetPath: string; colStart: number; colEnd: number;}ContractXlsxDelimitedColumnRulePatch
Section titled “ContractXlsxDelimitedColumnRulePatch”interface ContractXlsxDelimitedColumnRulePatch { sourceIndex: number; type: "auto" | "general" | "text" | "date" | "skip"; dateOrder?: "mdy" | "dmy" | "ymd" | null;}ContractXlsxRowOutlineGroupPatch
Section titled “ContractXlsxRowOutlineGroupPatch”interface ContractXlsxRowOutlineGroupPatch { activeSheetPath: string; rowStart: number; rowEnd: number; outlineLevel?: number | null; hidden?: boolean | null;}ContractXlsxRowOutlineRangePatch
Section titled “ContractXlsxRowOutlineRangePatch”interface ContractXlsxRowOutlineRangePatch { activeSheetPath: string; rowStart: number; rowEnd: number; outlineLevel?: number | null; hidden?: boolean | null; summaryBelow?: boolean | null; summaryRight?: boolean | null;}ContractXlsxRowOutlineUngroupPatch
Section titled “ContractXlsxRowOutlineUngroupPatch”interface ContractXlsxRowOutlineUngroupPatch { activeSheetPath: string; rowStart: number; rowEnd: number;}FlashFillCandidateView
Section titled “FlashFillCandidateView”interface FlashFillCandidateView { id: string; label: string; pattern: Record<string, unknown> }FlashFillExample
Section titled “FlashFillExample”interface FlashFillExample { sources: FlashFillValue[]; output: FlashFillValue }FlashFillInference
Section titled “FlashFillInference”interface FlashFillInference { candidates: FlashFillCandidateView[]; selectedCandidateId?: string | null; ambiguous: boolean; previews: FlashFillPreviewCell[]; deterministicHash: string;}FlashFillMode
Section titled “FlashFillMode”type FlashFillMode = "infer" | "preview" | "apply";FlashFillPreviewCell
Section titled “FlashFillPreviewCell”interface FlashFillPreviewCell { sheetKey: string; row: number; col: number; value: FlashFillValue; skipped: boolean;}FlashFillRefusalContext
Section titled “FlashFillRefusalContext”interface FlashFillRefusalContext { readOnly?: boolean; protected?: boolean; tableBoundary?: boolean; spill?: boolean; merged?: boolean; cancelled?: boolean;}FlashFillTargetRow
Section titled “FlashFillTargetRow”interface FlashFillTargetRow { sheetKey: string; row: number; col: number; sources: FlashFillValue[]; targetHasFormula?: boolean; targetIsNonblank?: boolean; filteredOut?: boolean;}FlashFillValue
Section titled “FlashFillValue”interface FlashFillValue { kind: FlashFillValueKind; text: string }FlashFillValueKind
Section titled “FlashFillValueKind”type FlashFillValueKind = | "blank" | "empty-string" | "text" | "number" | "date" | "time" | "error" | "formula";MWireTableRowType
Section titled “MWireTableRowType”interface MWireTableRowType { columns: MWireTypeField[];}SortRangeRowsDirection
Section titled “SortRangeRowsDirection”type SortRangeRowsDirection = "ascending" | "descending";SortRangeRowsLevel
Section titled “SortRangeRowsLevel”interface SortRangeRowsLevel { col: number; direction: SortRangeRowsDirection; customOrder?: string[];}SortRangeRowsNumericTextMode
Section titled “SortRangeRowsNumericTextMode”type SortRangeRowsNumericTextMode = "as_text" | "as_number";