Skip to content

Commit 8aa72b6

Browse files
committed
docs: add more details and demos about default Filter operators
1 parent 97d3abf commit 8aa72b6

10 files changed

Lines changed: 138 additions & 13 deletions

File tree

docs/column-functionalities/filters/filter-intro.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,3 +69,28 @@ this.sgb.showHeaderRow(true);
6969
// or
7070
this.sgb.slickGrid.setHeaderRowVisibility(true);
7171
```
72+
73+
### Default Filter Functionality
74+
75+
The default filter is by default the `Filters.input` (when none is provided), is supporting the following operators: (`>`, `>=`, `<`, `<=`, `<>`, `!=`, `=`, `==`, `*`) that can be typed directly into the text filter, range filters can also have 1 of these options (`rangeInclusive` (default) or `rangeExclusive`). Also note that `<>` and `!=` are not aliased and have subtle differences. However the `=` and `==` are indeed aliases and equivalents.
76+
77+
Examples:
78+
- Number type
79+
- `>100` => bigger than 100
80+
- `<>100` => anything with the exception of 100
81+
- `15..44` => range between 15 and 44 (you can also provide option `rangeInclusive` (default) or `rangeExclusive`)
82+
- Date types
83+
- `>=2001-01-01` => greater or equal than date `2001-01-01`
84+
- `<02/28/17` => lower than date `02/28/17`
85+
- `2001-01-01..2002-02-22` => range between `2001-01-01` and `2002-02-22`
86+
- String type
87+
- `<>John` => not containing the sub-string `John`
88+
- `!=John` => not equal to the text `John` (note that this is **not** equivalent to `<>`)
89+
- `John*` => starts with the sub-string `John`
90+
- `*Doe` => ends with the sub-string `Doe`
91+
- `ab..ef` => anything included between `af` and `ef`
92+
- refer to the ASCII table for each character assigned index
93+
- `!= ` => get defined only data and exclude any `undefined`, `null` or empty string `' '`
94+
- notice the empty string in the search value `' '`
95+
96+
Note that you could also do the same kind of functionality by using the Compound Filter.

docs/column-functionalities/filters/input-filter.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Input text filter is the default filter that will be used when the user ommits t
1818
[Demo Page](https://ghiscoding.github.io/slickgrid-universal/#/example02) / [Demo Component](https://github.com/ghiscoding/slickgrid-universal/blob/master/demos/vanilla/src/examples/example02.ts)
1919

2020
### UI Usage
21-
All column types support the following operators: (`>`, `>=`, `<`, `<=`, `<>`, `!=`, `=`, `==`, `*`) that can be typed directly into the text filter, range filters can also have 1 of these options (`rangeInclusive` (default) or `rangeExclusive`). Also note that `<>` and `!=` are aliases and are equivalent, the same applies to `=` and `==`.
21+
All column types support the following operators: (`>`, `>=`, `<`, `<=`, `<>`, `!=`, `=`, `==`, `*`) that can be typed directly into the text filter, range filters can also have 1 of these options (`rangeInclusive` (default) or `rangeExclusive`). Also note that `<>` and `!=` are not aliased and have subtle differences. However the `=` and `==` are indeed aliases and equivalents.
2222

2323
Examples:
2424
- Number type
@@ -28,15 +28,15 @@ Examples:
2828
- Date types
2929
- `>=2001-01-01` => greater or equal than date `2001-01-01`
3030
- `<02/28/17` => lower than date `02/28/17`
31-
- `2001-01-01..2002-02-22` => range between 2001-01-01 and 2002-02-22
31+
- `2001-01-01..2002-02-22` => range between `2001-01-01` and `2002-02-22`
3232
- String type
3333
- `<>John` => not containing the sub-string `John`
3434
- `!=John` => not equal to the text `John` (note that this is **not** equivalent to `<>`)
3535
- `John*` => starts with the sub-string `John`
3636
- `*Doe` => ends with the sub-string `Doe`
37-
- `ab..ef` => anything included between "af" and "ef"
37+
- `ab..ef` => anything included between `af` and `ef`
3838
- refer to the ASCII table for each character assigned index
39-
- `!= ` => get defined only data and exclude any `undefined`, `null` or empty string `''`
39+
- `!= ` => get defined only data and exclude any `undefined`, `null` or empty string `' '`
4040
- notice the empty string in the search value `' '`
4141

4242
Note that you could also do the same kind of functionality by using the Compound Filter.

frameworks/angular-slickgrid/docs/column-functionalities/filters/filter-intro.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,4 +77,29 @@ hideFilterRow() {
7777
// you can show toggle the filter header row dynamically
7878
this.angularGrid.setHeaderRowVisibility(true);
7979
}
80-
```
80+
```
81+
82+
### Default Filter Functionality
83+
84+
The default filter is by default the `Filters.input` (when none is provided), is supporting the following operators: (`>`, `>=`, `<`, `<=`, `<>`, `!=`, `=`, `==`, `*`) that can be typed directly into the text filter, range filters can also have 1 of these options (`rangeInclusive` (default) or `rangeExclusive`). Also note that `<>` and `!=` are not aliased and have subtle differences. However the `=` and `==` are indeed aliases and equivalents.
85+
86+
Examples:
87+
- Number type
88+
- `>100` => bigger than 100
89+
- `<>100` => anything with the exception of 100
90+
- `15..44` => range between 15 and 44 (you can also provide option `rangeInclusive` (default) or `rangeExclusive`)
91+
- Date types
92+
- `>=2001-01-01` => greater or equal than date `2001-01-01`
93+
- `<02/28/17` => lower than date `02/28/17`
94+
- `2001-01-01..2002-02-22` => range between `2001-01-01` and `2002-02-22`
95+
- String type
96+
- `<>John` => not containing the sub-string `John`
97+
- `!=John` => not equal to the text `John` (note that this is **not** equivalent to `<>`)
98+
- `John*` => starts with the sub-string `John`
99+
- `*Doe` => ends with the sub-string `Doe`
100+
- `ab..ef` => anything included between `af` and `ef`
101+
- refer to the ASCII table for each character assigned index
102+
- `!= ` => get defined only data and exclude any `undefined`, `null` or empty string `' '`
103+
- notice the empty string in the search value `' '`
104+
105+
Note that you could also do the same kind of functionality by using the Compound Filter.

frameworks/angular-slickgrid/docs/column-functionalities/filters/input-filter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ Example:
3333
- `!=John` => not equal to the text `John` (note that this is **not** equivalent to `<>`)
3434
- `John*` => starts with the sub-string `John`
3535
- `*Doe` => ends with the sub-string `Doe`
36-
- `ab..ef` => anything included between "af" and "ef"
36+
- `ab..ef` => anything included between `af` and `ef`
3737
- refer to the ASCII table for each character assigned index
38-
- `!= ` => get defined only data and exclude any `undefined`, `null` or empty string `''`
38+
- `!= ` => get defined only data and exclude any `undefined`, `null` or empty string `' '`
3939
- notice the empty string in the search value `' '`
4040

4141
Note that you could do the same functionality with a Compound Filter.

frameworks/aurelia-slickgrid/docs/column-functionalities/filters/filter-intro.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,3 +81,28 @@ hideFilterRow() {
8181
this.gridObj.slickGrid.setHeaderRowVisibility(true);
8282
}
8383
```
84+
85+
### Default Filter Functionality
86+
87+
The default filter is by default the `Filters.input` (when none is provided), is supporting the following operators: (`>`, `>=`, `<`, `<=`, `<>`, `!=`, `=`, `==`, `*`) that can be typed directly into the text filter, range filters can also have 1 of these options (`rangeInclusive` (default) or `rangeExclusive`). Also note that `<>` and `!=` are not aliased and have subtle differences. However the `=` and `==` are indeed aliases and equivalents.
88+
89+
Examples:
90+
- Number type
91+
- `>100` => bigger than 100
92+
- `<>100` => anything with the exception of 100
93+
- `15..44` => range between 15 and 44 (you can also provide option `rangeInclusive` (default) or `rangeExclusive`)
94+
- Date types
95+
- `>=2001-01-01` => greater or equal than date `2001-01-01`
96+
- `<02/28/17` => lower than date `02/28/17`
97+
- `2001-01-01..2002-02-22` => range between `2001-01-01` and `2002-02-22`
98+
- String type
99+
- `<>John` => not containing the sub-string `John`
100+
- `!=John` => not equal to the text `John` (note that this is **not** equivalent to `<>`)
101+
- `John*` => starts with the sub-string `John`
102+
- `*Doe` => ends with the sub-string `Doe`
103+
- `ab..ef` => anything included between `af` and `ef`
104+
- refer to the ASCII table for each character assigned index
105+
- `!= ` => get defined only data and exclude any `undefined`, `null` or empty string `' '`
106+
- notice the empty string in the search value `' '`
107+
108+
Note that you could also do the same kind of functionality by using the Compound Filter.

frameworks/aurelia-slickgrid/docs/column-functionalities/filters/input-filter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ Example:
3333
- `!=John` => not equal to the text `John` (note that this is **not** equivalent to `<>`)
3434
- `John*` => starts with the sub-string `John`
3535
- `*Doe` => ends with the sub-string `Doe`
36-
- `ab..ef` => anything included between "af" and "ef"
36+
- `ab..ef` => anything included between `af` and `ef`
3737
- refer to the ASCII table for each character assigned index
38-
- `!= ` => get defined only data and exclude any `undefined`, `null` or empty string `''`
38+
- `!= ` => get defined only data and exclude any `undefined`, `null` or empty string `' '`
3939
- notice the empty string in the search value `' '`
4040

4141
Note that you could do the same functionality with a Compound Filter.

frameworks/slickgrid-react/docs/column-functionalities/filters/filter-intro.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,3 +78,28 @@ showFilterRow() {
7878
reactGridRef.current?.setHeaderRowVisibility(true);
7979
}
8080
```
81+
82+
### Default Filter Functionality
83+
84+
The default filter is by default the `Filters.input` (when none is provided), is supporting the following operators: (`>`, `>=`, `<`, `<=`, `<>`, `!=`, `=`, `==`, `*`) that can be typed directly into the text filter, range filters can also have 1 of these options (`rangeInclusive` (default) or `rangeExclusive`). Also note that `<>` and `!=` are not aliased and have subtle differences. However the `=` and `==` are indeed aliases and equivalents.
85+
86+
Examples:
87+
- Number type
88+
- `>100` => bigger than 100
89+
- `<>100` => anything with the exception of 100
90+
- `15..44` => range between 15 and 44 (you can also provide option `rangeInclusive` (default) or `rangeExclusive`)
91+
- Date types
92+
- `>=2001-01-01` => greater or equal than date `2001-01-01`
93+
- `<02/28/17` => lower than date `02/28/17`
94+
- `2001-01-01..2002-02-22` => range between `2001-01-01` and `2002-02-22`
95+
- String type
96+
- `<>John` => not containing the sub-string `John`
97+
- `!=John` => not equal to the text `John` (note that this is **not** equivalent to `<>`)
98+
- `John*` => starts with the sub-string `John`
99+
- `*Doe` => ends with the sub-string `Doe`
100+
- `ab..ef` => anything included between `af` and `ef`
101+
- refer to the ASCII table for each character assigned index
102+
- `!= ` => get defined only data and exclude any `undefined`, `null` or empty string `' '`
103+
- notice the empty string in the search value `' '`
104+
105+
Note that you could also do the same kind of functionality by using the Compound Filter.

frameworks/slickgrid-react/docs/column-functionalities/filters/input-filter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ Example:
3333
- `!=John` => not equal to the text `John` (note that this is **not** equivalent to `<>`)
3434
- `John*` => starts with the sub-string `John`
3535
- `*Doe` => ends with the sub-string `Doe`
36-
- `ab..ef` => anything included between "af" and "ef"
36+
- `ab..ef` => anything included between `af` and `ef`
3737
- refer to the ASCII table for each character assigned index
38-
- `!= ` => get defined only data and exclude any `undefined`, `null` or empty string `''`
38+
- `!= ` => get defined only data and exclude any `undefined`, `null` or empty string `' '`
3939
- notice the empty string in the search value `' '`
4040

4141
Note that you could do the same functionality with a Compound Filter.

frameworks/slickgrid-vue/docs/column-functionalities/filters/filter-intro.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,3 +84,28 @@ function showFilterRow() {
8484
vueGrid.setHeaderRowVisibility(true);
8585
}
8686
```
87+
88+
### Default Filter Functionality
89+
90+
The default filter is by default the `Filters.input` (when none is provided), is supporting the following operators: (`>`, `>=`, `<`, `<=`, `<>`, `!=`, `=`, `==`, `*`) that can be typed directly into the text filter, range filters can also have 1 of these options (`rangeInclusive` (default) or `rangeExclusive`). Also note that `<>` and `!=` are not aliased and have subtle differences. However the `=` and `==` are indeed aliases and equivalents.
91+
92+
Examples:
93+
- Number type
94+
- `>100` => bigger than 100
95+
- `<>100` => anything with the exception of 100
96+
- `15..44` => range between 15 and 44 (you can also provide option `rangeInclusive` (default) or `rangeExclusive`)
97+
- Date types
98+
- `>=2001-01-01` => greater or equal than date `2001-01-01`
99+
- `<02/28/17` => lower than date `02/28/17`
100+
- `2001-01-01..2002-02-22` => range between `2001-01-01` and `2002-02-22`
101+
- String type
102+
- `<>John` => not containing the sub-string `John`
103+
- `!=John` => not equal to the text `John` (note that this is **not** equivalent to `<>`)
104+
- `John*` => starts with the sub-string `John`
105+
- `*Doe` => ends with the sub-string `Doe`
106+
- `ab..ef` => anything included between `af` and `ef`
107+
- refer to the ASCII table for each character assigned index
108+
- `!= ` => get defined only data and exclude any `undefined`, `null` or empty string `' '`
109+
- notice the empty string in the search value `' '`
110+
111+
Note that you could also do the same kind of functionality by using the Compound Filter.

frameworks/slickgrid-vue/docs/column-functionalities/filters/input-filter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ Example:
3333
- `!=John` => not equal to the text `John` (note that this is **not** equivalent to `<>`)
3434
- `John*` => starts with the sub-string `John`
3535
- `*Doe` => ends with the sub-string `Doe`
36-
- `ab..ef` => anything included between "af" and "ef"
36+
- `ab..ef` => anything included between `af` and `ef`
3737
- refer to the ASCII table for each character assigned index
38-
- `!= ` => get defined only data and exclude any `undefined`, `null` or empty string `''`
38+
- `!= ` => get defined only data and exclude any `undefined`, `null` or empty string `' '`
3939
- notice the empty string in the search value `' '`
4040

4141
Note that you could do the same functionality with a Compound Filter.

0 commit comments

Comments
 (0)