core/datafilter/filtertypes/binary

Description:

  • Base filter for binary selector ie: (Yes / No).

Source:
Author:
Copyright:
  • 2022 Catalyst IT Australia Pty Ltd
License:
  • http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Base filter for binary selector ie: (Yes / No).

Members

optionOne :String

Description:

  • Text string for the first binary option.

    This option (and {@see optionTwo}) are set by {@see getTextValues()}. The base class will set default values, a subclass can override the method to define its own option.

Source:

Text string for the first binary option.

This option (and {@see optionTwo}) are set by {@see getTextValues()}. The base class will set default values, a subclass can override the method to define its own option.

Type:
  • String

optionTwo :String

Description:

  • Text string for the second binary option.

Source:

Text string for the second binary option.

Type:
  • String

values

Description:

  • Get the list of raw values for this filter type.

Source:

Get the list of raw values for this filter type.

Methods

(async) addValueSelector(initialValues)

Description:

  • Add the value selector to the filter row.

Source:
Parameters:
Name Type Description
initialValues Array

The default value for the filter.

(async) displayBinarySelection(initialValue)

Description:

  • Renders yes/no select input with proper selection.

Source:
Parameters:
Name Type Default Description
initialValue Number 0

The default value for the filter.

getTextValues() → {Promise}

Description:

  • Fetch text values for select options.

    Subclasses should override this method to set their own options.

Source:
Returns:
Type
Promise