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

Class Filter

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

Since

2.0

Hierarchy (view full)

DocumentNode
- Filter

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context FilteredRows IsAttached Modified Name Transactions TypeId As GetPropertyValue HasPropertyValue Reset

Methods

Cast

Cast<T1, T2>(this, type): 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 DocumentNode.Cast

Equals

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

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from DocumentNode.GetHashCode

ToString

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

Returns string
A string that represents the current object.

Inherited from DocumentNode.ToString

TryCast

TryCast<T1, T2>(this, type): 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 DocumentNode.TryCast

`Static`Equals

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

Default capability

Context

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

Returns INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

FilteredRows

get FilteredRows(): IndexSet
Gets the filtered rows.

Returns IndexSet
Since
2.0

IsAttached

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

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.IsAttached

Modified

get Modified(): boolean
Flag indicating whether the filter is modified.

Returns boolean
Since
2.0

Name

get Name(): string
Gets or sets the name of this filter. The filter name is the same as the name of the referenced data column.

Returns string
Since
2.0
set Name(value): void
Parameters
- value: string
Returns void

Transactions

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

Returns ITransactions
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Transactions

TypeId

get TypeId(): TypeIdentifier
Gets or sets the type identifier for the filter. By setting this property, the filter is converted to the specified type.

Returns TypeIdentifier
Since
2.0
set TypeId(value): void
Parameters
- value: TypeIdentifier
Returns void

As

As<T>(typeT): JsType<T>
Returns the filter implementation as specified type.
Type Parameters
- T extends FilterBase
Parameters
- typeT: TypeRefParam<T>
  Generic type argument
Returns JsType<T>
The filter implementation, or null.

Since
2.0

GetPropertyValue

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

HasPropertyValue

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

Reset

Reset(): void
Resets the filter. After calling this method, the filter does not filter out any rows.

Returns void
Since
2.0