Trait

com.google.appsscript.charts

StringFilterBuilder

Related Doc: package charts

Permalink

trait StringFilterBuilder extends Object

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 will filter out the rows that don't match the term that's in the input field. This example creates a table chart and binds it to a string filter. Using the filter, it is possible to change the table chart to display a subset of its data.

function doGet() { var app = UiApp.createApplication(); var sampleData = Charts.newDataTable() .addColumn(Charts.ColumnType.STRING, "Month") .addColumn(Charts.ColumnType.NUMBER, "Dining") .addColumn(Charts.ColumnType.NUMBER, "Total") .addRow(["Jan", 60, 520]) .addRow(["Feb", 50, 430]) .addRow(["Mar", 53, 440]) .addRow(["Apr", 70, 410]) .addRow(["May", 80, 390]) .addRow(["Jun", 60, 500]) .addRow(["Jul", 100, 450]) .addRow(["Aug", 140, 431]) .addRow(["Sep", 75, 488]) .addRow(["Oct", 70, 521]) .addRow(["Nov", 58, 388]) .addRow(["Dec", 63, 400]) .build();

var chart = Charts.newTableChart() .setDimensions(600, 500) .build();

var stringFilter = Charts.newStringFilter() .setFilterColumnLabel("Month") .setRealtimeTrigger(true) .setCaseSensitive(true) .setLabel("Filter months shown") .build();

var panel = app.createVerticalPanel().setSpacing(10); panel.add(stringFilter).add(chart);

// Create a dashboard panel to bind the filter and the chart together. var dashboard = Charts.newDashboardPanel() .setDataTable(sampleData) .bind(stringFilter, chart) .build();

dashboard.add(panel); app.add(dashboard); return app; }

For more details, see the Gviz documentation.

Annotations
@RawJSType()
Linear Supertypes
Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StringFilterBuilder
  2. Object
  3. Any
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def build(): Control

    Permalink

    Builds a control.

  6. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  11. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object
  12. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  13. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  14. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  15. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  17. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  19. def setCaseSensitive(caseSensitive: Boolean): StringFilterBuilder

    Permalink

    Sets whether matching should be case sensitive or not.

  20. def setDataTable(table: DataTableSource): StringFilterBuilder

    Permalink

    Sets the control data table, which will be the control's underlying data model.

  21. def setDataTable(tableBuilder: DataTableBuilder): StringFilterBuilder

    Permalink

    Sets the data table to use for the control using a DataTableBuilder.

    Sets the data table to use for the control using a DataTableBuilder. This is a convenience method for setting the data table without needing to call build().

  22. def setFilterColumnIndex(columnIndex: Int): StringFilterBuilder

    Permalink

    Sets the index of the data table column to filter on.

    Sets the index of the data table column to filter on. The values of that column will determine whether or not each row should be filtered. It is mandatory to set either this or the column label using setFilterColumnLabel(columnLabel).

  23. def setFilterColumnLabel(columnLabel: String): StringFilterBuilder

    Permalink

    Sets the label of the data table column to filter on.

    Sets the label of the data table column to filter on. The values of that column will determine whether or not each row should be filtered. It is mandatory to set either this or a column index using setFilterColumnIndex(columnIndex).

  24. def setLabel(label: String): StringFilterBuilder

    Permalink

    Sets the label to display next to the slider.

    Sets the label to display next to the slider. If unspecified, the label of the column the control operates on will be used.

  25. def setLabelSeparator(labelSeparator: String): StringFilterBuilder

    Permalink

    Sets a separator string appended to the label, to visually separate the label from the category picker.

  26. def setLabelStacking(orientation: Orientation): StringFilterBuilder

    Permalink

    Sets whether the label should display above (vertical stacking) or beside (horizontal stacking) the input field.

  27. def setMatchType(matchType: MatchType): StringFilterBuilder

    Permalink

    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).

  28. def setRealtimeTrigger(realtimeTrigger: Boolean): StringFilterBuilder

    Permalink

    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).

  29. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  30. def toLocaleString(): String

    Permalink
    Definition Classes
    Object
  31. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  32. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  33. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped