SerializationProperties (yFiles-for-JavaFX-Complete-3.0 API)

java.lang.Object
- com.yworks.yfiles.graphml.SerializationProperties

```
public final class SerializationProperties
extends Object
```
Constant class for common serialization properties.

See Also:

IWriteContext#getSerializationProperty(com.yworks.util.TypedKey)

Field Summary

Fields
Modifier and Type	Field and Description
`static TypedKey<URI>`	`BASE_URI` The current `String` base URI which is used for the GraphML file being parsed or written.
`static TypedKey<Boolean>`	`CACHE_EXTERNAL_REFERENCES` Property key to control caching for external references.
`static TypedKey<KeyScope>`	`CURRENT_KEY_SCOPE` The current `KeyScope` in which an `IOutputHandler`, `IInputHandler`, or custom serialization code is called.
`static TypedKey<GraphItemTypes>`	`DISABLE_GEOMETRY` Property key to control graph element geometry serialization and deserialization.
`static TypedKey<Boolean>`	`DISABLE_GRAPH_SETTINGS` Property key to omit serialization and deserialization of the `IGraph`'s default settings.
`static TypedKey<GraphItemTypes>`	`DISABLE_ITEMS` Property key to control graph elements serialization and deserialization.
`static TypedKey<StripeTypes>`	`DISABLE_STRIPE_LABELS` Property key to control label serialization of `IStripe`s.
`static TypedKey<StripeTypes>`	`DISABLE_STRIPE_STYLES` Property key to control style serialization and deserialization of `IStripe`s.
`static TypedKey<StripeTypes>`	`DISABLE_STRIPE_USER_TAGS` Property key to control user tag serialization and deserialization of `IStripe`s.
`static TypedKey<GraphItemTypes>`	`DISABLE_STYLES` Property key to control graph element style serialization and deserialization.
`static TypedKey<GraphItemTypes>`	`DISABLE_USER_TAGS` Property key to control user tag serialization and deserialization.
`static TypedKey<Boolean>`	`IGNORE_PROPERTY_CASE` Property key for case-insensitive parsing of property names during XAML deserialization.
`static TypedKey<Boolean>`	`IGNORE_XAML_DESERIALIZATION_ERRORS` If set to `true` errors during XAML deserialization will be ignored and instead `null` will be returned.
`static TypedKey<Boolean>`	`INDENT_OUTPUT` Property key whether the XML output should be properly indented.
`static TypedKey<Boolean>`	`PARSE_LABEL_SIZE` Property key to specify whether the preferred size of labels should be parsed.
`static TypedKey<IEdge>`	`REPRESENTED_EDGE` The edge that is currently being represented by the dummy edge that is written instead.
`static TypedKey<Boolean>`	`REWRITE_RELATIVE_RESOURCE_URIS` Whether to rewrite relative URIs relative to the current document location.
`static TypedKey<Boolean>`	`WRITE_EDGE_STYLE_DEFAULT` Write the default edge style in the <default> element of the key definition.
`static TypedKey<Predicate<ILabel>>`	`WRITE_LABEL_SIZE_PREDICATE` Provides a `Predicate` that determines if the preferred size of a label should be written.
`static TypedKey<Boolean>`	`WRITE_NODE_STYLE_DEFAULT` Write the default node style in the <default> element of the key definition.
`static TypedKey<Boolean>`	`WRITE_PORT_STYLE_DEFAULT` Write the default port style in the <default> element of the key definition.
`static TypedKey<Boolean>`	`WRITE_RELATIVE_URLS` Determines if URLs are written as paths relative to the document base URI or absolute URL specifications.
`static TypedKey<Integer>`	`WRITE_RELATIVE_URLS_MAX_DEPTH` Specifies the maximum number of accepted parent directory path components ("../") when computing relative paths for URLs.
`static TypedKey<Boolean>`	`WRITE_STRIPE_DEFAULTS` Property key to specify whether the stripe defaults of a table should be written.

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BASE_URI
```
public static final TypedKey<URI> BASE_URI
```
    The current String base URI which is used for the GraphML file being parsed or written.
    If set, this can be used to resolve or create relative paths.
  - CACHE_EXTERNAL_REFERENCES
```
public static final TypedKey<Boolean> CACHE_EXTERNAL_REFERENCES
```
    Property key to control caching for external references.
    If this property is set to false in the write context, the writer will not cache remember external reference ids provided via QueryReferenceId, 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
  - CURRENT_KEY_SCOPE
```
public static final TypedKey<KeyScope> CURRENT_KEY_SCOPE
```
    The current KeyScope in which an IOutputHandler, IInputHandler, or custom serialization code is called.
  - DISABLE_GEOMETRY
```
public static final TypedKey<GraphItemTypes> DISABLE_GEOMETRY
```
    Property key to control graph element geometry serialization and deserialization.
    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 GraphItemTypes.NONE
  - DISABLE_GRAPH_SETTINGS
```
public static final TypedKey<Boolean> DISABLE_GRAPH_SETTINGS
```
    Property key to omit serialization and deserialization of the IGraph's default settings.
    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.
  - DISABLE_ITEMS
```
public static final TypedKey<GraphItemTypes> DISABLE_ITEMS
```
    Property key to control graph elements serialization and deserialization.
    Setting this property disables serialization and deserialization for the provided GraphItemTypes. By default, this property is set to GraphItemTypes.NONE
  - DISABLE_STRIPE_LABELS
```
public static final TypedKey<StripeTypes> DISABLE_STRIPE_LABELS
```
    Property key to control label serialization of IStripes.
    Setting this property disables label serialization for the provided StripeTypes. By default, this property is set to StripeTypes.NONE
  - DISABLE_STRIPE_STYLES
