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

Class CategoricalColorRule

Represents a color rule for categorical coloring.

Since

2.0

Hierarchy (View Summary)

ColorRule
- CategoricalColorRule

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Item Context Count IsAttached ManualDisplayName Transactions ForEachNodeInSubTree GetExplicitCategories SetColors

Methods

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 ColorRule.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 ColorRule.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from ColorRule.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from ColorRule.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 ColorRule.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 ColorRule.Equals

Default capability

`Readonly`Item

Item: PropertyGet<TypedArray<System.Object>, Color> & PropertySet<
TypedArray<System.Object>,
Color,
> & PropertyGet<CategoryKey, Color> & PropertySet<CategoryKey, Color>

Gets or sets the color for a category.

Param: category

The category.

Returns

The color for the category.

Since

2.0

Context

get Context(): INodeContext
Gets the context of this node.

Returns INodeContext
Since
2.0

Inherited from ColorRule.Context

Count

get Count(): number
Gets the number of explicitly mapped categories.

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 ColorRule.IsAttached

ManualDisplayName

get ManualDisplayName(): string
Gets or sets the display name. If set to null, the ColorRule will be represented with an auto-generated name.

Returns string
Since
2.0

Inherited from ColorRule.ManualDisplayName
set ManualDisplayName(value: string): void
Parameters
- value: string
Returns void
Inherited from ColorRule.ManualDisplayName

Transactions

get Transactions(): ITransactions
Gets a collection of methods for executing transactions on the document.

Returns ITransactions
Since
2.0

Inherited from ColorRule.Transactions

ForEachNodeInSubTree

ForEachNodeInSubTree<TNode>(
typeTNode: TypeRefParam<TNode>,
action: Action<TNode>,
): void
Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node.
Type Parameters
- TNode
Parameters
- typeTNode: TypeRefParam<TNode>
  Generic type argument
- action: Action<TNode>
  The action to apply.
Returns void
Since
2.1

Inherited from ColorRule.ForEachNodeInSubTree

GetExplicitCategories

GetExplicitCategories(): System.Collections.Generic.IList<CategoryKey>
Gets all explicitly mapped categories.

Returns System.Collections.Generic.IList<CategoryKey>
All explicitly mapped categories.

Since
2.0

SetColors

SetColors(
colors: OrExplicit<System.Collections.Generic.IEnumerable<Color>>,
): void
Sets the colors to be used in this categorical color rule. This resets this CategoricalColorRule to only use the given colors.
Parameters
- colors: OrExplicit<System.Collections.Generic.IEnumerable<Color>>
  The colors to use in this categorical color rule.
Returns void
Since
2.0