xlsx-1.1.2.2: Simple and incomplete Excel file parser/writer

Safe Haskell | Safe-Inferred
Language | Haskell2010

Codec.Xlsx.Types.ConditionalFormatting

Contents

- Lenses
  - CfRule
  - IconSetOptions
  - DataBarOptions
- Misc

Synopsis

- type ConditionalFormatting = [CfRule]
- data CfRule = CfRule {
  - _cfrCondition :: Condition
  - _cfrDxfId :: Maybe Int
  - _cfrPriority :: Int
  - _cfrStopIfTrue :: Maybe Bool
  }
- newtype NStdDev = NStdDev Int
- data Inclusion
  - = Inclusive
  - | Exclusive
- data CfValue
  - = CfValue Double
  - | CfPercent Double
  - | CfPercentile Double
  - | CfFormula Formula
- data MinCfValue
  - = CfvMin
  - | MinCfValue CfValue
- data MaxCfValue
  - = CfvMax
  - | MaxCfValue CfValue
- 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
  - = OpBeginsWith Formula
  - | OpBetween Formula Formula
  - | OpContainsText Formula
  - | OpEndsWith Formula
  - | OpEqual Formula
  - | OpGreaterThan Formula
  - | OpGreaterThanOrEqual Formula
  - | OpLessThan Formula
  - | OpLessThanOrEqual Formula
  - | OpNotBetween Formula Formula
  - | OpNotContains Formula
  - | OpNotEqual Formula
- data TimePeriod
  - = PerLast7Days
  - | PerLastMonth
  - | PerLastWeek
  - | PerNextMonth
  - | PerNextWeek
  - | PerThisMonth
  - | PerThisWeek
  - | PerToday
  - | PerTomorrow
  - | PerYesterday
- 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 {
  - _dboMaxLength :: Int
  - _dboMinLength :: Int
  - _dboShowValue :: Bool
  - _dboMinimum :: MinCfValue
  - _dboMaximum :: MaxCfValue
  - _dboColor :: Color
  }
- 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 #

data 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

- _cfrCondition :: Condition
- _cfrDxfId :: Maybe Int

  This is an index to a dxf element in the Styles Part indicating which cell formatting to apply when the conditional formatting rule criteria is met.

- _cfrPriority :: Int

  The priority of this conditional formatting rule. This value is used to determine which format should be evaluated and rendered. Lower numeric values are higher priority than higher numeric values, where 1 is the highest priority.

- _cfrStopIfTrue :: Maybe Bool

  If this flag is set, no rules with lower priority shall be applied over this rule, when this rule evaluates to true.

#### Instances

Instances details

Generic CfRule Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Associated Types type Rep CfRule :: Type -> Type Source # Methods from :: CfRule -> Rep CfRule x Source # to :: Rep CfRule x -> CfRule Source #
Show CfRule Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods showsPrec :: Int -> CfRule -> ShowS Source # show :: CfRule -> String Source # showList :: [CfRule] -> ShowS Source #
NFData CfRule Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods rnf :: CfRule -> () Source #
Eq CfRule Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods (==) :: CfRule -> CfRule -> Bool Source # (/=) :: CfRule -> CfRule -> Bool Source #
Ord CfRule Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods compare :: CfRule -> CfRule -> Ordering Source # (<) :: CfRule -> CfRule -> Bool Source # (<=) :: CfRule -> CfRule -> Bool Source # (>) :: CfRule -> CfRule -> Bool Source # (>=) :: CfRule -> CfRule -> Bool Source # max :: CfRule -> CfRule -> CfRule Source # min :: CfRule -> CfRule -> CfRule Source #
FromCursor CfRule Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods fromCursor :: Cursor -> [CfRule] Source #
FromXenoNode CfRule Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods fromXenoNode :: Node -> Either Text CfRule Source #
ToElement CfRule Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods toElement :: Name -> CfRule -> Element Source #
type Rep CfRule Source # |

Instance details

Defined in Codec.Xlsx.Types.ConditionalFormatting

type Rep CfRule = D1 ('MetaData "CfRule" "Codec.Xlsx.Types.ConditionalFormatting" "xlsx-1.1.2.2-DopzEu8STPN4igxHgE9OUe" 'False) (C1 ('MetaCons "CfRule" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_cfrCondition") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Condition) :*: S1 ('MetaSel ('Just "_cfrDxfId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "_cfrPriority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "_cfrStopIfTrue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Bool)))))

newtype NStdDev Source #

The number of standard deviations to include above or below the average in the conditional formatting rule.

Constructors

NStdDev Int |

#### Instances

Instances details

Generic NStdDev Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Associated Types type Rep NStdDev :: Type -> Type Source # Methods from :: NStdDev -> Rep NStdDev x Source # to :: Rep NStdDev x -> NStdDev Source #
Show NStdDev Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods showsPrec :: Int -> NStdDev -> ShowS Source # show :: NStdDev -> String Source # showList :: [NStdDev] -> ShowS Source #
NFData NStdDev Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods rnf :: NStdDev -> () Source #
Eq NStdDev Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods (==) :: NStdDev -> NStdDev -> Bool Source # (/=) :: NStdDev -> NStdDev -> Bool Source #
Ord NStdDev Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods compare :: NStdDev -> NStdDev -> Ordering Source # (<) :: NStdDev -> NStdDev -> Bool Source # (<=) :: NStdDev -> NStdDev -> Bool Source # (>) :: NStdDev -> NStdDev -> Bool Source # (>=) :: NStdDev -> NStdDev -> Bool Source # max :: NStdDev -> NStdDev -> NStdDev Source # min :: NStdDev -> NStdDev -> NStdDev Source #
FromAttrVal NStdDev Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods fromAttrVal :: Reader NStdDev Source #
FromAttrBs NStdDev Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods fromAttrBs :: ByteString -> Either Text NStdDev Source #
ToAttrVal NStdDev Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods toAttrVal :: NStdDev -> Text Source #
type Rep NStdDev Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting type Rep NStdDev = D1 ('MetaData "NStdDev" "Codec.Xlsx.Types.ConditionalFormatting" "xlsx-1.1.2.2-DopzEu8STPN4igxHgE9OUe" 'True) (C1 ('MetaCons "NStdDev" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)))

data Inclusion Source #

Flag indicating whether the `aboveAverage` and `belowAverage` criteria is inclusive of the average itself, or exclusive of that value.

Constructors

Inclusive |
Exclusive |

#### Instances

Instances details

Generic Inclusion Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Associated Types type Rep Inclusion :: Type -> Type Source # Methods from :: Inclusion -> Rep Inclusion x Source # to :: Rep Inclusion x -> Inclusion Source #
Show Inclusion Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods showsPrec :: Int -> Inclusion -> ShowS Source # show :: Inclusion -> String Source # showList :: [Inclusion] -> ShowS Source #
NFData Inclusion Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods rnf :: Inclusion -> () Source #
Eq Inclusion Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods (==) :: Inclusion -> Inclusion -> Bool Source # (/=) :: Inclusion -> Inclusion -> Bool Source #
Ord Inclusion Source # |

Instance details

Defined in Codec.Xlsx.Types.ConditionalFormatting

Methods

compare :: Inclusion -> Inclusion -> Ordering Source #

(<) :: Inclusion -> Inclusion -> Bool Source #

(<=) :: Inclusion -> Inclusion -> Bool Source #

(>) :: Inclusion -> Inclusion -> Bool Source #

(>=) :: Inclusion -> Inclusion -> Bool Source #

max :: Inclusion -> Inclusion -> Inclusion Source #

min :: Inclusion -> Inclusion -> Inclusion Source #

FromAttrVal Inclusion Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods fromAttrVal :: Reader Inclusion Source #
FromAttrBs Inclusion Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods fromAttrBs :: ByteString -> Either Text Inclusion Source #
ToAttrVal Inclusion Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods toAttrVal :: Inclusion -> Text Source #
type Rep Inclusion Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting type Rep Inclusion = D1 ('MetaData "Inclusion" "Codec.Xlsx.Types.ConditionalFormatting" "xlsx-1.1.2.2-DopzEu8STPN4igxHgE9OUe" 'False) (C1 ('MetaCons "Inclusive" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Exclusive" 'PrefixI 'False) (U1 :: Type -> Type))

data CfValue Source #

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)

Constructors

CfValue Double |
CfPercent Double |
CfPercentile Double |
CfFormula Formula |

#### Instances

Instances details

Generic CfValue Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Associated Types type Rep CfValue :: Type -> Type Source # Methods from :: CfValue -> Rep CfValue x Source # to :: Rep CfValue x -> CfValue Source #
Show CfValue Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods showsPrec :: Int -> CfValue -> ShowS Source # show :: CfValue -> String Source # showList :: [CfValue] -> ShowS Source #
NFData CfValue Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods rnf :: CfValue -> () Source #
Eq CfValue Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods (==) :: CfValue -> CfValue -> Bool Source # (/=) :: CfValue -> CfValue -> Bool Source #
Ord CfValue Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods compare :: CfValue -> CfValue -> Ordering Source # (<) :: CfValue -> CfValue -> Bool Source # (<=) :: CfValue -> CfValue -> Bool Source # (>) :: CfValue -> CfValue -> Bool Source # (>=) :: CfValue -> CfValue -> Bool Source # max :: CfValue -> CfValue -> CfValue Source # min :: CfValue -> CfValue -> CfValue Source #
FromCursor CfValue Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods fromCursor :: Cursor -> [CfValue] Source #
FromXenoNode CfValue Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods fromXenoNode :: Node -> Either Text CfValue Source #
ToElement CfValue Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods toElement :: Name -> CfValue -> Element Source #
type Rep CfValue Source # |

Instance details

Defined in Codec.Xlsx.Types.ConditionalFormatting

type Rep CfValue = D1 ('MetaData "CfValue" "Codec.Xlsx.Types.ConditionalFormatting" "xlsx-1.1.2.2-DopzEu8STPN4igxHgE9OUe" 'False) ((C1 ('MetaCons "CfValue" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)) :+: C1 ('MetaCons "CfPercent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double))) :+: (C1 ('MetaCons "CfPercentile" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)) :+: C1 ('MetaCons "CfFormula" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Formula))))

data MinCfValue Source #

Constructors

CfvMin |
MinCfValue CfValue |

#### Instances

Instances details

Generic MinCfValue Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Associated Types type Rep MinCfValue :: Type -> Type Source # Methods from :: MinCfValue -> Rep MinCfValue x Source # to :: Rep MinCfValue x -> MinCfValue Source #
Show MinCfValue Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods showsPrec :: Int -> MinCfValue -> ShowS Source # show :: MinCfValue -> String Source # showList :: [MinCfValue] -> ShowS Source #
NFData MinCfValue Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods rnf :: MinCfValue -> () Source #
Eq MinCfValue Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods (==) :: MinCfValue -> MinCfValue -> Bool Source # (/=) :: MinCfValue -> MinCfValue -> Bool Source #
Ord MinCfValue Source # |

Instance details

Defined in Codec.Xlsx.Types.ConditionalFormatting

Methods

compare :: MinCfValue -> MinCfValue -> Ordering Source #

(<) :: MinCfValue -> MinCfValue -> Bool Source #

(<=) :: MinCfValue -> MinCfValue -> Bool Source #

(>) :: MinCfValue -> MinCfValue -> Bool Source #

(>=) :: MinCfValue -> MinCfValue -> Bool Source #

max :: MinCfValue -> MinCfValue -> MinCfValue Source #

min :: MinCfValue -> MinCfValue -> MinCfValue Source #

FromCursor MinCfValue Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods fromCursor :: Cursor -> [MinCfValue] Source #
FromXenoNode MinCfValue Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods fromXenoNode :: Node -> Either Text MinCfValue Source #
ToElement MinCfValue Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods toElement :: Name -> MinCfValue -> Element Source #
type Rep MinCfValue Source # |

Instance details

Defined in Codec.Xlsx.Types.ConditionalFormatting

type Rep MinCfValue = D1 ('MetaData "MinCfValue" "Codec.Xlsx.Types.ConditionalFormatting" "xlsx-1.1.2.2-DopzEu8STPN4igxHgE9OUe" 'False) (C1 ('MetaCons "CfvMin" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MinCfValue" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CfValue)))

data MaxCfValue Source #

Constructors

CfvMax |
MaxCfValue CfValue |

#### Instances

Instances details

Generic MaxCfValue Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Associated Types type Rep MaxCfValue :: Type -> Type Source # Methods from :: MaxCfValue -> Rep MaxCfValue x Source # to :: Rep MaxCfValue x -> MaxCfValue Source #
Show MaxCfValue Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods showsPrec :: Int -> MaxCfValue -> ShowS Source # show :: MaxCfValue -> String Source # showList :: [MaxCfValue] -> ShowS Source #
NFData MaxCfValue Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods rnf :: MaxCfValue -> () Source #
Eq MaxCfValue Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods (==) :: MaxCfValue -> MaxCfValue -> Bool Source # (/=) :: MaxCfValue -> MaxCfValue -> Bool Source #
Ord MaxCfValue Source # |

Instance details

Defined in Codec.Xlsx.Types.ConditionalFormatting

Methods

compare :: MaxCfValue -> MaxCfValue -> Ordering Source #

(<) :: MaxCfValue -> MaxCfValue -> Bool Source #

(<=) :: MaxCfValue -> MaxCfValue -> Bool Source #

(>) :: MaxCfValue -> MaxCfValue -> Bool Source #

(>=) :: MaxCfValue -> MaxCfValue -> Bool Source #

max :: MaxCfValue -> MaxCfValue -> MaxCfValue Source #

min :: MaxCfValue -> MaxCfValue -> MaxCfValue Source #

FromCursor MaxCfValue Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods fromCursor :: Cursor -> [MaxCfValue] Source #
FromXenoNode MaxCfValue Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods fromXenoNode :: Node -> Either Text MaxCfValue Source #
ToElement MaxCfValue Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods toElement :: Name -> MaxCfValue -> Element Source #
type Rep MaxCfValue Source # |

Instance details

Defined in Codec.Xlsx.Types.ConditionalFormatting

type Rep MaxCfValue = D1 ('MetaData "MaxCfValue" "Codec.Xlsx.Types.ConditionalFormatting" "xlsx-1.1.2.2-DopzEu8STPN4igxHgE9OUe" 'False) (C1 ('MetaCons "CfvMax" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "MaxCfValue" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CfValue)))

data Condition Source #

Conditions which could be used for conditional formatting

See 18.18.12 "ST_CfType (Conditional Format Type)" (p. 2443)

Constructors

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

Instances details

Generic Condition Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Associated Types type Rep Condition :: Type -> Type Source # Methods from :: Condition -> Rep Condition x Source # to :: Rep Condition x -> Condition Source #
Show Condition Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods showsPrec :: Int -> Condition -> ShowS Source # show :: Condition -> String Source # showList :: [Condition] -> ShowS Source #
NFData Condition Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods rnf :: Condition -> () Source #
Eq Condition Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods (==) :: Condition -> Condition -> Bool Source # (/=) :: Condition -> Condition -> Bool Source #
Ord Condition Source # |

Instance details

Defined in Codec.Xlsx.Types.ConditionalFormatting

Methods

compare :: Condition -> Condition -> Ordering Source #

(<) :: Condition -> Condition -> Bool Source #

(<=) :: Condition -> Condition -> Bool Source #

(>) :: Condition -> Condition -> Bool Source #

(>=) :: Condition -> Condition -> Bool Source #

max :: Condition -> Condition -> Condition Source #

min :: Condition -> Condition -> Condition Source #

type Rep Condition Source # |

Instance details

Defined in Codec.Xlsx.Types.ConditionalFormatting

type Rep Condition = D1 ('MetaData "Condition" "Codec.Xlsx.Types.ConditionalFormatting" "xlsx-1.1.2.2-DopzEu8STPN4igxHgE9OUe" 'False) ((((C1 ('MetaCons "AboveAverage" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Inclusion) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe NStdDev))) :+: C1 ('MetaCons "BeginsWith" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))) :+: (C1 ('MetaCons "BelowAverage" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Inclusion) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe NStdDev))) :+: (C1 ('MetaCons "BottomNPercent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :+: C1 ('MetaCons "BottomNValues" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))))) :+: ((C1 ('MetaCons "CellIs" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 OperatorExpression)) :+: (C1 ('MetaCons "ColorScale2" 'PrefixI 'False) ((S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MinCfValue) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Color)) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MaxCfValue) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Color))) :+: C1 ('MetaCons "ColorScale3" 'PrefixI 'False) ((S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MinCfValue) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Color) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 CfValue))) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Color) :*: (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MaxCfValue) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Color)))))) :+: (C1 ('MetaCons "ContainsBlanks" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "ContainsErrors" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ContainsText" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))))) :+: (((C1 ('MetaCons "DataBar" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 DataBarOptions)) :+: (C1 ('MetaCons "DoesNotContainErrors" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "DoesNotContainBlanks" 'PrefixI 'False) (U1 :: Type -> Type))) :+: (C1 ('MetaCons "DoesNotContainText" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :+: (C1 ('MetaCons "DuplicateValues" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "EndsWith" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text))))) :+: ((C1 ('MetaCons "Expression" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Formula)) :+: (C1 ('MetaCons "IconSet" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 IconSetOptions)) :+: C1 ('MetaCons "InTimePeriod" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 TimePeriod)))) :+: (C1 ('MetaCons "TopNPercent" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :+: (C1 ('MetaCons "TopNValues" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int)) :+: C1 ('MetaCons "UniqueValues" 'PrefixI 'False) (U1 :: Type -> Type))))))

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 | `Between` operator
OpContainsText Formula | `Contains` operator
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

Instances details

Generic OperatorExpression Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Associated Types type Rep OperatorExpression :: Type -> Type Source # Methods from :: OperatorExpression -> Rep OperatorExpression x Source # to :: Rep OperatorExpression x -> OperatorExpression Source #
Show OperatorExpression Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods showsPrec :: Int -> OperatorExpression -> ShowS Source # show :: OperatorExpression -> String Source # showList :: [OperatorExpression] -> ShowS Source #
NFData OperatorExpression Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods rnf :: OperatorExpression -> () Source #
Eq OperatorExpression Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods (==) :: OperatorExpression -> OperatorExpression -> Bool Source # (/=) :: OperatorExpression -> OperatorExpression -> Bool Source #
Ord OperatorExpression Source # |

Instance details

Defined in Codec.Xlsx.Types.ConditionalFormatting

Methods

compare :: OperatorExpression -> OperatorExpression -> Ordering Source #

(<) :: OperatorExpression -> OperatorExpression -> Bool Source #

(<=) :: OperatorExpression -> OperatorExpression -> Bool Source #

(>) :: OperatorExpression -> OperatorExpression -> Bool Source #

(>=) :: OperatorExpression -> OperatorExpression -> Bool Source #

max :: OperatorExpression -> OperatorExpression -> OperatorExpression Source #

min :: OperatorExpression -> OperatorExpression -> OperatorExpression Source #

type Rep OperatorExpression Source # |

Instance details

Defined in Codec.Xlsx.Types.ConditionalFormatting

type Rep OperatorExpression = D1 ('MetaData "OperatorExpression" "Codec.Xlsx.Types.ConditionalFormatting" "xlsx-1.1.2.2-DopzEu8STPN4igxHgE9OUe" 'False) (((C1 ('MetaCons "OpBeginsWith" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Formula)) :+: (C1 ('MetaCons "OpBetween" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Formula) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Formula)) :+: C1 ('MetaCons "OpContainsText" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Formula)))) :+: (C1 ('MetaCons "OpEndsWith" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Formula)) :+: (C1 ('MetaCons "OpEqual" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Formula)) :+: C1 ('MetaCons "OpGreaterThan" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Formula))))) :+: ((C1 ('MetaCons "OpGreaterThanOrEqual" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Formula)) :+: (C1 ('MetaCons "OpLessThan" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Formula)) :+: C1 ('MetaCons "OpLessThanOrEqual" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Formula)))) :+: (C1 ('MetaCons "OpNotBetween" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Formula) :*: S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Formula)) :+: (C1 ('MetaCons "OpNotContains" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Formula)) :+: C1 ('MetaCons "OpNotEqual" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Formula))))))

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

