Class StringFilterBuilder

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 .

Methods

Method Return type Brief description
setCaseSensitive(caseSensitive)
StringFilterBuilder Sets whether matching should be case sensitive or not.
setMatchType(matchType)
StringFilterBuilder 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 ).
setRealtimeTrigger(realtimeTrigger)
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).

Detailed documentation

setCaseSensitive(caseSensitive)

Sets whether matching should be case sensitive or not.

 // 
  
 Builds 
  
 a 
  
 case 
  
 insensitive 
  
 string 
  
 filter 
  
 to 
  
 filter 
  
 column 
  
 "Col1" 
 . 
 var 
  
 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 
 . 
 var 
  
 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 
 . 
 var 
  
 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.