Class CustomNodes

Represents a collection of custom nodes.

Since

2.0

Hierarchy (view full)

DocumentNode
- CustomNodes

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context IsAttached Transactions Add AddNewIfNeeded Contains Remove TryGetNode

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

`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

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(node): void
Adds the specified node.
Parameters
- node: CustomNode
  The node to add.
Returns void
Since
2.0

AddNewIfNeeded

AddNewIfNeeded<T>(typeT): JsType<T>
Adds a new node of the specified type if required. If a node of the specified type is already present in the collection, it is returned and nothing is added.
Type Parameters
- T extends CustomNode
Parameters
- typeT: TypeRefParam<T>
  Generic type argument
Returns JsType<T>
A node of the speicifed type.

Since
2.0

Contains

Contains(node): boolean
Determines whether the specified Spotfire.Dxp.Application.Extension.CustomNode exists in this the collection.
Parameters
- node: CustomNode
  Spotfire.Dxp.Application.Extension.CustomNode.
Returns boolean
Since
2.0
Contains(nodeType): boolean
Determines whether a Spotfire.Dxp.Application.Extension.CustomNode of the specified type exists in this collection.
Parameters
- nodeType: Type
  The node type.
Returns boolean
Since
2.0
Contains<T>(typeT): boolean
Determines whether a Spotfire.Dxp.Application.Extension.CustomNode of the specified type exists in this collection.
Type Parameters
- T extends CustomNode
Parameters
- typeT: TypeRefParam<T>
  Generic type argument
Returns boolean
Since
2.0

Remove

Remove(node): boolean
Removes the specified node.
Parameters
- node: CustomNode
  The node to remove.
Returns boolean
true if node was successfully removed; otherwise, false. This method also returns false if node is not found.

Since
2.0

TryGetNode

TryGetNode(nodeType, node): boolean
Tries to get the Spotfire.Dxp.Application.Extension.CustomNode of the specified type.
Parameters
- nodeType: Type
  The node type.
- node: OutParam<CustomNode>
  The reference to be set.
Returns boolean
Since
2.0
TryGetNode<T>(typeT, node): boolean
Tries to get the Spotfire.Dxp.Application.Extension.CustomNode of the specified type.
Type Parameters
- T extends CustomNode
Parameters
- typeT: TypeRefParam<T>
  Generic type argument
- node: OutParam<T>
  The reference to be set.
Returns boolean
Since
2.0

Class CustomNodes

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

StaticEquals

Parameters

Returns boolean

Default capability

Context

Returns INodeContext

Since

IsAttached

Returns boolean

Since

Transactions

Returns ITransactions

Since

Add

Parameters

Returns void

Since

AddNewIfNeeded

Type Parameters

Parameters

Returns JsType<T>

Since

Contains

Parameters

Returns boolean

Since

Parameters

Returns boolean

Since

Type Parameters

Parameters

Returns boolean

Since

Remove

Parameters

Returns boolean

Since

TryGetNode

Parameters

Returns boolean

Since

Type Parameters

Parameters

Returns boolean

Since

Settings

On This Page

`Static`Equals