Spotfire.Dxp.Application.Filters Namespace

Representation of the Check Box Filter. The check box filter allows for one or more values to be selected through a check box control.

Contains property name constants for the public properties of CheckBoxFilter.

Representation of the Check Box Hierarchy Filter.

Contains property name constants for the public properties of CheckBoxHierarchyFilter.

This class is an implementation detail and should never be used directly. Instead, always use one of the concrete filter classes: CheckBoxFilter, ItemFilter, RadioButtonFilter, RangeFilter and TextFilter

Contains property name constants for the public properties of ColumnFilter.

The Filter class contains a specific filter implementation. The type of filter is controlled by the property TypeId.

Contains property name constants for the public properties of Filter.

This class is an implementation detail and should never be used directly. Instead, always use one of the concrete filter classes: CheckBoxFilter, CheckBoxHierarchyFilter, ItemFilter, RadioButtonFilter, RangeFilter, TextFilter and ListBoxFilter.

Contains property name constants for the public properties of Filter.

The FilterCollection contains the Filters for a specific DataTable in a FilteringScheme.

Contains property name constants for the public properties of FilterCollection.

A container for one or more FilterHandles which can be placed into a FilterPanel to group filters. A FilterGroup is uniquely identified by its name within any given panel.

Contains property name constants for the public properties of FilterGroup.

Base class for items contained in a FilterGroup.

Contains property name constants for the public properties of FilterGroupItem.

Collection class for FilterGroupItems.

Contains property name constants for the public properties of FilterGroupItemCollection.

A FilterHandle represents a Filter when it is placed inside a FilterGroup.

Contains property name constants for the public properties of FilterHandle.

A FilteringScheme contains Spotfire.Dxp.Application.Filters separated in FilterCollections for each DataTable in the Document.

Contains property name constants for the public properties of FilteringScheme.

Collection of all FilteringSchemes in this Document.

Contains property name constants for the public properties of FilteringSchemeCollection.

A Filter Panel represents the contents of the Spotfire control panel that can contain the data filters.

Each Filter Panel contains one or more filter groups in which the filters are placed. These groups and the filters in them are accessible through the TableGroups property.

Contains property name constants for the public properties of FilterPanel.

A specialization of the FilterGroup, representing the subgroups within a FilterPanel which can be added to a FilterGroup in TableGroups. New subgroups are created using the AddNewSubGroup(String) method.

Defines the identifiers for built-in filters.

This class is an implementation detail and should never be used directly. Instead, always use the CheckBoxHierarchyFilter.

Contains property name constants for the public properties of HierarchyFilter.

Representation of an ItemFilter. The item filter has the ability to filter on a single value in the column that is applies on. The value that is being filtered on is given by Value.

In addition to the distinct values in the DataColumnReference, the Item Filter can filter on the special values given by the ItemFiltering enumeration. The All value is the default value of an Item Filter. The None value is the last value in an Item Filter. The Empty value is only used when the filter column contains empty values.

Contains property name constants for the public properties of ItemFilter.

Represents a list box filter. A list box filter allows multiple selection and searching while preserving space. This filter can handle a large amount of categorical values.

Contains property name constants for the public properties of ListBoxFilter.

Representation of the Radio Button Filter. Similar to the ItemFilter, this filter can filter on single values in the column that the filter is being applied on. Graphically, the values in the column are represented as radio buttons.

Contains property name constants for the public properties of RadioButtonFilter.

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.

Contains property name constants for the public properties of RangeFilter.

Base class for column filter that are used to filter on a single value.

Contains property name constants for the public properties of SingleValueColumnFilter.

A specialization of the FilterGroup, representing one root group that exists within a FilterPanel and that can be accessed through the TableGroups property. In addition to the functionality of standard groups, the root group can contain one or more subgroups. Subgroups are added using the AddNewSubGroup(String) method. Additionally, the root filter group is special in the sense that is cannot be renamed.

Contains property name constants for the public properties of TableGroup.

Collection class for TableGroups.

Contains property name constants for the public properties of TableGroupCollection.

Representation of a TextFilter which uses a search expression to match values from its column.

Contains property name constants for the public properties of TextFilter.

A ValueRange represents an interval in a scale containing values of arbitrary types. The range is defined by the properties High and Low.

The special values that an ItemFilter or RadioButtonFilter may filter.

Symbolic values for the end points of a ValueRange.

Enumeration specifying the valid scale transformations available.