FRangeConditionalFormattingMixin
| packages | @univerjs/sheets-conditional-formatting |
|---|
APIs
addConditionalFormattingRule
Add a new conditional format
Deprecated use same API in FWorkSheet.
Signature
addConditionalFormattingRule(rule: IConditionFormattingRule): FRangeParameters
rule(IConditionFormattingRule)
Returns
- (
FRange) — Returns the current range instance for method chaining
Tags
@memberof— IFRangeConditionalFormattingMixin
clearConditionalFormatRules
Clear the conditional rules for the range.
Signature
clearConditionalFormatRules(): FRangeReturns
- (
FRange) — Returns the current range instance for method chaining
Tags
@memberof— IFRangeConditionalFormattingMixin
Examples
const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()
const fRange = fWorksheet.getRange('A1:T100')
// Clear all conditional format rules for the range
fRange.clearConditionalFormatRules()
console.log(fRange.getConditionalFormattingRules()) // []createConditionalFormattingRule
Creates a constructor for conditional formatting
Signature
createConditionalFormattingRule(): FConditionalFormattingBuilderReturns
- (
FConditionalFormattingBuilder) — The conditional formatting builder
Examples
const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()
// Create a conditional formatting rule that sets the cell format to italic, red background, and green font color when the cell is not empty.
const fRange = fWorksheet.getRange('A1:T100')
const rule = fRange.createConditionalFormattingRule()
.whenCellNotEmpty()
.setItalic(true)
.setBackground('red')
.setFontColor('green')
.build()
fWorksheet.addConditionalFormattingRule(rule)
console.log(fRange.getConditionalFormattingRules())deleteConditionalFormattingRule
Delete conditional format according to cfId
Deprecated use same API in FWorkSheet.
Signature
deleteConditionalFormattingRule(cfId: string): FRangeParameters
cfId(string)
Returns
- (
FRange) — Returns the current range instance for method chaining
Tags
@memberof— IFRangeConditionalFormattingMixin
getConditionalFormattingRules
Gets all the conditional formatting for the current range.
Signature
getConditionalFormattingRules(): IConditionFormattingRule[]Returns
- (
IConditionFormattingRule[]) — conditional formatting rules for the current range.
Examples
const fWorkbook = univerAPI.getActiveWorkbook()
const fWorksheet = fWorkbook.getActiveSheet()
// Create a conditional formatting rule that sets the cell format to italic, red background, and green font color when the cell is not empty.
const fRange = fWorksheet.getRange('A1:T100')
const rule = fWorksheet.newConditionalFormattingRule()
.whenCellNotEmpty()
.setRanges([fRange.getRange()])
.setItalic(true)
.setBackground('red')
.setFontColor('green')
.build()
fWorksheet.addConditionalFormattingRule(rule)
// Get all the conditional formatting rules for the range F6:H8.
const targetRange = fWorksheet.getRange('F6:H8')
const rules = targetRange.getConditionalFormattingRules()
console.log(rules)moveConditionalFormattingRule
Modify the priority of the conditional format
Deprecated use same API in FWorkSheet.
Signature
moveConditionalFormattingRule(cfId: string, toCfId: string, type?: IAnchor['type'] = 'after'): FRangeParameters
cfId(string) — Rules that need to be movedtoCfId(string) — Target ruletype(IAnchor['type']) — After the default move to the destination rule, if type = before moves to the front, the default value is after
Returns
- (
FRange) — Returns the current range instance for method chaining
Tags
@memberof— FRangeConditionalFormattingMixin
setConditionalFormattingRule
Set the conditional format according to cfId
Deprecated use same API in FWorkSheet.
Signature
setConditionalFormattingRule(cfId: string, rule: IConditionFormattingRule): FRangeParameters
cfId(string)rule(IConditionFormattingRule)
Returns
- (
FRange) — Returns the current range instance for method chaining
Tags
@memberof— IFRangeConditionalFormattingMixin
