| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Codec.Xlsx.Types.ConditionalFormatting
- type ConditionalFormatting = [CfRule]
- data CfRule = CfRule {}
- data Condition
- data OperatorExpression
- data TimePeriod
- cfrCondition :: Lens' CfRule Condition
- cfrDxfId :: Lens' CfRule (Maybe Int)
- cfrPriority :: Lens' CfRule Int
- cfrStopIfTrue :: Lens' CfRule (Maybe Bool)
- topCfPriority :: Int
Documentation
type ConditionalFormatting = [CfRule] Source #
This collection represents a description of a conditional formatting rule.
See 18.3.1.10 "cfRule (Conditional Formatting Rule)" (p. 1602)
Constructors
| CfRule | |
Fields
| |
Conditions which could be used for conditional formatting
See 18.18.12 "ST_CfType (Conditional Format Type)" (p. 2443)
Constructors
| BeginsWith Text | This conditional formatting rule highlights cells in the range that begin with the given text. Equivalent to using the LEFT() sheet function and comparing values. |
| CellIs OperatorExpression | This conditional formatting rule compares a cell value to a formula calculated result, using an operator. |
| ContainsBlanks | This conditional formatting rule highlights cells that are completely blank. Equivalent of using LEN(TRIM()). This means that if the cell contains only characters that TRIM() would remove, then it is considered blank. An empty cell is also considered blank. |
| ContainsErrors | This conditional formatting rule highlights cells with formula errors. Equivalent to using ISERROR() sheet function to determine if there is a formula error. |
| ContainsText Text | This conditional formatting rule highlights cells containing given text. Equivalent to using the SEARCH() sheet function to determine whether the cell contains the text. |
| DoesNotContainErrors | This conditional formatting rule highlights cells without formula errors. Equivalent to using ISERROR() sheet function to determine if there is a formula error. |
| DoesNotContainBlanks | This conditional formatting rule highlights cells that are not blank. Equivalent of using LEN(TRIM()). This means that if the cell contains only characters that TRIM() would remove, then it is considered blank. An empty cell is also considered blank. |
| DoesNotContainText Text | This conditional formatting rule highlights cells that do not contain given text. Equivalent to using the SEARCH() sheet function. |
| EndsWith Text | This conditional formatting rule highlights cells ending with given text. Equivalent to using the RIGHT() sheet function and comparing values. |
| Expression Formula | This conditional formatting rule contains a formula to evaluate. When the formula result is true, the cell is highlighted. |
| InTimePeriod TimePeriod | This conditional formatting rule highlights cells containing dates in the specified time period. The underlying value of the cell is evaluated, therefore the cell does not need to be formatted as a date to be evaluated. For example, with a cell containing the value 38913 the conditional format shall be applied if the rule requires a value of 7142006. |
data OperatorExpression Source #
Logical operation used in CellIs condition
See 18.18.15 "ST_ConditionalFormattingOperator (Conditional Format Operators)" (p. 2446)
Constructors
| OpBeginsWith Formula | 'Begins with' operator |
| OpBetween Formula Formula |
|
| OpContainsText Formula |
|
| OpEndsWith Formula | 'Ends with' operator |
| OpEqual Formula | 'Equal to' operator |
| OpGreaterThan Formula | 'Greater than' operator |
| OpGreaterThanOrEqual Formula | 'Greater than or equal to' operator |
| OpLessThan Formula | 'Less than' operator |
| OpLessThanOrEqual Formula | 'Less than or equal to' operator |
| OpNotBetween Formula Formula | 'Not between' operator |
| OpNotContains Formula | 'Does not contain' operator |
| OpNotEqual Formula | 'Not equal to' operator |
Instances
data TimePeriod Source #
Used in a "contains dates" conditional formatting rule. These are dynamic time periods, which change based on the date the conditional formatting is refreshed / applied.
See 18.18.82 "ST_TimePeriod (Time Period Types)" (p. 2508)
Constructors
| PerLast7Days | A date in the last seven days. |
| PerLastMonth | A date occuring in the last calendar month. |
| PerLastWeek | A date occuring last week. |
| PerNextMonth | A date occuring in the next calendar month. |
| PerNextWeek | A date occuring next week. |
| PerThisMonth | A date occuring in this calendar month. |
| PerThisWeek | A date occuring this week. |
| PerToday | Today's date. |
| PerTomorrow | Tomorrow's date. |
| PerYesterday | Yesterday's date. |
Instances
Lenses
CfRule
Misc
topCfPriority :: Int Source #