C

NodeDataKey<TValue>

Show Usages
This class is used as look-up key for registering IMapper<K, V> for LayoutNodes with a LayoutGraph.
Inheritance Hierarchy

Members

Show:

Constructors

NodeDataKey

(id?: string, fallbackValue?: TValue)
Initializes a new instance of the NodeDataKey<TValue> class.

Parameters

id?: string
The unique identifier for this key. The id should be a combination of the namespace, class name, possible inner classes, and the field name of the NodeDataKey<TValue> instance, to ensure uniqueness. For example, if this NodeDataKey<TValue> instance is declared in the namespace 'yWorks.Layout.Organic' within the class 'OrganicLayout' with the field name 'ClusterIdDataKey', the id could be 'yWorks.Layout.Organic.OrganicLayout.ClusterIdDataKey'. If omitted, the key object itself is the identifier.
fallbackValue?: TValue
A value of type TValue used as fallback if the registered IMapper<K, V> is indexed with a key which is not present.

Properties

id

: string
readonly
Gets the unique identifier for this key or null if none was specified.
readonlyfinal

Property Value

The unique identifier for this key or null if none was specified.

Defined in

DataKey.id

Methods

equals

(obj: any): boolean
Determines whether the specified Object is equal to this instance.

Parameters

obj: any
The Object to compare with this instance.

Return Value

boolean
true if the specified Object is equal to this instance; otherwise, false.

Defined in

DataKey.equals

hashCode

(): number
Returns a hash code for this instance.

Return Value

number
A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.

keyEquals

(other: DataKey<TValue>): boolean
protected
Returns whether this key is equal to the specified other.
protectedfinal

Parameters

other: DataKey<TValue>
The other key to compare with this instance.

Return Value

boolean
true if the specified key is equal to this instance; otherwise, false.