About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class CheckBoxFilter

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

Since

2.0

Hierarchy (View Summary)

ColumnFilter
- CheckBoxFilter

Implements

Index

Methods

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): 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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from ColumnFilter.Cast

Equals

Equals(obj: any): 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.

Inherited from ColumnFilter.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from ColumnFilter.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from ColumnFilter.ToString

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): 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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from ColumnFilter.TryCast

`Static`Equals

Equals(objA: any, objB: any): 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.

Inherited from ColumnFilter.Equals

Default capability

Context

get Context(): INodeContext
Gets the context of this node.

Returns INodeContext
Since
2.0

Inherited from ColumnFilter.Context

DataColumnReference

get DataColumnReference(): null | DataColumn
Gets the column instance associated with this filter.

Returns null | DataColumn
Since
2.0

Inherited from ColumnFilter.DataColumnReference

FilteredRows

get FilteredRows(): IndexSet
Gets the filtered rows.

Returns IndexSet
Since
2.0

Inherited from ColumnFilter.FilteredRows

HasEmptyValues

get HasEmptyValues(): boolean
Gets a value indicating whether the referenced column has any invalid rows.

Returns boolean
Since
2.0

Inherited from ColumnFilter.HasEmptyValues

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: boolean): void
Parameters
- value: boolean
Returns void

IsAttached

get IsAttached(): boolean
Gets a value indicating whether this node is attached.

Returns boolean
Since
2.0

Inherited from ColumnFilter.IsAttached

Transactions

get Transactions(): ITransactions
Gets a collection of methods for executing transactions on the document.

Returns ITransactions
Since
2.0

Inherited from ColumnFilter.Transactions

TypeId

get TypeId(): TypeIdentifier
Gets the type id.

Returns TypeIdentifier
Since
2.0

Inherited from ColumnFilter.TypeId

Values

get Values(): System.Collections.IList
Gets a collection of the check box values.

Returns System.Collections.IList
Since
2.0

Check

Check(value: any): void
Checks the checkbox for value.
Parameters
- value: any
  The value to check.
Returns void
Since
2.0

GetPropertyValue

GetPropertyValue(propertyName: string | String): 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

Inherited from ColumnFilter.GetPropertyValue

HasPropertyValue

HasPropertyValue(propertyName: string | String): 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

Inherited from ColumnFilter.HasPropertyValue

IsChecked

IsChecked(value: any): boolean
Determines whether the specified value is checked.
Parameters
- value: any
  The value.
Returns boolean
true if the specified value is checked; otherwise, false. If the specified value is not among the available Spotfire.Dxp.Application.Filters.CheckBoxFilter.Values of this filter, false is returned.

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

Inherited from ColumnFilter.Reset

Uncheck

Uncheck(value: any): void
Unchecks the checkbox for value.
Parameters
- value: any
  The value to uncheck.
Returns void
Remark
To uncheck all values, use the Spotfire.Dxp.Application.Filters.CheckBoxFilter.UncheckAll method. It has better performance than a large number of consecutive calls to this method.

Since
2.0

UncheckAll

UncheckAll(): void
Unchecks the checkboxes for all values in this instance.

Returns void
Remark
To check just a few of the values in a check box filter, first call this method to uncheck all values followed by a few calls to Check(value) as desired.

Since
2.0