This class is used as look-up key for registering a single value with a graph.
Inheritance Hierarchy
DataKey<TValue>
ValueDataKey
Remarks
A value for the key can be registered for the graph with method addData. If the type is a class type, the data can be retrieved from the graph via method getData. In case the type is a value type (struct), then method getNullableData should be used instead.
Type Parameters
- TValue
- The type value that is registered with this look-up key.
Type Details
- yFiles module
- algorithms
See Also
LayoutGraphContext.addData,
LayoutGraphContext.getData,
LayoutGraphContext.getNullableData,
LayoutGraphContext.remove,
ValueDataKey<TValue>
Constructors
Initializes a new instance of the ValueDataKey<TValue> class.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- 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 ValueDataKey<TValue> instance, to ensure uniqueness. For example, if this ValueDataKey<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.
Properties
Gets the unique identifier for this key or null if none was specified.
Methods
Returns a hash code for this instance.
Returns
- ↪number
- A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
Defined in
Returns whether this key is equal to the specified other.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- other - DataKey<TValue>
- The other key to compare with this instance.
Returns
- ↪boolean
trueif the specified key is equal to this instance; otherwise,false.