An IWriteContext implementation that wraps a given instance and delegates most of the calls to it but allows for modifying lookup and serialization properties.
Remarks
Type Details
- yFiles module
- view
Constructors
Initializes a new instance of the ChildWriteContext class that delegates to the provided context and returns the given value in getCurrent.
Parameters
A map of options to pass to the method.
- parentContext - IWriteContext
- The parent context to delegate calls to.
- currentObject - any
- The current object to return in getCurrent.
Initializes a new instance of the ChildWriteContext class that delegates to the given parent context.
Parameters
A map of options to pass to the method.
- parentContext - IWriteContext
- The parent context.
Properties
Gets the currently active graph object.
Implements
Gets the current nesting of graphs and graph elements.
Remarks
Implements
Gets the parent context to which most calls are delegated.
Property Value
Gets an implementation of IWriteEvents that allows to subscribe to various events in the write process.
Implements
Gets or sets the writer.
Remarks
Implements
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
Parameters
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).
Implements
Get a property value that specifies information about how to handle specific cases
Parameters
A map of options to pass to the method.
- key - string
- The identifier for the property
Returns
- ↪any?
- The property value, or
nullif no such property exists
Implements
Returns an instance that implements the given type or null.
Remarks
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
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
Implements
Removes a local lookup override that has been added using setLookup
Type Parameters
- T
- The type key to remove.
Parameters
A map of options to pass to the method.
- tType - Constructor<T>
- The type key to remove.
Removes a previously locally set serialization property.
Parameters
A map of options to pass to the method.
- key - string
- The key for which the local property override should be removed.
Serialize the item.
Remarks
context as first argument and should be used in virtually all cases.Type Parameters
- T
- The type of the object that is serialized.
Parameters
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
Defined in
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
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.
Defined in
Serialize item to an XML representation.
Remarks
context instance is used.Type Parameters
- T
Parameters
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
Implements
Serialize a replacement object replacement instead of the original originalItem.
Remarks
Type Parameters
- T
- The type of the object that is serialized.
Parameters
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' })
See Also
Defined in
Adds another lookup result to the local lookup override.
Type Parameters
- T
- The type to use as a key for the lookup.
Parameters
A map of options to pass to the method.
- tType - Constructor<T>
- The type to use as a key for the lookup.
- value - T
- The value to provide for queries to
T.