RangeFilter Class

Spotfire 14.3 API Reference
Representation of a RangeFilter. Range Filters are associated with one data column given by the DataColumnReference property. The 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 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 ValidVisualScales property.

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Application.FiltersFilterBase
        Spotfire.Dxp.Application.FiltersColumnFilter
          Spotfire.Dxp.Application.FiltersRangeFilter

Namespace:  Spotfire.Dxp.Application.Filters
Assembly:  Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax

C#
[SerializableAttribute]
[PersistenceVersionAttribute(36, 0)]
[ToolContextAttribute]
public sealed class RangeFilter : ColumnFilter

The RangeFilter type exposes the following members.

Properties

  NameDescription
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyDataColumnReference
Gets the column instance associated with this filter.
(Inherited from ColumnFilter.)
Public propertyIncludeEmpty
Gets or sets a value indicating whether or not the filter should include empty value rows.
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Public propertyTypeId
Gets the type id.
(Overrides FilterBaseTypeId.)
Public propertyValidVisualScales
Gets a read-only list containing the valid scales that can be set on this filter.
Public propertyValueDataRange
Gets or sets this range filter's min and max value.
Public propertyValueRange
Gets or sets the value range for the filter.
Public propertyVisualScale
Gets or sets the current scale transformation of the filter.
Top
Methods

  NameDescription
Public methodGetPropertyValue
Gets the value of a specified property.
(Inherited from ColumnFilter.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodHasPropertyValue
Checks if there is a valid value for a specified property.
(Inherited from ColumnFilter.)
Public methodReset
Resets the filter to include a maximum range. This includes resetting the ValueRange and the ValueDataRange.
(Overrides FilterBaseReset.)
Public methodResetDataRange
Resets the filter data range to the extreme values in the column.
Public methodStepBodyDown
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.
Public methodStepBodyUp
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.
Public methodStepHighLimitDown
Steps the high limit down to previous value.
Public methodStepHighLimitUp
Steps the high limit up to next value.
Public methodStepLowLimitDown
Steps the low limit down to previous value.
Public methodStepLowLimitUp
Steps the low limit up to next value.
Public methodToString
Gets a text representation of this filter.
(Overrides ObjectToString.)
Public methodTrimSelection
Trims the value range of the filter to only contain filtered values.
Top
Explicit Interface Implementations

  NameDescription
Explicit interface implementationPrivate methodINodeContextGetAncestorT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextGetServiceT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextIsDescendantOf (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsBeginAggregatedTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction2
Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction2
Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction2
Implements ExecuteTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Top
Version Information

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also

Reference