Class CategoryFilterBuilder

CategoryFilterBuilder

A builder for category filter controls.

A category filter is a picker to choose one or more between a set of defined values. Given a column of type string, this control filters out the rows that don't match any of the picked values.

For more details, see the Gviz documentation.

Methods

MethodReturn typeBrief description
build()ControlBuilds a control.
setAllowMultiple(allowMultiple)CategoryFilterBuilderSets whether multiple values can be selected, rather than just one.
setAllowNone(allowNone)CategoryFilterBuilderSets whether the user is allowed not to choose any value.
setAllowTyping(allowTyping)CategoryFilterBuilderSets whether the user is allowed to type in a text field to narrow down the list of possible choices (via an autocompleter), or not.
setCaption(caption)CategoryFilterBuilderSets the caption to display inside the value picker widget when no item is selected.
setDataTable(tableBuilder)CategoryFilterBuilderSets the data table to use for the control using a DataTableBuilder.
setDataTable(table)CategoryFilterBuilderSets the control data table, which is the control's underlying data model.
setFilterColumnIndex(columnIndex)CategoryFilterBuilderSets the index of the data table column to filter on.
setFilterColumnLabel(columnLabel)CategoryFilterBuilderSets the label of the data table column to filter on.
setLabel(label)CategoryFilterBuilderSets the label to display next to the slider.
setLabelSeparator(labelSeparator)CategoryFilterBuilderSets a separator string appended to the label, to visually separate the label from the category picker.
setLabelStacking(orientation)CategoryFilterBuilderSets whether the label should display above (vertical stacking) or beside (horizontal stacking) the input field.
setSelectedValuesLayout(layout)CategoryFilterBuilderSets how to display selected values, when multiple selection is allowed.
setSortValues(sortValues)CategoryFilterBuilderSets whether the values to choose from should be sorted.
setValues(values)CategoryFilterBuilderSets the list of values (categories) the user can choose from.

Detailed documentation

build()

Builds a control.

Return

Control — A control object, that can be used as a UI element.


setAllowMultiple(allowMultiple)

Sets whether multiple values can be selected, rather than just one. The default value of this option is true (allowing multiple selection).

// Creates a category filter and disallows multiple value selection.
var builder = Charts.newCategoryFilter().setAllowMultiple(false);

Parameters

NameTypeDescription
allowMultipleBooleanIf false, the user can't select multiple values.

Return

CategoryFilterBuilder — This builder, useful for chaining.


setAllowNone(allowNone)

Sets whether the user is allowed not to choose any value. If false the user must choose at least one value from the available ones. The default value is true.

// Creates a category filter and force the user to choose at least one value.
var builder = Charts.newCategoryFilter().setAllowNone(false);

Parameters

NameTypeDescription
allowNoneBooleanIf false, the user must choose at least one value.

Return

CategoryFilterBuilder — This builder, useful for chaining.


setAllowTyping(allowTyping)

Sets whether the user is allowed to type in a text field to narrow down the list of possible choices (via an autocompleter), or not. Defaults to true (allowing the user to type in values in the picker).

// Creates a category filter and disallows the user from typing in text to filter the values,
// so the user must use the drop down to pick values.
var builder = Charts.newCategoryFilter().setAllowTyping(false);

Parameters

NameTypeDescription
allowTypingBooleanIf false, the user can't type in a text field to narrow down the list of possible choices.

Return

CategoryFilterBuilder — This builder, useful for chaining.


setCaption(caption)

Sets the caption to display inside the value picker widget when no item is selected.

// Creates a category filter with a caption.
var builder = Charts.newCategoryFilter().setCaption('select a value');

Parameters

NameTypeDescription
captionStringThe caption to display inside the value picker widget when no item is selected.

Return

CategoryFilterBuilder — This builder, useful for chaining.


setDataTable(tableBuilder)

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

Parameters

NameTypeDescription
tableBuilderDataTableBuilderA data table builder. A new data table is created instantly as part of this call, so any further updates to the builder won't be reflected in the control.

Return

CategoryFilterBuilder — This builder, useful for chaining.


setDataTable(table)

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

Parameters

NameTypeDescription
tableDataTableSourceThe data table to use for the control.

Return

CategoryFilterBuilder — This builder, useful for chaining.


setFilterColumnIndex(columnIndex)

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

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

Parameters

NameTypeDescription
columnIndexIntegerThe index of the data table column the filter should operate upon.

Return

CategoryFilterBuilder — This builder, useful for chaining.


setFilterColumnLabel(columnLabel)

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

The values of that column determine whether or not each row should be filtered. It is mandatory to set either this or a column index using setFilterColumnIndex(columnIndex).

Parameters

NameTypeDescription
columnLabelStringThe label of the column to filter on.

Return

CategoryFilterBuilder — This builder, useful for chaining.


setLabel(label)

Sets the label to display next to the slider.

If unspecified, the label of the column the control operates on is used.

Parameters

NameTypeDescription
labelStringThe label to display next to the slider.

Return

CategoryFilterBuilder — This builder, useful for chaining.


setLabelSeparator(labelSeparator)

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

Parameters

NameTypeDescription
labelSeparatorStringThe string to use to separate the label from the category picker.

Return

CategoryFilterBuilder — This builder, useful for chaining.


setLabelStacking(orientation)

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

Parameters

NameTypeDescription
orientationOrientationThe orientation of the stacking.

Return

CategoryFilterBuilder — This builder, useful for chaining.


setSelectedValuesLayout(layout)

Sets how to display selected values, when multiple selection is allowed.

// Creates a category filter and sets it to display selected values below the picker.
var builder = Charts.newCategoryFilter()
    .setSelectedValuesLayout(Charts.PickerValuesLayout.BELOW);

Parameters

NameTypeDescription
layoutPickerValuesLayoutThe layout in which to display the selected values.

Return

CategoryFilterBuilder — This builder, useful for chaining.

See also


setSortValues(sortValues)

Sets whether the values to choose from should be sorted.

// Creates a category filter that sorts the values.
var builder = Charts.newCategoryFilter().setSortValues(true);

Parameters

NameTypeDescription
sortValuesBooleanIf true, sorts the values displayed in the widget alphabetically.

Return

CategoryFilterBuilder — This builder, useful for chaining.


setValues(values)

Sets the list of values (categories) the user can choose from.

// Creates a category filter with two choices.
var builder = Charts.newCategoryFilter().setValues(['choice 1','choice 2']);

Parameters

NameTypeDescription
valuesString[]The list of values the user can choose from.

Return

CategoryFilterBuilder — This builder, useful for chaining.

Envoyer des commentaires concernant…

Besoin d'aide ? Consultez notre page d'assistance.