A builder for string filter controls.
A string filter is a simple text input field that lets the user filter data via string matching. Given a column of type string and matching options, this control filters out the rows that don't match the term that's in the input field.
For more details, see the Gviz documentation.
Methods
| Method | Return type | Brief description |
|---|---|---|
set | String | Sets whether matching should be case sensitive or not. |
set | String | Sets whether the control should match exact values only (Match), prefixes
starting from the beginning of the value (Match), or any substring
(Match). |
set | String | Sets whether the control should match any time a key is pressed or only when the input field 'changes' (loss of focus or pressing the Enter key). |
Detailed documentation
setCaseSensitive(caseSensitive)
Sets whether matching should be case sensitive or not.
// Builds a case insensitive string filter to filter column "Col1". const stringFilter = Charts.newStringFilter() .setFilterColumnLabel('Col1') .setCaseSensitive(false) .build();
Parameters
| Name | Type | Description |
|---|---|---|
case | Boolean | If true, enables string matching case sensitivity. |
Return
String — This builder, useful for chaining.
setMatchType(matchType)
Sets whether the control should match exact values only (Match), prefixes
starting from the beginning of the value (Match), or any substring
(Match).
// Builds a string filter to filter column "Col1" matching the prefix. const stringFilter = Charts.newStringFilter() .setFilterColumnLabel('Col1') .setMatchType(Charts.MatchType.PREFIX) .build();
Parameters
| Name | Type | Description |
|---|---|---|
match | Match | The string matching type. |
Return
String — This builder, useful for chaining.
See also
setRealtimeTrigger(realtimeTrigger)
Sets whether the control should match any time a key is pressed or only when the input field 'changes' (loss of focus or pressing the Enter key).
// Builds a string filter to filter column "Col1" that checks the match any time // a key is pressed. const stringFilter = Charts.newStringFilter() .setFilterColumnLabel('Col1') .setRealtimeTrigger(true) .build();
Parameters
| Name | Type | Description |
|---|---|---|
realtime | Boolean | If true, sets events to be triggered at real time (when a key is
pressed). |
Return
String — This builder, useful for chaining.