Class ColorBreakpointCollection

Class ColorBreakpointCollection represents a set of breakpoints in a gradient or segmented continuous scale. A ColorBreakPointCollection contains instanses of class Spotfire.Dxp.Application.Visuals.ConditionalColoring.ColorBreakpoint, and is used to define a Spotfire.Dxp.Application.Visuals.ConditionalColoring.ContinuousColorRule.

Since

2.0

Hierarchy (view full)

DocumentNode
- ColorBreakpointCollection

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast [iterator] Equals

Default capability

Item Context Count IsAttached Transactions Add Clear GetEnumerator IndexOf 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<ColorBreakpoint, any, undefined>
Returns Iterator<ColorBreakpoint, 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, ColorBreakpoint>

Gets the Spotfire.Dxp.Application.Visuals.ConditionalColoring.ColorBreakpoint at the specified index.

Param: index

The index of the Spotfire.Dxp.Application.Visuals.ConditionalColoring.ColorBreakpoint to get.

Returns

The value.

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

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

Add

Add(value, color): ColorBreakpoint
Adds a new breakpoint to this collection using the specified value and color.
Parameters
- value: ConditionValue
  The value tied to the breakpoint to be created.
- color: Color
  The color tied to the breakpoint to be created.
Returns ColorBreakpoint
The added breakpoint.

Since
2.0

Clear

Clear(): void
Removes all breakpoints from this collection.

Returns void
Since
2.0

GetEnumerator

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

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

Since
2.0

IndexOf

IndexOf(breakpoint): number
Determines the index of a specific item in the collection.
Parameters
- breakpoint: ColorBreakpoint
  The object to locate in the collection.
Returns number
The index of breakpoint if found in the list; otherwise, -1.

Since
2.0

Move

Move(fromIndex, toIndex): void
Moves the Spotfire.Dxp.Application.Visuals.ConditionalColoring.ColorBreakpoint 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(breakpoint): boolean
Removes the Spotfire.Dxp.Application.Visuals.ConditionalColoring.ColorBreakpoint from the collection.
Parameters
- breakpoint: ColorBreakpoint
  The breakpoint to remove.
Returns boolean
true if the breakpoint was successfully removed, otherwise false.

Since
2.0

RemoveAt

RemoveAt(index): void
Removes the Spotfire.Dxp.Application.Visuals.ConditionalColoring.ColorBreakpoint at the specified index.
Parameters
- index: number | Int32
  The zero-based index of the item to remove.
Returns void
Since
2.0

Class ColorBreakpointCollection

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<ColorBreakpoint, any, undefined>

StaticEquals

Parameters

Returns boolean

Default capability

ReadonlyItem

Param: index

Returns

Since

Context

Returns INodeContext

Since

Count

Returns number

Since

IsAttached

Returns boolean

Since

Transactions

Returns ITransactions

Since

Add

Parameters

Returns ColorBreakpoint

Since

Clear

Returns void

Since

GetEnumerator

Returns System.Collections.Generic.IEnumerator<ColorBreakpoint>

Since

IndexOf

Parameters

Returns number

Since

Move

Parameters

Returns void

Since

Remove

Parameters

Returns boolean

Since

RemoveAt

Parameters

Returns void

Since

Settings

On This Page

`Static`Equals

`Readonly`Item