Instances details

Generic TimePeriod Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Associated Types type Rep TimePeriod :: Type -> Type Source # Methods from :: TimePeriod -> Rep TimePeriod x Source # to :: Rep TimePeriod x -> TimePeriod Source #
Show TimePeriod Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods showsPrec :: Int -> TimePeriod -> ShowS Source # show :: TimePeriod -> String Source # showList :: [TimePeriod] -> ShowS Source #
NFData TimePeriod Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods rnf :: TimePeriod -> () Source #
Eq TimePeriod Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods (==) :: TimePeriod -> TimePeriod -> Bool Source # (/=) :: TimePeriod -> TimePeriod -> Bool Source #
Ord TimePeriod Source # |

Instance details

Defined in Codec.Xlsx.Types.ConditionalFormatting

Methods

compare :: TimePeriod -> TimePeriod -> Ordering Source #

(<) :: TimePeriod -> TimePeriod -> Bool Source #

(<=) :: TimePeriod -> TimePeriod -> Bool Source #

(>) :: TimePeriod -> TimePeriod -> Bool Source #

(>=) :: TimePeriod -> TimePeriod -> Bool Source #

max :: TimePeriod -> TimePeriod -> TimePeriod Source #

min :: TimePeriod -> TimePeriod -> TimePeriod Source #

