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

Class KpiCollection

Represents a collection of Spotfire.Dxp.Application.Visuals.KpiContent in the KpiChart.

Since

2.0

Hierarchy (view full)

DocumentNode
- KpiCollection

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast [iterator] Equals

Default capability

Item Context Count IsAttached Transactions AddDuplicate AddNew Clear GetEnumerator IndexOf InsertNew Move Remove RemoveAt

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

Gets the item at the specified index.

Param: index

The zero-based index for the item to retrieve.

Returns

The item at the specified index.

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 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(kpiContent): KpiContent
Duplicates a Spotfire.Dxp.Application.Visuals.KpiContent and adds it to the collection.
Parameters
- kpiContent: KpiContent
  The Spotfire.Dxp.Application.Visuals.KpiContent to be duplicated.
Returns KpiContent
The duplicated Spotfire.Dxp.Application.Visuals.KpiContent.

Since
2.0

AddNew

AddNew(): KpiContent
Adds a new Spotfire.Dxp.Application.Visuals.KpiContent containing an Spotfire.Dxp.Application.Visuals.KpiVisualization to the KPI collection.

Returns KpiContent
The newly added Spotfire.Dxp.Application.Visuals.KpiContent.

Since
2.0

Clear

Clear(): void
Removes all items from the KPI collection.

Returns void
Since
2.0

GetEnumerator

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

Returns System.Collections.Generic.IEnumerator<KpiContent>
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 the specific item.
Parameters
- item: KpiContent
  The item to locate.
Returns number
The index of item if found; otherwise, -1.

Since
2.0

InsertNew

InsertNew(index): KpiContent
Inserts a Spotfire.Dxp.Application.Visuals.KpiContent containing an auto configured Spotfire.Dxp.Application.Visuals.KpiVisualization at the specified index.
Parameters
- index: number | Int32
  The index, where to insert the Spotfire.Dxp.Application.Visuals.KpiContent.
Returns KpiContent
The created Spotfire.Dxp.Application.Visuals.KpiContent.

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 first occurrence of the specified item from the KPI collection.
Parameters
- item: KpiContent
  The item to remove.
Returns boolean
true if item was removed; otherwise, false. This method also returns false if item was 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