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
Spotfire.Dxp.Framework.DocumentModelNode
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: 25.11.10401.3615 (25.11.10401.3615)
Syntax
C#
[SerializableAttribute] [ToolContextAttribute] [PersistenceVersionAttribute(11, 10)] public sealed class RangeFilter : ColumnFilter, IRangeFilter, IColumnFilter, IFilterBase
The RangeFilter type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
 | CreateEventRelay(PropertyName, StatelessDependencyDeclarer) |
Creates an event relay. An event relay is a property in the document model
which propagates event.
An event is raised for the event relay whenever when the trigger returned by the
specified dependencyDeclarer fires.
(Inherited from DocumentNode.) |
| CreateEventRelay(PropertyName, StatelessDependencyDeclarer, EventRelayMode) |
Creates an event relay. An event relay is a property in the document model
which propagates event.
An event is raised for the event relay whenever when the trigger returned by the
specified dependencyDeclarer fires.
(Inherited from DocumentNode.) |
| CreatePropertyT(PropertyName, UndoableListT) |
Creates an UndoableListT and assigns it to the specified field.
The UndoableListT will have the specified propertyName.
(Inherited from DocumentNode.) |
| CreatePropertyT(PropertyName, UndoableSetT) |
Creates an UndoableSetT and assigns it to the specified field.
The UndoableSetT will have the specified propertyName.
(Inherited from DocumentNode.) |
| CreatePropertyTNode(PropertyName, UndoableCrossReferencePropertyTNode, TNode) |
Creates an UndoableCrossReferencePropertyT and assigns it to the specified field.
The UndoableCrossReferencePropertyT will have the specified propertyName and initialValue.
(Inherited from DocumentNode.) |
| CreatePropertyT(PropertyName, UndoablePropertyT, T) |
Creates an UndoablePropertyT and assigns it to the specified field.
The UndoablePropertyT will have the specified propertyName and initialValue.
(Inherited from DocumentNode.) |
| CreatePropertyTKey, TValue(PropertyName, UndoableDictionaryTKey, TValue) |
Creates an UndoableDictionaryTKey, TValue and assigns it to the specified field.
The UndoableDictionaryTKey, TValue will have the specified propertyName.
(Inherited from DocumentNode.) |
| CreatePropertyTKey, TNode(PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) |
Creates an UndoableKeyedCollectionTKey, TNode and assigns it to the specified field.
The UndoableKeyedCollectionTKey, TNode will have the specified propertyName.
(Inherited from DocumentNode.) |
| CreateReadOnlyPropertyT |
Creates a read-only property of type T and assigns it to the specified field.
(Inherited from DocumentNode.) |
| CreateRuntimeConstantT |
Creates a runtime constant. A runtime constant is a property in the document model
whose value is computed once when first accessed. The value is then disposed
along with the DocumentNode.
(Inherited from DocumentNode.) |
| CreateRuntimePropertyT(PropertyName, RuntimePropertyT, DependencyDeclarer, PropertyComputerT) | Obsolete.
Creates a RuntimePropertyT.
(Inherited from DocumentNode.) |
| CreateRuntimePropertyT(PropertyName, RuntimePropertyT, StatelessDependencyDeclarer, StatelessPropertyComputerT) |
Creates a RuntimePropertyT.
(Inherited from DocumentNode.) |
| DeclareInternalEventHandlers | Override this method to declare handlers of internal events.
(Inherited from DocumentNode.) |
| DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableCrossReferencePropertyT) |
Deserializes an UndoableCrossReferencePropertyT with value of type T
stored in info with key propertyName.
(Inherited from DocumentNode.) |
| DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableListT) | (Inherited from DocumentNode.) |
| DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoablePropertyT) | (Inherited from DocumentNode.) |
| DeserializePropertyT(SerializationInfo, StreamingContext, PropertyName, UndoableSetT) | (Inherited from DocumentNode.) |
| DeserializePropertyTKey, TValue(SerializationInfo, StreamingContext, PropertyName, UndoableDictionaryTKey, TValue) | (Inherited from DocumentNode.) |
| DeserializePropertyTKey, TNode(SerializationInfo, StreamingContext, PropertyName, PropertyName, UndoableKeyedCollectionTKey, TNode) | (Inherited from DocumentNode.) |
| DeserializeReadOnlyPropertyT |
Deserializes a read-only property of type T
stored in info with key propertyName.
(Inherited from DocumentNode.) |
| DuplicateSubtreeT | Returns a copy of the sub tree spanned from this node that
has the same outwards non-owning references. The returned copy will
be in state New and is intended to be attached to the document
immediately. (Inherited from DocumentNode.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetPersistedTypeName | Can be used in the deserialization constructor to get the type name that the class
corresponding to this class had when it was originally serialized. Will return null
if the specified caller type has no correspondence in the serialized information
(Inherited from DocumentNode.) |
| GetPersistedVersion | Can be used in the deserialization constructor to get the persistence version that this class
was marked with when it was originally serialized. Will return null
if the specified caller type has no correspondence in the serialized information
(Inherited from DocumentNode.) |
 | GetPropertyValue | Gets the value of a specified property. (Inherited from ColumnFilter.) |
| GetService | Override this method to provide services accessible
from this node and its descendants.
If you can not provide the requested service, you should call
base.GetService which relays the request to the owner
or to the AnalysisApplication if no owner is set.
(Inherited from Node.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| HasPropertyValue |
Checks if there is a valid value for a specified property.
(Inherited from ColumnFilter.) |
| InternalTransaction |
Starts an internal transaction on the document model by
executing the specified executor delegate.
(Inherited from DocumentNode.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnConfigure |
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.) |
| OnConfigured |
Allows a node to configure itself to the surrounding document.
(Inherited from DocumentNode.) |
| OnReconfigure |
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.) |
| OnReconfigured |
Allows a node to reconfigure itself to a new part of the surrounding document.
(Inherited from DocumentNode.) |
| Reset |
Resets the filter to include a maximum range. This includes resetting
the ValueRange and the ValueDataRange.
(Overrides FilterBaseReset.) |
| ResetDataRange |
Resets the filter data range to the extreme values in the column.
|
| SerializePropertyT(SerializationInfo, StreamingContext, UndoableCrossReferencePropertyT) | Serializes an Undoable*Property with value of type T
storing it in info with key property.Name.
(Inherited from DocumentNode.) |
| SerializePropertyT(SerializationInfo, StreamingContext, UndoableListT) | Serializes an UndoableList with values of type T
storing it in info with key list.Name.
(Inherited from DocumentNode.) |
| SerializePropertyT(SerializationInfo, StreamingContext, UndoablePropertyT) | Serializes an UndoableProperty with value of type T
storing it in info with key property.Name.
(Inherited from DocumentNode.) |
| SerializePropertyT(SerializationInfo, StreamingContext, UndoableSetT) | Serializes an UndoableSet storing it in info
with key given by the property name of the set.
(Inherited from DocumentNode.) |
| SerializePropertyTKey, TValue(SerializationInfo, StreamingContext, UndoableDictionaryTKey, TValue) | Serializes an UndoableDictionary storing it in info
with key given by the property name of the dictionary.
(Inherited from DocumentNode.) |
| SerializePropertyTKey, TNode(SerializationInfo, StreamingContext, UndoableKeyedCollectionTKey, TNode) |
Serializes an UndoableKeyedCollectionTKey, TNode storing it in info
with key given by the property name of the keyedCollection.
(Inherited from DocumentNode.) |
| SerializeReadOnlyPropertyT |
Serializes a read-only property of type T
stored in info with key propertyName.
(Inherited from DocumentNode.) |
| StepBodyDown |
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.
|
| StepBodyUp |
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.
|
| StepHighLimitDown |
Steps the high limit down to previous value.
|
| StepHighLimitUp |
Steps the high limit up to next value.
|
| StepLowLimitDown |
Steps the low limit down to previous value.
|
| StepLowLimitUp |
Steps the low limit up to next value.
|
| ToString |
Gets a text representation of this filter.
(Overrides ObjectToString.) |
| TrimSelection |
Trims the value range of the filter to only contain filtered values.
|
| ValidateAttached | Validates that the node is attached.
(Inherited from DocumentNode.) |
Properties
| Name | Description | |
|---|---|---|
 | Context |
Gets the context of this node.
(Inherited from DocumentNode.) |
| DataColumnReference |
Gets the column instance associated with this filter.
(Inherited from ColumnFilter.) |
| FilteredRows |
Gets the filtered rows.
(Inherited from FilterBase.) |
| HasEmptyValues |
Gets a value indicating whether the referenced column has any invalid rows.
(Inherited from ColumnFilter.) |
| IncludeEmpty | Gets or sets a value indicating whether or not the filter should
include empty value rows.
|
| IsAttached |
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.) |
| Transactions |
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.) |
| TypeId | Gets the type id.
(Overrides FilterBaseTypeId.) |
| ValidVisualScales | Gets a read-only list containing the valid scales that can be set
on this filter.
|
| ValueDataRange | Gets or sets this range filter's min and max value.
|
| ValueRange | Gets or sets the value range for the filter.
|
| VisualScale | Gets or sets the current scale transformation of the filter.
|
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
  | IServiceProviderGetService |
Implements IServiceProvider.
(Inherited from Node.) |
| INodeContextGetAncestorT |
Implements GetAncestorT.
(Inherited from DocumentNode.) |
| INodeContextGetServiceT |
Implements GetServiceT.
(Inherited from DocumentNode.) |
| INodeContextIsDescendantOf |
Implements IsDescendantOf(DocumentNode).
(Inherited from DocumentNode.) |
| ITransactionsBeginAggregatedTransaction |
Implements BeginAggregatedTransaction.
(Inherited from DocumentNode.) |
| ITransactionsExecuteInvisibleTransaction |
Implements ExecuteInvisibleTransaction(Executor).
(Inherited from DocumentNode.) |
| ITransactionsExecuteStickyTransaction |
Implements ExecuteStickyTransaction(Guid, Executor).
(Inherited from DocumentNode.) |
| ITransactionsExecuteTransaction |
Implements ExecuteTransaction(Executor).
(Inherited from DocumentNode.) |
Version Information
See Also