Class ColoringTemplateCollection

Collection class used to store templates used for coloring in visualizations. In a document, the template collection can be accessed at Spotfire.Dxp.Application.Document.ColoringTemplates.

Since

2.0

Hierarchy (View Summary)

DocumentNode
- ColoringTemplateCollection

Implements

Index

Methods

[iterator]

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

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<number | Int32, Coloring> & PropertyGet<
    string
    | String,
    Coloring,
>

Gets the Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring with the given name.

Param: name

The name to lookup.

Returns

The item with the given name.

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 the 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

AddCopy

AddCopy(template: Coloring): Coloring
Adds a copy of the given Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring.
Parameters
- template: Coloring
  Template to copy.
Returns Coloring
A copy of the provided template that has been inserted to this collection.

Since
2.0
AddCopy(template: Coloring, preferredName: string | String): Coloring
Adds a copy of the given Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring with a new display name.
Parameters
- template: Coloring
  Template to copy.
- preferredName: string | String
  The preferred display name that the copy should have. If this name is not unique withing the collection, the added Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring will have a name that is slightly modified.
Returns Coloring
A copy of the provided template that has been inserted to this collection.

Since
2.0

AddFromStream

AddFromStream(stream: Stream): Coloring
Adds a Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring to this collection by reading from the given stream. The content of the stream must be a dxpcolor file.
Parameters
- stream: Stream
  The stream to read from.
Returns Coloring
The added Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring.

Since
2.0

AddNew

AddNew(preferredName: string | String): Coloring
Creates a new Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring and adds it to this collection.
Parameters
- preferredName: string | String
  The preferred display name. If this name is not unique withing the collection, the created color collection will have a name that is slightely modified.
Returns Coloring
The newly added Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring.

Since
2.0

Clear

Clear(): void
Clears the collection.

Returns void
Since
2.0

Contains

Contains(name: string | String): boolean
Determines whether a Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring with the given name exists in this collection.
Parameters
- name: string | String
  The name to check.
Returns boolean
true if this collection contains a Coloring with the given name; otherwise, false.

Since
2.0

RemoveAt

RemoveAt(index: number | Int32): void
Removes the item at the given index.
Parameters
- index: number | Int32
  Index to remove.
Returns void
Since
2.0

TryGetValue

TryGetValue(name: string | String, value: OutParam<Coloring>): boolean
Tries to get the Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring with the specified name, returning true upon success.
Parameters
- name: string | String
  The name to look for.
- value: OutParam<Coloring>
  An item with specified name, if found; otherwise, null.
Returns boolean
true if this instance contains an item with the specified name; otherwise, false.

Since
2.0

Extended capability 'LibraryRead'

AddFromLibrary

AddFromLibrary(colorLibraryItem: LibraryItem): Coloring
Adds the specified color scheme from the library to this Spotfire.Dxp.Application.Visuals.ConditionalColoring.ColoringTemplateCollection.
Parameters
- colorLibraryItem: LibraryItem
  The library item for the Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring to get.
Returns Coloring
The added Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring.

Since
2.0

Class ColoringTemplateCollection

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Extended capability 'LibraryRead'

Methods

[iterator]

Returns Iterator<Coloring>

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

ReadonlyItem

Param: name

Returns

Since

Context

Returns INodeContext

Since

Count

Returns number

Since

IsAttached

Returns boolean

Since

Transactions

Returns ITransactions

Since

AddCopy

Parameters

Returns Coloring

Since

Parameters

Returns Coloring

Since

AddFromStream

Parameters

Returns Coloring

Since

AddNew

Parameters

Returns Coloring

Since

Clear

Returns void

Since

Contains

Parameters

Returns boolean

Since

RemoveAt

Parameters

Returns void

Since

TryGetValue

Parameters

Returns boolean

Since

Extended capability 'LibraryRead'

AddFromLibrary

Parameters

Returns Coloring

`Static`Equals

`Readonly`Item