Class PanelCollection

A collection of Spotfire.Dxp.Application.Panels.

Since

2.0

Hierarchy (view full)

DocumentNode
- PanelCollection

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast [iterator] Equals

Default capability

Context Count IsAttached Transactions AddNew AutoConfigure Contains GetEnumerator TryGetPanel

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

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.Panels 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

AddNew

AddNew(typeId): Panel
Adds a new Spotfire.Dxp.Application.Panel with the specified type identifier.
Parameters
- typeId: TypeIdentifier
  The panel type identifier.
Returns Panel
The newly created Spotfire.Dxp.Application.Panel, or null if the type identifier is unsupported.

Since
2.0
AddNew<T>(typeT): JsType<T>
Adds a new Spotfire.Dxp.Application.Panel of the specified type.
Type Parameters
- T extends Panel
Parameters
- typeT: TypeRefParam<T>
  Generic type argument
Returns JsType<T>
Null if the Spotfire.Dxp.Application.Panel type is unlicensed, otherwise true.

Since
2.0

AutoConfigure

AutoConfigure(): void
Configures this Spotfire.Dxp.Application.PanelCollection.

Returns void
Since
2.0
AutoConfigure(source): void
Configures this Spotfire.Dxp.Application.PanelCollection, reflecting the specified source.
Parameters
- source: PanelCollection
  The source.
Returns void
Since
2.0

Contains

Contains(panel): boolean
Determines whether the specified Spotfire.Dxp.Application.Panel exists in this collection.
Parameters
- panel: Panel
  The panel.
Returns boolean
true if the panel is in the collection; otherwise, false.

Since
2.0
Contains(panelType): boolean
Determines whether a Spotfire.Dxp.Application.Panel of the specified type exists in this collection.
Parameters
- panelType: Type
  The panel type.
Returns boolean
true if a Spotfire.Dxp.Application.Panel of the specified type is in the collection; otherwise, false.

Since
2.0
Contains(typeId): boolean
Determines whether a Spotfire.Dxp.Application.Panel with the specified type identifier exists in this collection.
Parameters
- typeId: TypeIdentifier
  The panel type identifier.
Returns boolean
true if a Spotfire.Dxp.Application.Panel of the specified Spotfire.Dxp.Framework.DocumentModel.TypeIdentifier is in the collection; otherwise, false.

Since
2.0
Contains<T>(typeT): boolean
Determines whether a Spotfire.Dxp.Application.Panel of the specified type exists in this collection.
Type Parameters
- T extends Panel
Parameters
- typeT: TypeRefParam<T>
  Generic type argument
Returns boolean
true if a Spotfire.Dxp.Application.Panel of the specified type is in the collection; otherwise, false.

Since
2.0

GetEnumerator

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

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

Since
2.0

TryGetPanel

TryGetPanel(typeId, panel): boolean
Tries to get the panel with the specified type identifier.
Parameters
- typeId: TypeIdentifier
  The panel type identifier.
- panel: OutParam<Panel>
  The reference to be set.
Returns boolean
true if the panel was found, otherwise false.

Since
2.0
TryGetPanel<T>(typeT, panel): boolean
Tries to get the panel of the specified type.
Type Parameters
- T extends Panel
Parameters
- typeT: TypeRefParam<T>
  Generic type argument
- panel: OutParam<T>
  The reference to be set.
Returns boolean
true if the panel was found, otherwise false.

Since
2.0

Class PanelCollection

Since

Hierarchy (view full)

Implements

Index

Methods

Default capability

Methods

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns null | T1

[iterator]

Returns Iterator<Panel, any, undefined>

StaticEquals

Parameters

Returns boolean

Default capability

Context

Returns INodeContext

Since

Count

Returns number

Since

IsAttached

Returns boolean

Since

Transactions

Returns ITransactions

Since

AddNew

Parameters

Returns Panel

Since

Type Parameters

Parameters

Returns JsType<T>

Since

AutoConfigure

Returns void

Since

Parameters

Returns void

Since

Contains

Parameters

Returns boolean

Since

Parameters

Returns boolean

Since

Parameters

Returns boolean

Since

Type Parameters

Parameters

Returns boolean

Since

GetEnumerator

Returns System.Collections.Generic.IEnumerator<Panel>

Since

TryGetPanel

Parameters

Returns boolean

Since

Type Parameters

Parameters

Returns boolean

Since

`Static`Equals