Constant class for common serialization properties.
Type Details
- yFiles module
- view
See Also
Constants
Property key to control caching for external references.
Remarks
This property has a boolean value.
If this property is set to false in the write context, the writer will not cache remember external reference ids provided via query-reference-id, i.e. the event will be raised whenever an instance of the external object is encountered during the write process. This allows to provide different values for the same object, depending on the current context. Default for this property is true.
The current KeyScope in which an IOutputHandler, IInputHandler, or custom serialization code is called.
Remarks
Property key to control graph element geometry serialization and deserialization
Remarks
This property has a value of type GraphItemTypes.
Setting this property as a serialization property disables geometry serialization for all of the provided GraphItemTypes. Setting this property as a deserialization property disables geometry deserialization only for nodes, edges and/or ports. By default, this property is set to NONE.
Property key to omit serialization and deserialization of the IGraph's default settings.
Remarks
This property has a boolean value.
If this property is set to true in serializationPropertyOverrides or the write context, the current graph defaults are not written.
If this property is set to true in deserializationPropertyOverrides or the parse context, any graph defaults present in the input are not parsed and applied to the current graph.
Default for this property is true for writing and false for parsing.
Property key to control graph elements serialization and deserialization
Remarks
This property has a value of type GraphItemTypes.
Setting this property disables serialization and deserialization for the provided GraphItemTypes. By default, this property is set to NONE.
Property key to control label serialization of IStripes.
Remarks
This property has a value of type StripeTypes.
Setting this property disables label serialization for the provided StripeTypes. By default, this property is set to NONE.
Property key to control style serialization and deserialization of IStripes.
Remarks
This property has a value of type StripeTypes.
Setting this property disables style serialization for the provided StripeTypes. By default, this property is set to NONE.
Property key to control user tag serialization and deserialization of IStripes.
Remarks
This property has a value of type StripeTypes.
Setting this property disables tag serialization for the provided StripeTypes. By default, this property is set to NONE.
Property key to control graph element style serialization and deserialization
Remarks
This property has a value of type GraphItemTypes.
Setting this property as a serialization property disables style serialization for all of the provided GraphItemTypes. Setting this property as a deserialization property disables style deserialization only for nodes, edges and/or ports. By default, this property is set to NONE
Property key to control user tag serialization and deserialization
Remarks
This property has a value of type GraphItemTypes.
Setting this property as a serialization property disables tag serialization for all of the provided GraphItemTypes. Setting this property as a deserialization property disables tag deserialization only for nodes, edges and/or ports. By default, this property is set to NONE
Property key for storing or setting the id attributes for graph child elements in GraphML.
Remarks
If used as a deserialization property, the mapper will contain the values of the id attribute for these GraphML elements: node, edge, port id attribute values for the graph elements are handled by the GRAPH_IDS deserialization property.
///
If used as a serialization property, the mapper should contain the values for the id attribute for these Graph elements: INode, IPort, IEdge. id attribute values for the graph elements are handled by the GRAPH_IDS serialization property. If you don't provide a value for a certain element, the framework will substitute UUIDs or equivalent random values for the missing values to reduce the potential for conflict with explicitly specified values. It is the responsibility of the caller to ensure that the entries in the mapper do not conflict. Specifically, this means:
- IDs for nodes must be unique over the whole graph, including group and folder nodes.
- IDs for edges must be unique over the whole graph, including group and folder nodes.
- IDs for ports must be unique over the node where the ports belong to.
See Also
Property key for storing or setting the id attributes for graph elements in GraphML.
Remarks
If used as a deserialization property, the mapper will contain the values of the id attribute for these GraphML elements: graph. id attribute values for the other > elements are handled by the GRAPH_ELEMENT_IDS deserialization property. For the root graph, the key will be the IGraph object that is being populated. For grouped/nested/subgraphs, the key will be the group node that represents the graph GraphML element in the resulting IGraph.
///
If used as a serialization property, the mapper should contain the values for the id attribute for these GraphML elements: graph. id attribute values for the other elements are handled by the GRAPH_ELEMENT_IDS serialization property. For the root graph, the key must be the IGraph object that is being written. For grouped/nested/subgraphs, the key must be the group node that represents the graph GraphML element in the IGraph. If you don't provide a value for a certain element, the framework will substitute UUIDs or equivalent random values for the missing values to reduce the potential for conflict with explicitly specified values. It is the responsibility of the caller to ensure that the entries in the mapper do not conflict. Specifically, this means:
- IDs for graphs and group nodes must be unique over the whole graph, including group and folder nodes.
See Also
Property key for alllowing to parse member names (properties and enum values) case-insensitively during XAML deserialization.
Remarks
This will convert property and member names to lower-case and remove underscores to be able to compare things like SOME_CONSTANT_NAME and SomeConstantName as well as somePropertyName and SomePropertyName, respectively.
This property has a boolean value.
Default for this property is false.
Property key to specify whether the preferred size of labels should be parsed.
Remarks
This property has a boolean value.
If this property is set to true, the preferred size provided by GraphML is used, otherwise, the preferred size is determined automatically. This property is mainly meant for interoperability use cases where the text size calculations can be quite different for different platforms. Default value is true
The edge that is currently being represented by the dummy edge that is written instead.
Remarks
This property has a value of type IEdge.
If this value is set, then the edge currently being serialized represents the given edge in reality.
Property key to specify whether to rewrite relative URIs relative to the current document location.
Remarks
This property has a boolean value.
If set, relative URIs for images and other resources are rewritten relative to BASE_URI. If this property is false, or if BASE_URI is not set (either explicitly or implicitly) or the resource URI is not relative, the resource URI will not be rewritten.
Default value is true.
Property key to control how undefined values are serialized.
Remarks
This property has a value of type UndefinedHandling.
The default for this property is EXPLICIT.
Property key to provide a predicate that determines if the preferred size of a label should be written.
Remarks
If this property is not set, the label size is always written.
This property requires a value that is a predicate function taking an ILabel instance and returning a boolean value whether the preferred size of that label shoul be written or not.
Default value is null.
Property key to specify whether the stripe defaults of a table should be written.
Remarks
This property has a boolean value.
If set to true the columnDefaults and rowDefaults will be written. Default value is true.