Abstract base implementation of the IOutputHandler interface.
Type Parameters
- TKey
- The type of the keys.
- TData
- The type of the data.
Type Details
- yFiles module
- view
Constructors
OutputHandlerBase
(keyType: Constructor<TKey>, dataType: Constructor<TData>, scope: KeyScope, name: string, type: KeyType)Initializes a new instance of the OutputHandlerBase<TKey,TData> class using the provided scope, name, and type for the key definition.
Parameters
A map of options to pass to the method.
- keyType - Constructor<TKey>
- The type of the keys.
- dataType - Constructor<TData>
- The type of the data.
- scope - KeyScope
- The scope.
- name - string
- The name to use for the key definition.
- type - KeyType
- The type to use for the key definition.
See Also
Properties
Gets the XML attributes that should be added to the data element.
Implements
Gets or sets the default value.
Gets the XML attributes that should be added to the key definition in the GraphML key element.
Implements
Gets or sets the write precedence for the handler.
Methods
Obtains the data for the given key.
Parameters
A map of options to pass to the method.
- context - IWriteContext
- The context.
- key - TKey
- The key.
Returns
- ↪TData?
- The data that is associated with the key.
Determines whether in the current context, the value is the default value and therefore no data element needs to be written.
Remarks
false if no default has been set. Otherwise it will use getValue and compare the result with the defaultValue to determine whether they are equal and therefore no data needs to be written.Parameters
A map of options to pass to the method.
- context - IWriteContext
- The context.
Returns
- ↪boolean
trueif for the current context the default value applies and therefore no data element needs to be written.
Implements
Sets the scope for the key definition.
Writes the contents of the key definition.
Remarks
true, this method will write the GraphML 'default' element and use writeValueCore to serialize the defaultValue.Parameters
A map of options to pass to the method.
- context - IWriteContext
- The context.
Implements
Actually writes the value for the current context.
Remarks
Parameters
A map of options to pass to the method.
- context - IWriteContext
- The context.
Implements
Performs the actual writing of the data.
Parameters
A map of options to pass to the method.
- context - IWriteContext
- The context.
- data - TData
- The data.