Ordered condition and style applied to a cell range.
Members 4
range
when
style
stopIfTrue Stop evaluating lower-precedence rules for a cell when this rule matches.
Declaration
View full TypeScript declaration
export interface ConditionalFormatRule {
Referenced by
Workspace packages depending on @sheetwrite/core
@sheetwrite/benchdependency@sheetwrite/docs-startdependency@sheetwrite/reactdependency@sheetwrite/sveltedependency@sheetwrite/vuedependency@sheetwrite/xlsxdependency
Public exports naming ConditionalFormatRule
interface Range {
sheet: SheetId;
start: { row: number; col: number };
end: { row: number; col: number };
}interface Range {
sheet: SheetId;
start: { row: number; col: number };
end: { row: number; col: number };
}interface Range {
sheet: SheetId;
start: {
row: number;
col: number;
};
end: {
row: number;
col: number;
};
}Inclusive rectangular cell range on a stable sheet ID.API reference →type ConditionalFormatPredicate =
| { kind: "greaterThan"; value: number }
| { kind: "lessThan"; value: number }
| { kind: "equal"; value: CellScalar }
| { kind: "contains"; text: string; matchCase?: boolean }
| { kind: "formula"; source: string };type ConditionalFormatPredicate =
| { kind: "greaterThan"; value: number }
| { kind: "lessThan"; value: number }
| { kind: "equal"; value: CellScalar }
| { kind: "contains"; text: string; matchCase?: boolean }
| { kind: "formula"; source: string };type ConditionalFormatPredicate =
| {
kind: "greaterThan";
value: number;
}
| {
kind: "lessThan";
value: number;
}
| {
kind: "equal";
value: CellScalar;
}
| {
kind: "contains";
text: string;
matchCase?: boolean;
}
| {
// … 3 more lines — see the API reference
}Predicate used to decide whether a conditional format applies.API reference →interface CellStyle {
bold?: boolean;
italic?: boolean;
underline?: boolean;
strikethrough?: boolean;
fontSize?: number;
color?: string;
backgroundColor?: string;
align?: CellAlign;
wrap?: boolean;
border?: CellBorders;
}interface CellStyle {
bold?: boolean;
italic?: boolean;
underline?: boolean;
strikethrough?: boolean;
fontSize?: number;
color?: string;
backgroundColor?: string;
align?: CellAlign;
wrap?: boolean;
border?: CellBorders;
}interface CellStyle {
bold?: boolean;
italic?: boolean;
underline?: boolean;
strikethrough?: boolean;
fontSize?: number;
color?: string;
backgroundColor?: string;
align?: CellAlign;
wrap?: boolean;
border?: CellBorders;
}Serializable formatting applied to a cell or used as a column default.API reference →