Class StringFilterBuilder
Stay organized with collections
Save and categorize content based on your preferences.
StringFilterBuilder
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.
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 |
caseSensitive | Boolean | If true, enables string matching case sensitivity. |
Return
StringFilterBuilder — This builder, useful for chaining.
setMatchType(matchType)
Sets whether the control should match exact values only (MatchType.EXACT), prefixes
starting from the beginning of the value (MatchType.PREFIX), or any substring
(MatchType.ANY).
// 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 |
matchType | MatchType | The string matching type. |
Return
StringFilterBuilder — 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 |
realtimeTrigger | Boolean | If true, sets events to be triggered at real time (when a key is
pressed). |
Return
StringFilterBuilder — This builder, useful for chaining.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-02 UTC.
[null,null,["Last updated 2024-12-02 UTC."],[[["\u003cp\u003eStringFilterBuilder helps create string filter controls for filtering data in Google Charts.\u003c/p\u003e\n"],["\u003cp\u003eIt offers options to control matching behavior, including case sensitivity, match type (exact, prefix, or any substring), and real-time triggering.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can customize the filter by setting properties like \u003ccode\u003ecaseSensitive\u003c/code\u003e, \u003ccode\u003ematchType\u003c/code\u003e, and \u003ccode\u003erealtimeTrigger\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe builder pattern allows for chaining methods for convenient and readable filter configuration.\u003c/p\u003e\n"],["\u003cp\u003eRefer to the Gviz documentation for more in-depth information and examples.\u003c/p\u003e\n"]]],[],null,["# Class StringFilterBuilder\n\nStringFilterBuilder\n\nA builder for string filter controls.\n\nA string filter is a simple text input field that lets the user filter data via string\nmatching. Given a column of type string and matching options, this control filters out the rows\nthat don't match the term that's in the input field.\n\nFor more details, see the Gviz [documentation](https://developers.google.com/chart/interactive/docs/gallery/controls#stringfilter). \n\n### Methods\n\n| Method | Return type | Brief description |\n|---------------------------------------------------------------------|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [setCaseSensitive(caseSensitive)](#setCaseSensitive(Boolean)) | [StringFilterBuilder](#) | Sets whether matching should be case sensitive or not. |\n| [setMatchType(matchType)](#setMatchType(MatchType)) | [StringFilterBuilder](#) | Sets whether the control should match exact values only ([MatchType.EXACT](/apps-script/reference/charts/match-type#EXACT)), prefixes starting from the beginning of the value ([MatchType.PREFIX](/apps-script/reference/charts/match-type#PREFIX)), or any substring ([MatchType.ANY](/apps-script/reference/charts/match-type#ANY)). |\n| [setRealtimeTrigger(realtimeTrigger)](#setRealtimeTrigger(Boolean)) | [StringFilterBuilder](#) | 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). |\n\nDetailed documentation\n----------------------\n\n### `set``Case``Sensitive(caseSensitive)`\n\nSets whether matching should be case sensitive or not.\n\n```javascript\n// Builds a case insensitive string filter to filter column \"Col1\".\nconst stringFilter = Charts.newStringFilter()\n .setFilterColumnLabel('Col1')\n .setCaseSensitive(false)\n .build();\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|-------------------|-----------|------------------------------------------------------|\n| `case``Sensitive` | `Boolean` | If `true`, enables string matching case sensitivity. |\n\n#### Return\n\n\n[StringFilterBuilder](#) --- This builder, useful for chaining.\n\n*** ** * ** ***\n\n### `set``Match``Type(matchType)`\n\nSets whether the control should match exact values only ([MatchType.EXACT](/apps-script/reference/charts/match-type#EXACT)), prefixes\nstarting from the beginning of the value ([MatchType.PREFIX](/apps-script/reference/charts/match-type#PREFIX)), or any substring\n([MatchType.ANY](/apps-script/reference/charts/match-type#ANY)).\n\n```javascript\n// Builds a string filter to filter column \"Col1\" matching the prefix.\nconst stringFilter = Charts.newStringFilter()\n .setFilterColumnLabel('Col1')\n .setMatchType(Charts.MatchType.PREFIX)\n .build();\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|---------------|-------------------------------------------------------|---------------------------|\n| `match``Type` | [MatchType](/apps-script/reference/charts/match-type) | The string matching type. |\n\n#### Return\n\n\n[StringFilterBuilder](#) --- This builder, useful for chaining.\n\n#### See also\n\n- [MatchType](/apps-script/reference/charts/match-type)\n\n*** ** * ** ***\n\n### `set``Realtime``Trigger(realtimeTrigger)`\n\nSets whether the control should match any time a key is pressed or only when the input field\n'changes' (loss of focus or pressing the Enter key).\n\n```javascript\n// Builds a string filter to filter column \"Col1\" that checks the match any time\n// a key is pressed.\nconst stringFilter = Charts.newStringFilter()\n .setFilterColumnLabel('Col1')\n .setRealtimeTrigger(true)\n .build();\n```\n\n#### Parameters\n\n| Name | Type | Description |\n|---------------------|-----------|------------------------------------------------------------------------------|\n| `realtime``Trigger` | `Boolean` | If `true`, sets events to be triggered at real time (when a key is pressed). |\n\n#### Return\n\n\n[StringFilterBuilder](#) --- This builder, useful for chaining."]]