FromAttrVal TimePeriod Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods fromAttrVal :: Reader TimePeriod Source #
FromAttrBs TimePeriod Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods fromAttrBs :: ByteString -> Either Text TimePeriod Source #
ToAttrVal TimePeriod Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods toAttrVal :: TimePeriod -> Text Source #
type Rep TimePeriod Source # |

Instance details

Defined in Codec.Xlsx.Types.ConditionalFormatting

type Rep TimePeriod = D1 ('MetaData "TimePeriod" "Codec.Xlsx.Types.ConditionalFormatting" "xlsx-1.1.2.2-DopzEu8STPN4igxHgE9OUe" 'False) (((C1 ('MetaCons "PerLast7Days" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PerLastMonth" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "PerLastWeek" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PerNextMonth" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PerNextWeek" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: ((C1 ('MetaCons "PerThisMonth" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PerThisWeek" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "PerToday" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "PerTomorrow" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "PerYesterday" 'PrefixI 'False) (U1 :: Type -> Type)))))

data IconSetOptions Source #

Describes an icon set conditional formatting rule.

See 18.3.1.49 "iconSet (Icon Set)" (p. 1645)

Constructors

IconSetOptions |

Fields

- _isoIconSet :: IconSetType

  icon set used, default value is `IconSet3Trafficlights1`

- _isoValues :: [CfValue]

  values describing per icon ranges

- _isoReverse :: Bool

  reverses the default order of the icons in the specified icon set

- _isoShowValue :: Bool

  indicates whether to show the values of the cells on which this icon set is applied.

#### Instances

Instances details

Generic IconSetOptions Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Associated Types type Rep IconSetOptions :: Type -> Type Source # Methods from :: IconSetOptions -> Rep IconSetOptions x Source # to :: Rep IconSetOptions x -> IconSetOptions Source #
Show IconSetOptions Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods showsPrec :: Int -> IconSetOptions -> ShowS Source # show :: IconSetOptions -> String Source # showList :: [IconSetOptions] -> ShowS Source #
Default IconSetOptions Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods def :: IconSetOptions #
NFData IconSetOptions Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods rnf :: IconSetOptions -> () Source #
Eq IconSetOptions Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods (==) :: IconSetOptions -> IconSetOptions -> Bool Source # (/=) :: IconSetOptions -> IconSetOptions -> Bool Source #
Ord IconSetOptions Source # |

Instance details

Defined in Codec.Xlsx.Types.ConditionalFormatting

Methods

compare :: IconSetOptions -> IconSetOptions -> Ordering Source #

(<) :: IconSetOptions -> IconSetOptions -> Bool Source #

(<=) :: IconSetOptions -> IconSetOptions -> Bool Source #

(>) :: IconSetOptions -> IconSetOptions -> Bool Source #

(>=) :: IconSetOptions -> IconSetOptions -> Bool Source #

max :: IconSetOptions -> IconSetOptions -> IconSetOptions Source #

min :: IconSetOptions -> IconSetOptions -> IconSetOptions Source #

FromCursor IconSetOptions Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods fromCursor :: Cursor -> [IconSetOptions] Source #
FromXenoNode IconSetOptions Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods fromXenoNode :: Node -> Either Text IconSetOptions Source #
ToElement IconSetOptions Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods toElement :: Name -> IconSetOptions -> Element Source #
type Rep IconSetOptions Source # |

Instance details

Defined in Codec.Xlsx.Types.ConditionalFormatting

type Rep IconSetOptions = D1 ('MetaData "IconSetOptions" "Codec.Xlsx.Types.ConditionalFormatting" "xlsx-1.1.2.2-DopzEu8STPN4igxHgE9OUe" 'False) (C1 ('MetaCons "IconSetOptions" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_isoIconSet") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 IconSetType) :*: S1 ('MetaSel ('Just "_isoValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [CfValue])) :*: (S1 ('MetaSel ('Just "_isoReverse") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool) :*: S1 ('MetaSel ('Just "_isoShowValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))))

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.

1. 18.42 "ST_IconSetType (Icon Set Type)" (p. 2463)

Constructors

IconSet3Arrows |
IconSet3ArrowsGray |
IconSet3Flags |
IconSet3Signs |
IconSet3Symbols |
IconSet3Symbols2 |
IconSet3TrafficLights1 |
IconSet3TrafficLights2 | 3 traffic lights icon set with thick black border.
IconSet4Arrows |
IconSet4ArrowsGray |
IconSet4Rating |
IconSet4RedToBlack |
IconSet4TrafficLights |
IconSet5Arrows |
IconSet5ArrowsGray |
IconSet5Quarters |
IconSet5Rating |

#### Instances

Instances details

Generic IconSetType Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Associated Types type Rep IconSetType :: Type -> Type Source # Methods from :: IconSetType -> Rep IconSetType x Source # to :: Rep IconSetType x -> IconSetType Source #
Show IconSetType Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods showsPrec :: Int -> IconSetType -> ShowS Source # show :: IconSetType -> String Source # showList :: [IconSetType] -> ShowS Source #
NFData IconSetType Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods rnf :: IconSetType -> () Source #
Eq IconSetType Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods (==) :: IconSetType -> IconSetType -> Bool Source # (/=) :: IconSetType -> IconSetType -> Bool Source #
Ord IconSetType Source # |

Instance details

Defined in Codec.Xlsx.Types.ConditionalFormatting

Methods

compare :: IconSetType -> IconSetType -> Ordering Source #

(<) :: IconSetType -> IconSetType -> Bool Source #

(<=) :: IconSetType -> IconSetType -> Bool Source #

(>) :: IconSetType -> IconSetType -> Bool Source #

(>=) :: IconSetType -> IconSetType -> Bool Source #

max :: IconSetType -> IconSetType -> IconSetType Source #

min :: IconSetType -> IconSetType -> IconSetType Source #

FromAttrVal IconSetType Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods fromAttrVal :: Reader IconSetType Source #
FromAttrBs IconSetType Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods fromAttrBs :: ByteString -> Either Text IconSetType Source #
ToAttrVal IconSetType Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods toAttrVal :: IconSetType -> Text Source #
type Rep IconSetType Source # |

Instance details

Defined in Codec.Xlsx.Types.ConditionalFormatting

type Rep IconSetType = D1 ('MetaData "IconSetType" "Codec.Xlsx.Types.ConditionalFormatting" "xlsx-1.1.2.2-DopzEu8STPN4igxHgE9OUe" 'False) ((((C1 ('MetaCons "IconSet3Arrows" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "IconSet3ArrowsGray" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "IconSet3Flags" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "IconSet3Signs" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "IconSet3Symbols" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "IconSet3Symbols2" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "IconSet3TrafficLights1" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "IconSet3TrafficLights2" 'PrefixI 'False) (U1 :: Type -> Type)))) :+: (((C1 ('MetaCons "IconSet4Arrows" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "IconSet4ArrowsGray" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "IconSet4Rating" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "IconSet4RedToBlack" 'PrefixI 'False) (U1 :: Type -> Type))) :+: ((C1 ('MetaCons "IconSet4TrafficLights" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "IconSet5Arrows" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "IconSet5ArrowsGray" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "IconSet5Quarters" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "IconSet5Rating" 'PrefixI 'False) (U1 :: Type -> Type))))))

data DataBarOptions Source #

Describes a data bar conditional formatting rule.

See 18.3.1.28 "dataBar (Data Bar)" (p. 1621)

Constructors

DataBarOptions |

Fields

- _dboMaxLength :: Int

  The maximum length of the data bar, as a percentage of the cell width.

- _dboMinLength :: Int

  The minimum length of the data bar, as a percentage of the cell width.

- _dboShowValue :: Bool

  Indicates whether to show the values of the cells on which this data bar is applied.

- _dboMinimum :: MinCfValue
- _dboMaximum :: MaxCfValue
- _dboColor :: Color

#### Instances

Instances details

Generic DataBarOptions Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Associated Types type Rep DataBarOptions :: Type -> Type Source # Methods from :: DataBarOptions -> Rep DataBarOptions x Source # to :: Rep DataBarOptions x -> DataBarOptions Source #
Show DataBarOptions Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods showsPrec :: Int -> DataBarOptions -> ShowS Source # show :: DataBarOptions -> String Source # showList :: [DataBarOptions] -> ShowS Source #
NFData DataBarOptions Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods rnf :: DataBarOptions -> () Source #
Eq DataBarOptions Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods (==) :: DataBarOptions -> DataBarOptions -> Bool Source # (/=) :: DataBarOptions -> DataBarOptions -> Bool Source #
Ord DataBarOptions Source # |

Instance details

Defined in Codec.Xlsx.Types.ConditionalFormatting

Methods

compare :: DataBarOptions -> DataBarOptions -> Ordering Source #

(<) :: DataBarOptions -> DataBarOptions -> Bool Source #

(<=) :: DataBarOptions -> DataBarOptions -> Bool Source #

(>) :: DataBarOptions -> DataBarOptions -> Bool Source #

(>=) :: DataBarOptions -> DataBarOptions -> Bool Source #

max :: DataBarOptions -> DataBarOptions -> DataBarOptions Source #

min :: DataBarOptions -> DataBarOptions -> DataBarOptions Source #

FromCursor DataBarOptions Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods fromCursor :: Cursor -> [DataBarOptions] Source #
FromXenoNode DataBarOptions Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods fromXenoNode :: Node -> Either Text DataBarOptions Source #
ToElement DataBarOptions Source # |
Instance details Defined in Codec.Xlsx.Types.ConditionalFormatting Methods toElement :: Name -> DataBarOptions -> Element Source #
type Rep DataBarOptions Source # |

Instance details

Defined in Codec.Xlsx.Types.ConditionalFormatting

type Rep DataBarOptions = D1 ('MetaData "DataBarOptions" "Codec.Xlsx.Types.ConditionalFormatting" "xlsx-1.1.2.2-DopzEu8STPN4igxHgE9OUe" 'False) (C1 ('MetaCons "DataBarOptions" 'PrefixI 'True) ((S1 ('MetaSel ('Just "_dboMaxLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: (S1 ('MetaSel ('Just "_dboMinLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "_dboShowValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Bool))) :*: (S1 ('MetaSel ('Just "_dboMinimum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MinCfValue) :*: (S1 ('MetaSel ('Just "_dboMaximum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MaxCfValue) :*: S1 ('MetaSel ('Just "_dboColor") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Color)))))

dataBarWithColor :: Color -> Condition Source #

# Lenses

## CfRule

cfrCondition :: Lens' CfRule Condition Source #

cfrDxfId :: Lens' CfRule (Maybe Int) Source #

cfrPriority :: Lens' CfRule Int Source #

cfrStopIfTrue :: Lens' CfRule (Maybe Bool) Source #

## IconSetOptions

isoIconSet :: Lens' IconSetOptions IconSetType Source #

isoValues :: Lens' IconSetOptions [CfValue] Source #

isoReverse :: Lens' IconSetOptions Bool Source #

isoShowValue :: Lens' IconSetOptions Bool Source #

## DataBarOptions

dboMaxLength :: Lens' DataBarOptions Int Source #

dboMinLength :: Lens' DataBarOptions Int Source #

dboShowValue :: Lens' DataBarOptions Bool Source #

dboMinimum :: Lens' DataBarOptions MinCfValue Source #

dboMaximum :: Lens' DataBarOptions MaxCfValue Source #

dboColor :: Lens' DataBarOptions Color Source #

# Misc

topCfPriority :: Int Source #