Class RVVisualizationFilter

Class used to represent a visualization filter.

Index

Constructors

Accessors

Methods

Constructors

Accessors

  • get dateRange(): RVDateRange | null

    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 RVDateRange | null

  • set dateRange(value: RVDateRange | null): void

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

    Parameters

    Returns void

  • get fieldName(): string

    Name of the field to which the filter is bound.

    Returns string

  • get filterType(): RVFilterType

    Type of the filter (All Values, Filter Empty Values, Selected Values, Filter By Rule).

    Returns RVFilterType

  • get selectedValues(): object[]

    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 selectedValues(v: object[]): void

    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

  • 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[]>

  • Centralized check for actions that are only valid for filters of type SelectedValues.

    Returns void