Class RVVisualizationFilter

Class used to represent a visualization filter.

Hierarchy

  • RVVisualizationFilter

Index

Constructors

constructor

Accessors

dateRange

  • The date range used for filtering. When dateRuleType is CustomRange, it returns the custom range configured in the filter. When set to another filter type, it returns the range corresponding to the configured filter type calculated relative to the present time.

    Returns null | RVDateRange

  • The date range used for filtering. Only applicable when dateRuleType is CustomRange.

    Parameters

    Returns void

dateRuleType

  • Type of legacy rule for date filters having type "Filter By Rule".

    Returns null | RVDateFilterType

fieldName

  • get fieldName(): string
  • Name of the field to which the filter is bound.

    Returns string

filterType

  • get filterType(): RVFilterType
  • Type of the filter (All Values, Filter Empty Values, Selected Values, Filter By Rule).

    Returns RVFilterType

rule

  • Type of rule for date filters.

    Returns null | RVDateRule

selectedValues

  • get selectedValues(): object[]
  • set selectedValues(v: object[]): void
  • Get the filter's selected values as an array of string, integer or date, depending on the field type. An empty list means all available values are selected.

    Returns object[]

  • Set the filter's selected values. The list is to be specified as an array of string, integer or date, depending on the field type. An empty list means all available values are selected.

    Parameters

    • v: object[]

    Returns void

Methods

getFilterValues

  • Method used to get the possible values for a given filter. For a Country filter, this will return the list of all countries, not only the selected ones. You can use this method to create your own UI to select filter values.

    Returns Promise<RVFilterValue[]>

validateSelValuesFilter

  • validateSelValuesFilter(): void
  • Centralized check for actions that are only valid for filters of type SelectedValues.

    Returns void