Class DataFilteringSelectionCollection

This a collection of the Spotfire.Dxp.Data.DataFilteringSelections. This collection can be retrieved from the Spotfire.Dxp.Data.DataManager.

Since

2.0

Hierarchy (View Summary)

DocumentNode
- DataFilteringSelectionCollection

Implements

Index

Methods

[iterator] Cast Equals GetHashCode ToString TryCast Equals

Default capability

Item Context Count DefaultFilteringReference IsAttached Transactions Add Contains GetEnumerator Remove TryGetValue

Methods

[iterator]

"[iterator]"(): Iterator<DataFilteringSelection>
Returns Iterator<DataFilteringSelection>

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

Default capability

`Readonly`Item

Item: PropertyGet<string | String, DataFilteringSelection>

Gets the filtering selection with the given name.

Param: name

The name of the filtering selection.

Returns

The data filtering selection.

Since

2.0

Context

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

Returns INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

Count

get Count(): number
Gets the number of filtering selections.

Returns number
Since
2.0

DefaultFilteringReference

get DefaultFilteringReference(): DataFilteringSelection
Gets the default filtering scheme.

Returns DataFilteringSelection
Remark
If the current filtering is requested, use Document.ActiveFilteringSelection.

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

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

Add

Add(name: string | String): DataFilteringSelection
Add a new filtering selection.
Parameters
- name: string | String
  The name of the new filtering selection.
Returns DataFilteringSelection
The newly created filtering selection.

Remark
The name of the marking selection has to be unique in all selections including selections in the Spotfire.Dxp.Data.DataMarkingSelectionCollection.

Since
2.0

Contains

Contains(name: string | String): boolean
Check if a filtering selection exists for the given name.
Parameters
- name: string | String
  The name of the filtering selection.
Returns boolean
True if the filtering selection exists, false otherwise.

Since
2.0

GetEnumerator

GetEnumerator(): System.Collections.Generic.IEnumerator<DataFilteringSelection>
Get a enumerator over the filtering selections.

Returns System.Collections.Generic.IEnumerator<DataFilteringSelection>
An enumerator over the filtering selections.

Since
2.0

Remove

Remove(dataSelection: DataFilteringSelection): void
Remove a filtering selection.
Parameters
- dataSelection: DataFilteringSelection
  The filtering selection to remove.
Returns void
Since
2.0

TryGetValue

TryGetValue(
name: string | String,
dataSelection: OutParam<DataFilteringSelection>,
): boolean
Try to get a filtering selection.
Parameters
- name: string | String
  The name of the filtering selection.
- dataSelection: OutParam<DataFilteringSelection>
  The filtering selection will be assigned to this parameter if it exists, null will be assigned otherwise.
Returns boolean
True if the filtering selection was retrieved, false otherwise.

Since
2.0

Class DataFilteringSelectionCollection

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Methods

[iterator]

Returns Iterator<DataFilteringSelection>

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns null | T1

StaticEquals

Parameters

Returns boolean

Default capability

ReadonlyItem

Param: name

Returns

Since

Context

Returns INodeContext

Since

Count

Returns number

Since

DefaultFilteringReference

Returns DataFilteringSelection

Remark

Since

IsAttached

Returns boolean

Since

Transactions

Returns ITransactions

Since

Add

Parameters

Returns DataFilteringSelection

Remark

Since

Contains

Parameters

Returns boolean

Since

GetEnumerator

Returns System.Collections.Generic.IEnumerator<DataFilteringSelection>

Since

Remove

Parameters

Returns void

Since

TryGetValue

Parameters

Returns boolean

Since

Settings

On This Page

`Static`Equals

`Readonly`Item