Safe Haskell	None
Language	Haskell2010

Codec.Xlsx.Types.AutoFilter

Synopsis

data FilterColumn
data FilterByBlank
- = FilterByBlank
- | DontFilterByBlank
data FilterCriterion
- = FilterValue Text
- | FilterDateGroup DateGroup
data DateGroup
- = DateGroupByYear Int
- | DateGroupByMonth Int Int
- | DateGroupByDay Int Int Int
- | DateGroupByHour Int Int Int Int
- | DateGroupByMinute Int Int Int Int Int
- | DateGroupBySecond Int Int Int Int Int Int
data CustomFilter = CustomFilter {
- cfltOperator :: CustomFilterOperator
- cfltValue :: Text
}
data CustomFilterOperator
- = FltrEqual
- | FltrGreaterThan
- | FltrGreaterThanOrEqual
- | FltrLessThan
- | FltrLessThanOrEqual
- | FltrNotEqual
data EdgeFilterOptions = EdgeFilterOptions {
- _efoUsePercents :: Bool
- _efoVal :: Double
- _efoFilterVal :: Maybe Double
}
data ColorFilterOptions = ColorFilterOptions {
- _cfoCellColor :: Bool
- _cfoDxfId :: Maybe Int
}
data DynFilterOptions = DynFilterOptions {
- _dfoType :: DynFilterType
- _dfoVal :: Maybe Double
- _dfoMaxVal :: Maybe Double
}
data DynFilterType
- = DynFilterAboveAverage
- | DynFilterBelowAverage
- | DynFilterLastMonth
- | DynFilterLastQuarter
- | DynFilterLastWeek
- | DynFilterLastYear
- | DynFilterM1
- | DynFilterM10
- | DynFilterM11
- | DynFilterM12
- | DynFilterM2
- | DynFilterM3
- | DynFilterM4
- | DynFilterM5
- | DynFilterM6
- | DynFilterM7
- | DynFilterM8
- | DynFilterM9
- | DynFilterNextMonth
- | DynFilterNextQuarter
- | DynFilterNextWeek
- | DynFilterNextYear
- | DynFilterNull
- | DynFilterQ1
- | DynFilterQ2
- | DynFilterQ3
- | DynFilterQ4
- | DynFilterThisMonth
- | DynFilterThisQuarter
- | DynFilterThisWeek
- | DynFilterThisYear
- | DynFilterToday
- | DynFilterTomorrow
- | DynFilterYearToDate
- | DynFilterYesterday
data AutoFilter = AutoFilter {
- _afRef :: Maybe CellRef
- _afFilterColumns :: Map Int FilterColumn
}
afFilterColumns :: Lens' AutoFilter (Map Int FilterColumn)
afRef :: Lens' AutoFilter (Maybe CellRef)
fltColFromNode :: Node -> [FilterColumn]
filterCriterionFromNode :: Node -> [FilterCriterion]
fltColToElement :: FilterColumn -> Element
edgeFilter :: Bool -> EdgeFilterOptions -> Element
filterCriterionToElement :: FilterCriterion -> Element

Documentation

data FilterColumn Source #

The filterColumn collection identifies a particular column in the AutoFilter range and specifies filter information that has been applied to this column. If a column in the AutoFilter range has no criteria specified, then there is no corresponding filterColumn collection expressed for that column.

See 18.3.2.7 "filterColumn (AutoFilter Column)" (p. 1717)

Constructors

Filters FilterByBlank [FilterCriterion]
ColorFilter ColorFilterOptions
ACustomFilter CustomFilter
CustomFiltersOr CustomFilter CustomFilter
CustomFiltersAnd CustomFilter CustomFilter
DynamicFilter DynFilterOptions
IconFilter (Maybe Int) IconSetType	Specifies the icon set and particular icon within that set to filter by. Icon is specified using zero-based index of an icon in an icon set. `Nothing` means "no icon"
BottomNFilter EdgeFilterOptions	Specifies the bottom N (percent or number of items) to filter by
TopNFilter EdgeFilterOptions	Specifies the top N (percent or number of items) to filter by

