Class VisualCollection

A collection of Spotfire.Dxp.Application.Visual objects.

Since

2.0

Hierarchy (View Summary)

DocumentNode
- VisualCollection

Implements

Index

Methods

[iterator] Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context Count IsAttached Transactions AddDuplicate AddNew Contains Remove TryGetVisual

Methods

[iterator]

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

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

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 Spotfire.Dxp.Application.Visuals 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

AddDuplicate

AddDuplicate(visual: Visual): Visual
Creates a duplicate of the specified Spotfire.Dxp.Application.Visual and adds it to the collection.
Parameters
- visual: Visual
  The Spotfire.Dxp.Application.Visual to duplicate. It must be attached to the document.
Returns Visual
The duplicate Spotfire.Dxp.Application.Visual.

Since
2.0

AddNew

AddNew<T extends VisualContent>(typeT: TypeRefParam<T>): JsType<T>
Adds a new visual of the specified type.
Type Parameters
- T extends VisualContent
Parameters
- typeT: TypeRefParam<T>
  Generic type argument
Returns JsType<T>
The newly created content.

Since
2.0
AddNew(visualTypeId: TypeIdentifier): Visual
Creates a new Spotfire.Dxp.Application.Visual with a visual of the type identified by visualTypeId and adds it to the collection.
Parameters
- visualTypeId: TypeIdentifier
  The visual type identifier.
Returns Visual
The newly created Spotfire.Dxp.Application.Visual.
Example
The following example snippet shows how to add a bar chart to a visual collection.
```
let visual = page.Visuals.AddNew(Spotfire.Dxp.Application.Visuals.VisualTypeIdentifiers.BarChart);
let barchart = visual.As<Spotfire.Dxp.Application.Visuals.BarChart>();
```
Since
2.0

Contains

Contains(visual: Visual): boolean
Determines whether the visual is in the collection.
Parameters
- visual: Visual
  The visual.
Returns boolean
true if the visual is in the collection; otherwise, false.

Since
2.0

Remove

Remove(visual: Visual): boolean
Removes the specified Spotfire.Dxp.Application.Visual.
Parameters
- visual: Visual
  The Spotfire.Dxp.Application.Visual to remove.
Returns boolean
true is successful, otherwise false.

Remark
Removing null or a Spotfire.Dxp.Application.Visual not in the collection results in false but no exception.

Since
2.0

TryGetVisual

TryGetVisual(id: Guid, visual: OutParam<Visual>): boolean
Tries to get a visual specified by its id.
Parameters
- id: Guid
  The id.
- visual: OutParam<Visual>
  The visual.
Returns boolean
true if the visual was found, otherwise false.

Since
2.0

Class VisualCollection

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Methods

[iterator]

Returns Iterator<Visual>

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

Context

Returns INodeContext

Since

Count

Returns number

Since

IsAttached

Returns boolean

Since

Transactions

Returns ITransactions

Since

AddDuplicate

Parameters

Returns Visual

Since

AddNew

Type Parameters

Parameters

Returns JsType<T>

Since

Parameters

Returns Visual

Example

Since

Contains

Parameters

Returns boolean

Since

Remove

Parameters

Returns boolean

Remark

Since

TryGetVisual

Parameters

Returns boolean

Since

Settings

On This Page

`Static`Equals