| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Codec.Xlsx.Types.AutoFilter
Synopsis
- data FilterColumn
- = Filters FilterByBlank [FilterCriterion]
- | ColorFilter ColorFilterOptions
- | ACustomFilter CustomFilter
- | CustomFiltersOr CustomFilter CustomFilter
- | CustomFiltersAnd CustomFilter CustomFilter
- | DynamicFilter DynFilterOptions
- | IconFilter (Maybe Int) IconSetType
- | BottomNFilter EdgeFilterOptions
- | TopNFilter EdgeFilterOptions
- data FilterByBlank
- data FilterCriterion
- data DateGroup
- data CustomFilter = CustomFilter {}
- data CustomFilterOperator
- data EdgeFilterOptions = EdgeFilterOptions {}
- data ColorFilterOptions = ColorFilterOptions {
- _cfoCellColor :: Bool
- _cfoDxfId :: Maybe Int
- data DynFilterOptions = DynFilterOptions {}
- 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 :: Lens' AutoFilter (Maybe CellRef)
- afFilterColumns :: Lens' AutoFilter (Map Int FilterColumn)
- 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. |
| 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
data FilterByBlank Source #
Constructors
| FilterByBlank | |
| DontFilterByBlank |
Instances
data FilterCriterion Source #
Constructors
| FilterValue Text | |
| FilterDateGroup DateGroup |
Instances
Used to express a group of dates or times which are used in an AutoFilter criteria
Section 18.3.2.4 "dateGroupItem (Date Grouping)" (p. 1714)
Constructors
| 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 |
Instances
data CustomFilter Source #
Constructors
| CustomFilter | |
Fields | |
Instances
data CustomFilterOperator Source #
Constructors
| 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. |
Instances
data EdgeFilterOptions Source #
Constructors
| EdgeFilterOptions | |
Fields
| |
Instances
data ColorFilterOptions Source #
Specifies the color to filter by and whether to use the cell's fill or font color in the filter criteria. If the cell's font or fill color does not match the color specified in the criteria, the rows corresponding to those cells are hidden from view.
See 18.3.2.1 "colorFilter (Color Filter Criteria)" (p. 1712)
Constructors
| ColorFilterOptions | |
Fields
| |
Instances
data DynFilterOptions Source #
Specifies dynamic filter criteria. These criteria are considered dynamic because they can change, either with the data itself (e.g., "above average") or with the current system date (e.g., show values for "today"). For any cells whose values do not meet the specified criteria, the corresponding rows shall be hidden from view when the filter is applied.
_dfoMaxVal shall be required for DynFilterTday,
DynFilterYesterday, DynFilterTomorrow, DynFilterNextWeek,
DynFilterThisWeek, DynFilterLastWeek, DynFilterNextMonth,
DynFilterThisMonth, DynFilterLastMonth, DynFilterNextQuarter,
DynFilterThisQuarter, DynFilterLastQuarter,
DynFilterNextYear, DynFilterThisYear, DynFilterLastYear, and
'DynFilterYearToDate.
The above criteria are based on a value range; that is, if today's
date is September 22nd, then the range for thisWeek is the values
greater than or equal to September 17 and less than September
24. In the thisWeek range, the lower value is expressed
_dfoval. The higher value is expressed using _dfoMmaxVal.
These dynamic filters shall not require '_dfoVal or _dfoMaxVal:
DynFilterQ1, DynFilterQ2, DynFilterQ3, DynFilterQ4,
DynFilterM1, DynFilterM2, DynFilterM3, DynFilterM4,
DynFilterM5, DynFilterM6, DynFilterM7, DynFilterM8,
DynFilterM9, DynFilterM10, DynFilterM11 and DynFilterM12.
The above criteria shall not specify the range using valIso and maxValIso because Q1 always starts from M1 to M3, and M1 is always January.
These types of dynamic filters shall use valIso and shall not use
_dfoMaxVal: DynFilterAboveAverage and DynFilterBelowAverage
Note: Specification lists valIso and maxIso to store datetime
values but it appears that Excel doesn't use them and stored them
as numeric values (as it does for datetimes in cell values)
See 18.3.2.5 "dynamicFilter (Dynamic Filter)" (p. 1715)
Constructors
| DynFilterOptions | |
Fields
| |
Instances
data DynFilterType Source #
Specifies concrete type of dynamic filter used
See 18.18.26 "ST_DynamicFilterType (Dynamic Filter)" (p. 2452)
Constructors
| 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. |
Instances
data AutoFilter Source #
AutoFilter temporarily hides rows based on a filter criteria, which is applied column by column to a table of datain the worksheet.
TODO: sortState, extList
See 18.3.1.2 "autoFilter (AutoFilter Settings)" (p. 1596)
Constructors
| AutoFilter | |
Fields | |
Instances
afFilterColumns :: Lens' AutoFilter (Map Int FilterColumn) Source #
fltColFromNode :: Node -> [FilterColumn] Source #
filterCriterionFromNode :: Node -> [FilterCriterion] Source #
fltColToElement :: FilterColumn -> Element Source #
edgeFilter :: Bool -> EdgeFilterOptions -> Element Source #
filterCriterionToElement :: FilterCriterion -> Element Source #