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

Class IconRule

IconRule is a base class for rules that use a boolean condition to determine color and shape.

Since

2.0

Hierarchy (view full)

DocumentNode
- IconRule

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Color Context IsAttached ManualDisplayName RuleCondition Shape Transactions

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

`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

Color

get Color(): Color
Gets or sets the color for this rule.

Returns Color
Since
2.0
set Color(value): void
Parameters
- value: Color
Returns void

Context

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

Returns INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

IsAttached

get IsAttached(): boolean
Gets a value indicating whether this node is attached.

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.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
set ManualDisplayName(value): void
Parameters
- value: string
Returns void

RuleCondition

get RuleCondition(): RuleCondition
Gets the rule condition.

Returns RuleCondition
Since
2.0

Shape

get Shape(): MarkerShape
Gets or sets the marker shape for this rule.

Returns MarkerShape
Since
2.0
set Shape(value): void
Parameters
- value: MarkerShape
Returns void

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