xlsx-kit spec

API reference

Validation & formatting

Data validation rules and conditional formatting.

3 exports · 2 source files

Conditional formatting

src/worksheet/conditional-formatting.ts

# makeCfRule function

src/worksheet/conditional-formatting.ts:113
function makeCfRule(opts: Partial<ConditionalFormattingRule> & { priority: number; type: ConditionalFormattingRuleType }): ConditionalFormattingRule

Parameters

NameTypeDescription
opts Partial<ConditionalFormattingRule> & { priority: number; type: ConditionalFormattingRuleType }

Returns

ConditionalFormattingRule

# makeConditionalFormatting function

src/worksheet/conditional-formatting.ts:101
function makeConditionalFormatting(opts: { pivot?: boolean; rules?: ConditionalFormattingRule[]; sqref: string | MultiCellRange }): ConditionalFormatting

Parameters

NameTypeDescription
opts { pivot?: boolean; rules?: ConditionalFormattingRule[]; sqref: string | MultiCellRange }

Returns

ConditionalFormatting

Data validations

src/worksheet/data-validations.ts

# makeDataValidation function

src/worksheet/data-validations.ts:48
function makeDataValidation(opts: Omit<Partial<DataValidation>, "sqref"> & { sqref: string | MultiCellRange; type: DataValidationType }): DataValidation

Parameters

NameTypeDescription
opts Omit<Partial<DataValidation>, "sqref"> & { sqref: string | MultiCellRange; type: DataValidationType }

Returns

DataValidation