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-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.graphml.IWriteContext
See Also
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.
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 - Class
- The desired target type.
Returns
- ↪T
- the most current element within the container hierarchy or
default(T).
See Also
Returns an instance that implements the given type or null.
Remarks
Typically, this method will be called in order 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 reobtained for subsequent use.Type Parameters
- T: any
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- type - Class<T>
- The type for which an instance shall be returned.
Returns
- ↪T
- an instance that is assignable to type or
null
See Also
Note that the
$class property on JavaScript classes inheriting from yFiles classes is only valid once an instance of this subclass was created. Call fixType, first or instantiate the class at least once.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 - Class
- The type of the object that is serialized.
- item - T
- The object that should be serialized.
Throws
- Exception({ name: 'SerializationNotSupportedError' })
See Also
This method is not available unless the module view-graphml is loaded. Either load the module 'view-graphml' explicitly or call
Class.ensure(GraphMLSupport) More information.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 - Object
- The item to serialize.
- t - Class
- The type the item is known to be of at deserialization time.
This method is not available unless the module view-graphml is loaded. Either load the module 'view-graphml' explicitly or call
Class.ensure(GraphMLSupport) More information.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 - Class
- 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 an replacement object replacement instead of the original originalItem.
Remarks
Calling this method allows to remember the original object instance, even if the object is really 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 - Class
- originalItem - Object
- The original object that should be serialized.
- replacement - T
- The replacement object that will actually be serialized instead.
Throws
- Exception({ name: 'SerializationNotSupportedError' })
See Also
This method is not available unless the module view-graphml is loaded. Either load the module 'view-graphml' explicitly or call
Class.ensure(GraphMLSupport) More information.