Action
    Preparing search index...

    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.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

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

    Methods

    • 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

    • 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.

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • 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

    • 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

    • get Context(): INodeContext

      Gets the context of this node.

      Returns INodeContext

      2.0

    • get DataColumnReference(): null | DataColumn

      Gets the column instance associated with this filter.

      Returns null | DataColumn

      2.0

    • get FilteredRows(): IndexSet

      Gets the filtered rows.

      Returns IndexSet

      2.0

    • get HasEmptyValues(): boolean

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

      Returns boolean

      2.0

    • get IncludeEmpty(): boolean

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

      Returns boolean

      Settings this property to true on columns that do not contain empty values will have no effect.

      2.0

    • set IncludeEmpty(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get Transactions(): ITransactions

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

      Returns ITransactions

      2.0

    • get ValueDataRange(): ValueRange

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

      Returns ValueRange

      When the ValueDataRange is tightened, the Spotfire.Dxp.Application.Filters.RangeFilter.ValueRange is tightened equally to match the ValueDataRange. The ValueRange is however not set to the High and Low end-point values.

      The Range Filter visually represents custom value ranges that are less/greater that the default range with three dots.

      2.0

    • set ValueDataRange(value: ValueRange): void

      Parameters

      Returns void

    • Gets the value of a specified property.

      Parameters

      • propertyName: string | String

        The property name, case insensitive.

      Returns unknown

      The property value.

      2.0

    • 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.

      2.0

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

      Returns void

      2.0

    • 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

      2.0

    • 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

      2.0

    • Steps the high limit down to previous value.

      Returns void

      2.0

    • Steps the high limit up to next value.

      Returns void

      2.0

    • Steps the low limit down to previous value.

      Returns void

      2.0

    • Steps the low limit up to next value.

      Returns void

      2.0

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

      Returns void

      2.0

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability