A flags enum that specifies which properties of items to synchronize during folding synchronization operations.
Remarks
The values can be combined to specify that multiple properties should be synchronized.
Type Details
- yFiles module
- view
See Also
Constants
Specifies that the preferredSize should be synchronized.
Remarks
Just used for labels.
Specifies that the layout of the items should be synchronized.
Remarks
- For INodes that will be layout.
- For IEdges it will be the bends, but does not include their ports, which need to be synchronized via the FoldingPortDefaults respective options, instead.
- For IPorts it will be their locationParameter.
- For ILabels it will be their layoutParameter, but does not include their preferredSize, which has a separate flag.
See Also
Specifies that the tag of the items should be synchronized.
Static Methods
Converts the given argument to an enum constant of this enum type.
Remarks
Most notably, this method can convert an enum constant's name into the enum constant itself.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- value - FoldingSynchronizationOptions
- The value to convert to an enum constant.
Returns
- ↪FoldingSynchronizationOptions
- The enum constant that corresponds to the given argument.
Returns the name of the given enum constant.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- value - FoldingSynchronizationOptions
- The numeric value of an enum constant.
Returns
- ↪string
- The name of the enum constant.
Throws
- Exception({ name: 'Error' })
- If this type is a flags enums, and the provided value doesn't correspond to a single enum constant, or if this enum type contains no constant of the given numeric value.