Class RangeFilter

Representation of a RangeFilter. Range Filters are associated with one data column given by the Spotfire.Dxp.Application.Filters.ColumnFilter.DataColumnReference property. The Spotfire.Dxp.Application.Filters.RangeFilter.ValueRange of the filter, represents the filtering performed by the filter. When the filter is created, this range is set to the extreme (minimum and maximum) values found in the target column.

The granularity of filtering in a RangeFilter can be adjusted using the Spotfire.Dxp.Application.Filters.RangeFilter.ValueDataRange property. Narrowing this range will cause the filter to "zoom in" and only apply on the values therein. Note that this is graphically visualized in the Filter using three dots.

A Range Filter can be applied to a column independent of its value type. Nevertheless, the visual scales supported by the filter are limited by value types. For instance, the Logarithmic scale can only be applied to numeric columns. To query the valid scales on a filter, use the Spotfire.Dxp.Application.Filters.RangeFilter.ValidVisualScales property.

Since

2.0

Hierarchy (view full)

Implements

Accessors

FilteredRows TypeId

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context DataColumnReference HasEmptyValues IncludeEmpty IsAttached Transactions ValidVisualScales ValueDataRange ValueRange VisualScale GetPropertyValue HasPropertyValue Reset ResetDataRange StepBodyDown StepBodyUp StepHighLimitDown StepHighLimitUp StepLowLimitDown StepLowLimitUp TrimSelection

Accessors

FilteredRows

  • get FilteredRows(): IndexSet

  • Gets the filtered rows.

    Returns IndexSet

TypeId

Methods

Cast

  • Cast<T1, T2>(this, type): T1

  • Casts this object to the specified type. Throws error on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns T1

Equals

  • Equals(obj): boolean

  • Determines whether the specified object is equal to the current object.

    Parameters

    • obj: any

      The object to compare with the current object.

    Returns boolean

    true if the specified object is equal to the current object; otherwise, false.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • Casts this object to the specified type. Returns null on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns null | T1

StaticEquals

  • Equals(objA, objB): boolean

  • Determines whether the specified object instances are considered equal.

    Parameters

    • objA: any

      The first object to compare.

    • objB: any

      The second object to compare.

    Returns boolean

    true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Default capability

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

DataColumnReference

  • get DataColumnReference(): null | DataColumn

  • Gets the column instance associated with this filter.

    Returns null | DataColumn

    Since

    2.0

HasEmptyValues

  • get HasEmptyValues(): boolean

  • Gets a value indicating whether the referenced column has any invalid rows.

    Returns boolean

    Since

    2.0

IncludeEmpty

  • get IncludeEmpty(): boolean

  • Gets or sets a value indicating whether or not the filter should include empty value rows.

    Returns boolean

    Since

    2.0

  • set IncludeEmpty(value): void

  • Parameters

    • value: boolean

    Returns void

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

Transactions

  • get Transactions(): ITransactions

  • Gets a collection of methods for executing transactions on the document.

    Returns ITransactions

    Since

    2.0

ValidVisualScales

ValueDataRange

  • get ValueDataRange(): ValueRange

  • Gets or sets this range filter's min and max value.

    Returns ValueRange

    Since

    2.0

  • set ValueDataRange(value): void

  • Parameters

    Returns void

ValueRange

  • get ValueRange(): ValueRange

  • Gets or sets the value range for the filter.

    Returns ValueRange

    Since

    2.0

  • set ValueRange(value): void

  • Parameters

    Returns void

VisualScale

  • get VisualScale(): VisualScale

  • Gets or sets the current scale transformation of the filter.

    Returns VisualScale

    Since

    2.0

  • set VisualScale(value): void

  • Parameters

    Returns void

GetPropertyValue

  • GetPropertyValue(propertyName): unknown

  • Gets the value of a specified property.

    Parameters

    • propertyName: string | String

      The property name, case insensitive.

    Returns unknown

    The property value.

    Since

    2.0

HasPropertyValue

  • HasPropertyValue(propertyName): boolean

  • Checks if there is a valid value for a specified property.

    Parameters

    • propertyName: string | String

      The property name, case insensitive.

    Returns boolean

    true if the property has a valid value, otherwise false.

    Since

    2.0

Reset

  • Reset(): void

  • Resets the filter. After calling this method, the filter does not filter out any rows.

    Returns void

    Since

    2.0

ResetDataRange

  • ResetDataRange(): void

  • Resets the filter data range to the extreme values in the column.

    Returns void

    Since

    2.0

StepBodyDown

  • StepBodyDown(): void

  • Steps both low and high limit to the previous values. If the lower range is already at its minimum, calling this method will have no effect.

    Returns void

    Since

    2.0

StepBodyUp

  • StepBodyUp(): void

  • Steps both low and high limit to the next values. If the upper range is already at its maximum, calling this method will have no effect.

    Returns void

    Since

    2.0

StepHighLimitDown

  • StepHighLimitDown(): void

  • Steps the high limit down to previous value.

    Returns void

    Since

    2.0

StepHighLimitUp

  • StepHighLimitUp(): void

  • Steps the high limit up to next value.

    Returns void

    Since

    2.0

StepLowLimitDown

  • StepLowLimitDown(): void

  • Steps the low limit down to previous value.

    Returns void

    Since

    2.0

StepLowLimitUp

  • StepLowLimitUp(): void

  • Steps the low limit up to next value.

    Returns void

    Since

    2.0

TrimSelection

  • TrimSelection(): void

  • Trims the value range of the filter to only contain filtered values.

    Returns void

    Since

    2.0

Settings

Member Visibility

On This Page

Accessors
Methods
Default capability