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

Class VisualizationSubsetCollection

Represents a collection of subsets that can be visualized next to each other in a visualization.

Since

2.0

Hierarchy (view full)

DocumentNode
- VisualizationSubsetCollection

Implements

Index

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<VisualizationSubset, any, undefined>
Returns Iterator<VisualizationSubset, 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, VisualizationSubset>

Gets the subset at the specified index.

Param: index

The zero-based index of the subset to get.

Returns

The subset at the specified index.

Since

2.0

All

get All(): DefaultVisualizationSubset
Gets the subset referring to all data.

Returns DefaultVisualizationSubset
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 instance.

Returns number
Since
2.0

Default

get Default(): DefaultVisualizationSubset
Gets the subset referring to the default filtering in the visualization.

Returns DefaultVisualizationSubset
Since
2.0

DefaultComplement

get DefaultComplement(): DefaultVisualizationSubset
Gets the subset referring to the complement of the default filtering in the visualization.

Returns DefaultVisualizationSubset
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

AddDataSelection

AddDataSelection(selection): DataSelectionVisualizationSubset
Adds a new subset based on a data selection.
Parameters
- selection: DataSelection
  The data selection. This can be either a Spotfire.Dxp.Data.DataMarkingSelection or a Spotfire.Dxp.Data.DataFilteringSelection
Returns DataSelectionVisualizationSubset
The new subset.

Since
2.0

AddWhereClauseExpression

AddWhereClauseExpression(whereClause): WhereClauseVisualizationSubset
Adds a subset based on a where clause expression.
Parameters
- whereClause: string | String
  The where clause.
Returns WhereClauseVisualizationSubset
The newly added where clause subset.

Since
2.0

Clear

Clear(): void
Removes all items but the default ones from this instance.

Returns void
Since
2.0

Contains

Contains(item): boolean
Determines whether this collection contains a specific value.
Parameters
- item: VisualizationSubset
  The subset.
Returns boolean
true if item is found in the System.Collections.Generic.ICollection; otherwise, false.

Since
2.0

GetEnumerator

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

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

Since
2.0

IndexOf

IndexOf(item): number
Determines the index of a specific item.
Parameters
- item: VisualizationSubset
  The object to locate.
Returns number
The index of item if found; otherwise, -1.

Since
2.0

Move

Move(fromIndex, toIndex): void
Moves the item at the specified index to a new location in the collection.
Parameters
- fromIndex: number | Int32
  The zero-based index specifying the location of the item to be moved.
- toIndex: number | Int32
  The zero-based index specifying the new location of the item.
Returns void
Since
2.0

Remove

Remove(item): boolean
Removes the occurrence of the specified subset from this instance.
Parameters
- item: VisualizationSubset
  The subset to remove.
Returns boolean
true if item was removed; otherwise, false. This method also returns false if item is not found.

Since
2.0

RemoveAt

RemoveAt(index): void
Removes the item at the specified index.
Parameters
- index: number | Int32
  The zero-based index of the item to remove.
Returns void
Since
2.0