Instances

Instances details

NFData FilterColumn Source #

Instance details

DateGroupByYear Int
DateGroupByMonth Int Int
DateGroupByDay Int Int Int
DateGroupByHour Int Int Int Int
DateGroupByMinute Int Int Int Int Int
DateGroupBySecond Int Int Int Int Int Int

CustomFilter
Fields cfltOperator :: CustomFilterOperator cfltValue :: Text

FltrEqual	Show results which are equal to criteria.
FltrGreaterThan	Show results which are greater than criteria.
FltrGreaterThanOrEqual	Show results which are greater than or equal to criteria.
FltrLessThan	Show results which are less than criteria.
FltrLessThanOrEqual	Show results which are less than or equal to criteria.
FltrNotEqual	Show results which are not equal to criteria.

EdgeFilterOptions
Fields _efoUsePercents :: Bool Flag indicating whether or not to filter by percent value of the column. A false value filters by number of items. _efoVal :: Double Top or bottom value to use as the filter criteria. Example: "Filter by Top 10 Percent" or "Filter by Top 5 Items" _efoFilterVal :: Maybe Double The actual cell value in the range which is used to perform the comparison for this filter.

DynFilterOptions
Fields _dfoType :: DynFilterType _dfoVal :: Maybe Double A minimum numeric value for dynamic filter. _dfoMaxVal :: Maybe Double A maximum value for dynamic filter.

DynFilterAboveAverage	Shows values that are above average.
DynFilterBelowAverage	Shows values that are below average.
DynFilterLastMonth	Shows last month's dates.
DynFilterLastQuarter	Shows last calendar quarter's dates.
DynFilterLastWeek	Shows last week's dates, using Sunday as the first weekday.
DynFilterLastYear	Shows last year's dates.
DynFilterM1	Shows the dates that are in January, regardless of year.
DynFilterM10	Shows the dates that are in October, regardless of year.
DynFilterM11	Shows the dates that are in November, regardless of year.
DynFilterM12	Shows the dates that are in December, regardless of year.
DynFilterM2	Shows the dates that are in February, regardless of year.
DynFilterM3	Shows the dates that are in March, regardless of year.
DynFilterM4	Shows the dates that are in April, regardless of year.
DynFilterM5	Shows the dates that are in May, regardless of year.
DynFilterM6	Shows the dates that are in June, regardless of year.
DynFilterM7	Shows the dates that are in July, regardless of year.
DynFilterM8	Shows the dates that are in August, regardless of year.
DynFilterM9	Shows the dates that are in September, regardless of year.
DynFilterNextMonth	Shows next month's dates.
DynFilterNextQuarter	Shows next calendar quarter's dates.
DynFilterNextWeek	Shows next week's dates, using Sunday as the first weekday.
DynFilterNextYear	Shows next year's dates.
DynFilterNull	Common filter type not available.
DynFilterQ1	Shows the dates that are in the 1st calendar quarter, regardless of year.
DynFilterQ2	Shows the dates that are in the 2nd calendar quarter, regardless of year.
DynFilterQ3	Shows the dates that are in the 3rd calendar quarter, regardless of year.
DynFilterQ4	Shows the dates that are in the 4th calendar quarter, regardless of year.
DynFilterThisMonth	Shows this month's dates.
DynFilterThisQuarter	Shows this calendar quarter's dates.
DynFilterThisWeek	Shows this week's dates, using Sunday as the first weekday.
DynFilterThisYear	Shows this year's dates.
DynFilterToday	Shows today's dates.
DynFilterTomorrow	Shows tomorrow's dates.
DynFilterYearToDate	Shows the dates between the beginning of the year and today, inclusive.
DynFilterYesterday	Shows yesterday's dates.

AutoFilter
Fields _afRef :: Maybe CellRef _afFilterColumns :: Map Int FilterColumn