Interface that provides the context of a GraphML write process.
Remarks
All state data that is needed for the writing of a concrete graph instance should go here, allowing all handlers and deserializers to be implemented stateless.
Type Details
- yFiles module
- view
Properties
Gets the currently active graph object.
Gets the current nesting of graphs and graph elements.
Remarks
The list contains the user objects which correspond to the GraphML elements.
Property Value
A read-only view on the current nesting
Gets an implementation of IWriteEvents that allows to subscribe to various events in the write process.
Gets the current IXmlWriter implementation.
Methods
Returns the most current (the last element) within the container hierarchy as it is returned by objectStack or default(T) if the most current element is not of the desired target type.
Type Parameters
- T
- The desired target type.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- itemType - Constructor<T>
- The desired target type.
Returns
- ↪T?
- The most current element within the container hierarchy or
default(T).
Returns an instance that implements the given type or null.
Remarks
Typically, this method will be called to obtain a different view or aspect of the current instance. This is quite similar to casting or using a super type or interface of this instance, but is not limited to inheritance or compile-time constraints. An instance implementing this method is not required to return non-
null implementations for the types, nor does it have to return the same instance any time. Also, it depends on the type and context whether the instance returned stays up to date or needs to be re-obtained for further use.Type Parameters
- T
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- type - Constructor<T>
- the type for which an instance shall be returned
Returns
- ↪T?
- an instance that is assignable to the type or
null
Defined in
Serialize the item.
Remarks
This method calls serializeCore with
context as first argument and should be used in virtually all cases.Type Parameters
- T
- The type of the object that is serialized.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- targetType - Constructor<T>
- The type of the object that is serialized.
- item - T
- The object that should be serialized.
Throws
- Exception({ name: 'SerializationNotSupportedError' })
See Also
Serializes the specified item using the provided type information.
Remarks
item should be assignable to type t. This method simply delegates to serializeCore, using the correct type parameter.Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- item - any
- The item to serialize.
- t - Constructor
- The type the item is known to be of at deserialization time.
Serialize item to an XML representation.
Remarks
Client code should usually use the method serialize instead to ensure the correct
context instance is used.Type Parameters
- T
- The type of the object that is serialized.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- targetType - Constructor<T>
- The type of the object that is serialized.
- context - IWriteContext
- The current write context.
- item - T
- The object that should be serialized.
Throws
- Exception({ name: 'SerializationNotSupportedError' })
See Also
Serialize a replacement object replacement instead of the original originalItem.
Remarks
Calling this method allows remembering the original object instance, even if the object is actually written through a MarkupExtension or similar replacement mechanisms.
Type Parameters
- T
- The type of the object that is serialized.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- targetType - Constructor<T>
- originalItem - any
- The original object that should be serialized.
- replacement - T
- The replacement object that will actually be serialized instead.
Throws
- Exception({ name: 'SerializationNotSupportedError' })