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

Class VisualizationFilteringCollection

A list of data selections that are used to filter the data used in the visualization.

Since

2.0

Hierarchy (view full)

DocumentNode
- VisualizationFilteringCollection

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast [iterator] Equals

Default capability

Item Context Count IsAttached Transactions Add Contains GetEnumerator IndexOf Remove RemoveAt ReplaceAll

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

[iterator]

[iterator](): Iterator<DataSelection, any, undefined>
Returns Iterator<DataSelection, any, undefined>

`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

`Readonly`Item

Item: PropertyGet<number | Int32, DataSelection>

Gets the Spotfire.Dxp.Data.DataSelection at the specified index.

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 items in this collection.

Returns number
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(dataSelection): void
Adds the specified data selection to the collection if it doesn't already exists in the collection.
Parameters
- dataSelection: DataSelection
  The data selection.
Returns void
Since
2.0

Contains

Contains(dataSelection): boolean
Determines whether the specified data selection is part of the collection.
Parameters
- dataSelection: DataSelection
  The data selection.
Returns boolean
true if the specified data selection is part of the collection; otherwise, false.

Since
2.0

GetEnumerator

GetEnumerator(): System.Collections.Generic.IEnumerator<DataSelection>
Returns an enumerator that iterates through the collection.

Returns System.Collections.Generic.IEnumerator<DataSelection>
A System.Collections.Generic.IEnumerator that can be used to iterate through the collection.

Since
2.0

IndexOf

IndexOf(dataSelection): number
Returns the index of the item in the collection.
Parameters
- dataSelection: DataSelection
  The data selection.
Returns number
Since
2.0

Remove

Remove(dataSelection): boolean
Removes the specified data selection from the collection.
Parameters
- dataSelection: DataSelection
  The data selection.
Returns boolean
true if the selection was removed; otherwise false.

Since
2.0

RemoveAt

RemoveAt(index): void
Removes the data selection item at the specified index.
Parameters
- index: number | Int32
  The index.
Returns void
Since
2.0

ReplaceAll

ReplaceAll(dataSelections): void
Replaces the contents of this collection with the elements in the specified dataSelectionscollection.
Parameters
- dataSelections: OrExplicit<System.Collections.Generic.IEnumerable<DataSelection>>
  The collection of Spotfire.Dxp.Data.DataSelections.
Returns void
Since
2.0