Class IconRuleCollection

Represents the set of rules in a Spotfire.Dxp.Application.Visuals.Miniatures.IconMiniatureVisualization that are used to determine the icon that is rendered.

Since

2.0

Hierarchy (View Summary)

DocumentNode
- IconRuleCollection

Implements

Index

Methods

[iterator]

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

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, IconRule>

Gets the Spotfire.Dxp.Application.Visuals.Miniatures.IconRule at the specified index.

Param: index

The index.

Returns

The Spotfire.Dxp.Application.Visuals.Miniatures.IconRule 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 count.

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

AddBottomNRule

AddBottomNRule(rank: number | Int32, color: Color, shape: MarkerShape): IconRule
Adds a bottom N rule to the end of the collection.
Parameters
- rank: number | Int32
  An integer specifying the rank of the added rule.
- color: Color
  The color of the icon rendered if the rule matches.
- shape: MarkerShape
  The shape of the icon rendered if the rule matches.
Returns IconRule
The rule that was added.

Since
2.0
AddBottomNRule(
    value: ConditionValue,
    color: Color,
    shape: MarkerShape,
): IconRule
Adds a bottom N rule to the end of the collection.
Parameters
- value: ConditionValue
  A Spotfire.Dxp.Application.Visuals.ConditionalColoring.ConditionValue, that has to evaluate to an integer.
- color: Color
  The color.
- shape: MarkerShape
  The shape.
Returns IconRule
The rule that was added.

Since
2.0

AddExpressionRule

AddExpressionRule(
    booleanExpression: string | String,
    color: Color,
    shape: MarkerShape,
): IconRule
Adds a new expression rule to the end of the collection.
Parameters
- booleanExpression: string | String
  The boolean expression.
- color: Color
  The color of the icon rendered if the rule matches.
- shape: MarkerShape
  The shape of the icon rendered if the rule matches.
Returns IconRule
The rule that was added.

Since
2.0

AddRangeRule

AddRangeRule(
    startValue: ConditionValue,
    endValue: ConditionValue,
    color: Color,
    shape: MarkerShape,
): IconRule
Adds a range rule to the end of the collection.
Parameters
- startValue: ConditionValue
  The start value.
- endValue: ConditionValue
  The end value.
- color: Color
  The color of the icon rendered if the rule matches.
- shape: MarkerShape
  The shape of the icon rendered if the rule matches.
Returns IconRule
The rule that was added.

Since
2.0

AddStringRule

AddStringRule(
    comparisonOperator: StringComparisonOperator,
    value: ConditionValue,
    color: Color,
    shape: MarkerShape,
): IconRule
Adds a string color rule to the end of the collection.
Parameters
- comparisonOperator: StringComparisonOperator
  The comparison operator.
- value: ConditionValue
  The value.
- color: Color
  The color of the icon rendered if the rule matches.
- shape: MarkerShape
  The shape of the icon rendered if the rule matches.
Returns IconRule
The rule that was added.

Since
2.0

AddThresholdRule

AddThresholdRule(
    comparisonOperator: RuleComparisonOperator,
    value: ConditionValue,
    color: Color,
    shape: MarkerShape,
): IconRule
Adds a threshold color rule to the end of the collection.
Parameters
- comparisonOperator: RuleComparisonOperator
  The comparison operator.
- value: ConditionValue
  The threshold value.
- color: Color
  The color of the icon rendered if the rule matches.
- shape: MarkerShape
  The shape of the icon rendered if the rule matches.
Returns IconRule
The rule that was added.

Since
2.0

AddTopNRule

AddTopNRule(rank: number | Int32, color: Color, shape: MarkerShape): IconRule
Adds a top N rule to the end of the collection.
Parameters
- rank: number | Int32
  An integer specifying the rank of the added rule.
- color: Color
  The color of the icon rendered if the rule matches.
- shape: MarkerShape
  The shape of the icon rendered if the rule matches.
Returns IconRule
The rule that was added.

Since
2.0
AddTopNRule(value: ConditionValue, color: Color, shape: MarkerShape): IconRule
Adds a top N rule to the end of the collection.
Parameters
- value: ConditionValue
  A Spotfire.Dxp.Application.Visuals.ConditionalColoring.ConditionValue, that has to evaluate to an integer.
- color: Color
  The color of the icon rendered if the rule matches.
- shape: MarkerShape
  The shape of the icon rendered if the rule matches.
Returns IconRule
The rule that was added.

Since
2.0

Clear

Clear(): void
Clears this collection, removing all rules.

Returns void
Since
2.0

Contains

Contains(rule: IconRule): boolean
Determines whether the collection contains a specified rule.
Parameters
- rule: IconRule
  The rule to locate in the collection.
Returns boolean
True if the collection contains the specified rule; otherwise, false.

Since
2.0

GetEnumerator

GetEnumerator(): System.Collections.Generic.IEnumerator<IconRule>
Returns an enumerator that iterates through the Spotfire.Dxp.Application.Visuals.Miniatures.IconRules in this Spotfire.Dxp.Application.Visuals.ConditionalColoring.Coloring.

Returns System.Collections.Generic.IEnumerator<IconRule>
An System.Collections.Generic.IEnumerator for this Coloring.

Since
2.0

IndexOf

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

Since
2.0

Move

Move(fromIndex: number | Int32, toIndex: number | Int32): void
Moves a rule at the specified index to another 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(rule: IconRule): boolean
Removes the specified rule from the collection.
Parameters
- rule: IconRule
  The rule to remove.
Returns boolean
True if the rule was removed; otherwise false.

Since
2.0

Class IconRuleCollection

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Methods

[iterator]

Returns Iterator<IconRule>

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: index

Returns

Since

Context

Returns INodeContext

Since

Count

Returns number

Since

IsAttached

Returns boolean

Since

Transactions

Returns ITransactions

Since

AddBottomNRule

Parameters

Returns IconRule

Since

Parameters

Returns IconRule

Since

AddExpressionRule

Parameters

Returns IconRule

Since

AddRangeRule

Parameters

Returns IconRule

Since

AddStringRule

Parameters

Returns IconRule

Since

AddThresholdRule

Parameters

Returns IconRule

Since

AddTopNRule

Parameters

Returns IconRule

Since

Parameters

Returns IconRule

Since

Clear

Returns void

Since

Contains

Parameters

`Static`Equals

`Readonly`Item