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

Class DataMarkingSelectionCollection

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

Since

2.0

Hierarchy (View Summary)

DocumentNode
- DataMarkingSelectionCollection

Implements

Index

Methods

[iterator] Cast Equals GetHashCode ToString TryCast Equals

Default capability

Item Context Count DefaultMarkingReference IsAttached Transactions Add Contains ForEachNodeInSubTree GetEnumerator Remove TryGetValue

Methods

[iterator]

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

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, DataMarkingSelection>

Get a data marking selection from a name.

Param: name

The name of the marking selection.

Returns

The marking 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 marking selections.

Returns number
Since
2.0

DefaultMarkingReference

get DefaultMarkingReference(): DataMarkingSelection
Get or set the default marking.

Returns DataMarkingSelection
Remark
If the active marking is required then this property should not be used but use Spotfire.Dxp.Application.Document.ActiveMarkingSelectionReference instead.

Since
2.0
set DefaultMarkingReference(value: DataMarkingSelection): void
Parameters
- value: DataMarkingSelection
Returns void

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): DataMarkingSelection
Add a new data marking selection.
Parameters
- name: string | String
  The name of the new data marking selection.
Returns DataMarkingSelection
The new data marking selection.

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

Since
2.0

Contains

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

Since
2.0

ForEachNodeInSubTree

ForEachNodeInSubTree<TNode>(
typeTNode: TypeRefParam<TNode>,
action: Action<TNode>,
): void
Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node.
Type Parameters
- TNode
Parameters
- typeTNode: TypeRefParam<TNode>
  Generic type argument
- action: Action<TNode>
  The action to apply.
Returns void
Since
2.1

Inherited from DocumentNode.ForEachNodeInSubTree

GetEnumerator

GetEnumerator(): System.Collections.Generic.IEnumerator<DataMarkingSelection>
Enumerate over the data marking selections.

Returns System.Collections.Generic.IEnumerator<DataMarkingSelection>
The enumerator.

Since
2.0

Remove

Remove(dataSelection: DataMarkingSelection): void
Remove a data marking selection.
Parameters
- dataSelection: DataMarkingSelection
  The data marking selection to remove.
Returns void
Since
2.0

TryGetValue

TryGetValue(
name: string | String,
dataSelection: OutParam<DataMarkingSelection>,
): boolean
Try to get a marking selection.
Parameters
- name: string | String
  The name of the marking selection.
- dataSelection: OutParam<DataMarkingSelection>
  Assign the selection to this out parameter if it exists, will be set to null otherwise.
Returns boolean
True if the marking was retrieved, false if the marking could not be found.

Since
2.0