Safe Haskell | Safe-Inferred |
---|---|
Language | Haskell2010 |
Synopsis
- type ConditionalFormatting = [CfRule]
- data CfRule = CfRule {}
- newtype NStdDev = NStdDev Int
- data Inclusion
- data CfValue
- data MinCfValue
- data MaxCfValue
- data Condition
- = AboveAverage Inclusion (Maybe NStdDev)
- | BeginsWith Text
- | BelowAverage Inclusion (Maybe NStdDev)
- | BottomNPercent Int
- | BottomNValues Int
- | CellIs OperatorExpression
- | ColorScale2 MinCfValue Color MaxCfValue Color
- | ColorScale3 MinCfValue Color CfValue Color MaxCfValue Color
- | ContainsBlanks
- | ContainsErrors
- | ContainsText Text
- | DataBar DataBarOptions
- | DoesNotContainErrors
- | DoesNotContainBlanks
- | DoesNotContainText Text
- | DuplicateValues
- | EndsWith Text
- | Expression Formula
- | IconSet IconSetOptions
- | InTimePeriod TimePeriod
- | TopNPercent Int
- | TopNValues Int
- | UniqueValues
- data OperatorExpression
- data TimePeriod
- data IconSetOptions = IconSetOptions {
- _isoIconSet :: IconSetType
- _isoValues :: [CfValue]
- _isoReverse :: Bool
- _isoShowValue :: Bool
- data IconSetType
- = IconSet3Arrows
- | IconSet3ArrowsGray
- | IconSet3Flags
- | IconSet3Signs
- | IconSet3Symbols
- | IconSet3Symbols2
- | IconSet3TrafficLights1
- | IconSet3TrafficLights2
- | IconSet4Arrows
- | IconSet4ArrowsGray
- | IconSet4Rating
- | IconSet4RedToBlack
- | IconSet4TrafficLights
- | IconSet5Arrows
- | IconSet5ArrowsGray
- | IconSet5Quarters
- | IconSet5Rating
- data DataBarOptions = DataBarOptions {}
- dataBarWithColor :: Color -> Condition
- cfrCondition :: Lens' CfRule Condition
- cfrDxfId :: Lens' CfRule (Maybe Int)
- cfrPriority :: Lens' CfRule Int
- cfrStopIfTrue :: Lens' CfRule (Maybe Bool)
- isoIconSet :: Lens' IconSetOptions IconSetType
- isoValues :: Lens' IconSetOptions [CfValue]
- isoReverse :: Lens' IconSetOptions Bool
- isoShowValue :: Lens' IconSetOptions Bool
- dboMaxLength :: Lens' DataBarOptions Int
- dboMinLength :: Lens' DataBarOptions Int
- dboShowValue :: Lens' DataBarOptions Bool
- dboMinimum :: Lens' DataBarOptions MinCfValue
- dboMaximum :: Lens' DataBarOptions MaxCfValue
- dboColor :: Lens' DataBarOptions Color
- 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)
CfRule | |
|
Instances
The number of standard deviations to include above or below the average in the conditional formatting rule.
Instances
Generic NStdDev Source # | |
Show NStdDev Source # | |
NFData NStdDev Source # | |
Defined in Codec.Xlsx.Types.ConditionalFormatting | |
Eq NStdDev Source # | |
Ord NStdDev Source # | |
Defined in Codec.Xlsx.Types.ConditionalFormatting | |
FromAttrVal NStdDev Source # | |
Defined in Codec.Xlsx.Types.ConditionalFormatting | |
FromAttrBs NStdDev Source # | |
Defined in Codec.Xlsx.Types.ConditionalFormatting fromAttrBs :: ByteString -> Either Text NStdDev Source # | |
ToAttrVal NStdDev Source # | |
type Rep NStdDev Source # | |
Defined in Codec.Xlsx.Types.ConditionalFormatting |
Flag indicating whether the aboveAverage
and belowAverage
criteria is inclusive of the average itself, or exclusive of that
value.
Instances
Generic Inclusion Source # | |
Show Inclusion Source # | |
NFData Inclusion Source # | |
Defined in Codec.Xlsx.Types.ConditionalFormatting | |
Eq Inclusion Source # | |
Ord Inclusion Source # | |
Defined in Codec.Xlsx.Types.ConditionalFormatting | |
FromAttrVal Inclusion Source # | |
Defined in Codec.Xlsx.Types.ConditionalFormatting | |
FromAttrBs Inclusion Source # | |
Defined in Codec.Xlsx.Types.ConditionalFormatting fromAttrBs :: ByteString -> Either Text Inclusion Source # | |
ToAttrVal Inclusion Source # | |
type Rep Inclusion Source # | |
Defined in Codec.Xlsx.Types.ConditionalFormatting |
Describes the values of the interpolation points in a color scale, data bar or icon set conditional formatting rules.
See 18.3.1.11 "cfvo (Conditional Format Value Object)" (p. 1604)
Instances
data MinCfValue Source #
Instances
data MaxCfValue Source #
Instances
Conditions which could be used for conditional formatting
See 18.18.12 "ST_CfType (Conditional Format Type)" (p. 2443)
AboveAverage Inclusion (Maybe NStdDev) | This conditional formatting rule highlights cells that are above (or maybe equal to) the average for all values in the range. |
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. |
BelowAverage Inclusion (Maybe NStdDev) | This conditional formatting rule highlights cells that are below the average for all values in the range. |
BottomNPercent Int | This conditional formatting rule highlights cells whose values fall in the bottom N percent bracket. |
BottomNValues Int | This conditional formatting rule highlights cells whose values fall in the bottom N bracket. |
CellIs OperatorExpression | This conditional formatting rule compares a cell value to a formula calculated result, using an operator. |
ColorScale2 MinCfValue Color MaxCfValue Color | This conditional formatting rule creates a gradated color scale on the cells with specified colors for specified minimum and maximum. |
ColorScale3 MinCfValue Color CfValue Color MaxCfValue Color | This conditional formatting rule creates a gradated color scale on the cells with specified colors for specified minimum, midpoint and maximum. |
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. |
DataBar DataBarOptions | This conditional formatting rule displays a gradated data bar in the range of cells. |
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. |
DuplicateValues | This conditional formatting rule highlights duplicated values. |
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. |
IconSet IconSetOptions | This conditional formatting rule applies icons to cells according to their values. |
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. |
TopNPercent Int | This conditional formatting rule highlights cells whose values fall in the top N percent bracket. |
TopNValues Int | This conditional formatting rule highlights cells whose values fall in the top N bracket. |
UniqueValues | This conditional formatting rule highlights unique values in the range. |
Instances
data OperatorExpression Source #
Logical operation used in CellIs
condition
See 18.18.15 "ST_ConditionalFormattingOperator (Conditional Format Operators)" (p. 2446)
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)
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
data IconSetOptions Source #
Describes an icon set conditional formatting rule.
See 18.3.1.49 "iconSet (Icon Set)" (p. 1645)
IconSetOptions | |
|
Instances
data IconSetType Source #
Icon set type for conditional formatting. CfValue
fields
determine lower range bounds. I.e. IconSet3Signs (CfPercent 0)
(CfPercent 33) (CfPercent 67)
say that 1st icon will be shown for
values ranging from 0 to 33 percents, 2nd for 33 to 67 percent and
the 3rd one for values from 67 to 100 percent.
- 18.42 "ST_IconSetType (Icon Set Type)" (p. 2463)
Instances
data DataBarOptions Source #
Describes a data bar conditional formatting rule.
See 18.3.1.28 "dataBar (Data Bar)" (p. 1621)
DataBarOptions | |
|
Instances
dataBarWithColor :: Color -> Condition Source #
Lenses
CfRule
IconSetOptions
DataBarOptions
Misc
topCfPriority :: Int Source #