```
public static final TypedKey<StripeTypes> DISABLE_STRIPE_STYLES
```
    Property key to control style serialization and deserialization of IStripes.
    Setting this property disables style serialization for the provided StripeTypes. By default, this property is set to StripeTypes.NONE
  - DISABLE_STRIPE_USER_TAGS
```
public static final TypedKey<StripeTypes> DISABLE_STRIPE_USER_TAGS
```
    Property key to control user tag serialization and deserialization of IStripes.
    Setting this property disables tag serialization for the provided StripeTypes. By default, this property is set to StripeTypes.NONE
  - DISABLE_STYLES
```
public static final TypedKey<GraphItemTypes> DISABLE_STYLES
```
    Property key to control graph element style serialization and deserialization.
    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 GraphItemTypes.NONE
  - DISABLE_USER_TAGS
```
public static final TypedKey<GraphItemTypes> DISABLE_USER_TAGS
```
    Property key to control user tag serialization and deserialization.
    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 GraphItemTypes.NONE
  - IGNORE_PROPERTY_CASE
```
public static final TypedKey<Boolean> IGNORE_PROPERTY_CASE
```
    Property key for case-insensitive parsing of property names during XAML deserialization.
    Default for this property is false
  - IGNORE_XAML_DESERIALIZATION_ERRORS
```
public static final TypedKey<Boolean> IGNORE_XAML_DESERIALIZATION_ERRORS
```
    If set to true errors during XAML deserialization will be ignored and instead null will be returned.
  - INDENT_OUTPUT
```
public static final TypedKey<Boolean> INDENT_OUTPUT
```
    Property key whether the XML output should be properly indented.
    Default for this property is true
  - PARSE_LABEL_SIZE
```
public static final TypedKey<Boolean> PARSE_LABEL_SIZE
```
    Property key to specify whether the preferred size of labels should be parsed.
    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 usecases where the text size calculations can be quite different for different platforms. Default value is true
  - REPRESENTED_EDGE
```
public static final TypedKey<IEdge> REPRESENTED_EDGE
```
    The edge that is currently being represented by the dummy edge that is written instead.
    If this value is set, then the edge currently being serialized represents the given edge in reality.
  - REWRITE_RELATIVE_RESOURCE_URIS
```
public static final TypedKey<Boolean> REWRITE_RELATIVE_RESOURCE_URIS
```
    Whether to rewrite relative URIs relative to the current document location.
    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.
  - WRITE_EDGE_STYLE_DEFAULT
```
public static final TypedKey<Boolean> WRITE_EDGE_STYLE_DEFAULT
```
    Write the default edge style in the <default> element of the key definition.
    A Boolean value indicates whether the default should be written.
  - WRITE_LABEL_SIZE_PREDICATE
```
public static final TypedKey<Predicate<ILabel>> WRITE_LABEL_SIZE_PREDICATE
```
    Provides a Predicate that determines if the preferred size of a label should be written.
    If this property is not set, the label size is always written.
  - WRITE_NODE_STYLE_DEFAULT
```
public static final TypedKey<Boolean> WRITE_NODE_STYLE_DEFAULT
```
    Write the default node style in the <default> element of the key definition.
    A Boolean value indicates whether the default should be written.
  - WRITE_PORT_STYLE_DEFAULT
```
public static final TypedKey<Boolean> WRITE_PORT_STYLE_DEFAULT
```
    Write the default port style in the <default> element of the key definition.
    A Boolean value indicates whether the default should be written.
  - WRITE_RELATIVE_URLS
```
public static final TypedKey<Boolean> WRITE_RELATIVE_URLS
```
    Determines if URLs are written as paths relative to the document base URI or absolute URL specifications.
    Default value is true.
  - WRITE_RELATIVE_URLS_MAX_DEPTH
```
public static final TypedKey<Integer> WRITE_RELATIVE_URLS_MAX_DEPTH
```
    Specifies the maximum number of accepted parent directory path components ("../") when computing relative paths for URLs. If the computed relative path for an URL includes more parent directory components than the specified maximum, an absolute URL specification is written to GraphML instead of a relative path.
    A negative value or null means that relative paths may include an arbitrary number or parent directory components.
    Default value is null, i.e, there is no maximum set.
    This property is only taken into account if WRITE_RELATIVE_URLS is set to true.
  - WRITE_STRIPE_DEFAULTS
```
public static final TypedKey<Boolean> WRITE_STRIPE_DEFAULTS
```
    Property key to specify whether the stripe defaults of a table should be written.
    If set to true the ColumnDefaults and RowDefaults will be written. Default value is true.

Class SerializationProperties

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BASE_URI

CACHE_EXTERNAL_REFERENCES

CURRENT_KEY_SCOPE

DISABLE_GEOMETRY

DISABLE_GRAPH_SETTINGS

DISABLE_ITEMS

DISABLE_STRIPE_LABELS

DISABLE_STRIPE_STYLES

DISABLE_STRIPE_USER_TAGS

DISABLE_STYLES

DISABLE_USER_TAGS

IGNORE_PROPERTY_CASE

IGNORE_XAML_DESERIALIZATION_ERRORS

INDENT_OUTPUT

PARSE_LABEL_SIZE

REPRESENTED_EDGE

REWRITE_RELATIVE_RESOURCE_URIS

WRITE_EDGE_STYLE_DEFAULT

WRITE_LABEL_SIZE_PREDICATE

WRITE_NODE_STYLE_DEFAULT

WRITE_PORT_STYLE_DEFAULT

WRITE_RELATIVE_URLS

WRITE_RELATIVE_URLS_MAX_DEPTH

WRITE_STRIPE_DEFAULTS