Defines a state that can be used to determine the location of a port with a IPortLocationModel.
Remarks
Typically, implementations of this interface are created by factory methods of the corresponding model.
This interface extends the ICloneable interface. This allows clients to obtain a persistent copy of the current state of this parameter. Immutable parameter implementations may return themselves.
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.graph.IPortLocationModelParameter
See Also
Properties
Gets the model that created this parameter.
Methods
Create a clone of this object.
Determines whether this parameter can be used for ports at the given owner.
Remarks
owner.Parameters
A map of options to pass to the method.
- owner - IPortOwner
- The port owner to test.
Returns
- ↪boolean
trueif this instance can be used for ports of the given port owner,falseotherwise.
Static Methods
Deserializes a JavaScript object which has been created by serializeParameter.
Remarks
Parameters
A map of options to pass to the method.
- serializedData - Object
- The JavaScript object to deserialize.
Returns
- ↪IPortLocationModelParameter
- The deserialized parameter.
Throws
- Exception({ name: 'Error' })
- if the given
serializedDatacould not be deserialized.
See Also
Serializes the given IPortLocationModelParameter into a JavaScript object from which the parameter can be restored.
Remarks
The name of the IPortLocationModel is provided with the property ModelName.
IPortLocationModelParameter types which are provided with the yFiles for HTML library can be deserialized automatically with method deserializeParameter.
Parameters
A map of options to pass to the method.
- parameter - IPortLocationModelParameter
- The IPortLocationModelParameter instance to serialize.
Returns
- ↪Record<string,unknown>
- A JavaScript object from which the parameter can be restored.