A label model for labels at node ports which places the label either inside or outside of the owner node of the port, according to the node border which is closest to the port position.
Inheritance Hierarchy
InsideOutsidePortLabelModel
Implemented Interfaces
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.graph.InsideOutsidePortLabelModel
See Also
Constructors
Properties
Methods
Creates a parameter which places the label outside of the IPort's owner node.
Returns
- ↪ILabelModelParameter
- A parameter which places the label outside of the IPort's owner node.
Implements
Creates a parameter which places the label inside of the IPort's owner node.
Returns
- ↪ILabelModelParameter
- A parameter which places the label inside of the IPort's owner node.
Creates a parameter which places the label outside of the IPort's owner node.
Returns
- ↪ILabelModelParameter
- A parameter which places the label outside of the IPort's owner node.
Provides a lookup context for the given combination of label and parameter.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- label - ILabel
- The label to use in the context.
- layoutParameter - ILabelModelParameter
- The parameter to use for the label in the context.
Returns
- ↪ILookup
- An implementation of the ILookup interface that can be used to query additional aspects of the label/parameter combination.
See Also
Implements
Calculates the geometry of the given label using the given model parameter.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- label - ILabel
- The label to calculate the geometry for.
- layoutParameter - ILabelModelParameter
- A parameter that is compatible with this model. Typically, this is a parameter that has been created by this model, and its property model returns this instance.
Returns
- ↪IOrientedRectangle
- An IOrientedRectangle that describes the geometry of the label. This is typically designed as a flyweight, therefore clients should not cache the instance but store the values if they need a snapshot for later use.
Implements
Returns an enumerator over a set of possible ILabelModelParameter instances that can be used for the given label and model.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- label - ILabel
- The label instance to use.
- model - ILabelModel
- The model to provide parameters for.
Returns
- ↪IEnumerable<ILabelModelParameter>
- A possibly empty enumerator over a set of label model parameters.
Implements
Returns an instance that implements the given type or null.
Remarks
Typically, this method will be called in order to obtain a different view or aspect of the current instance. This is quite similar to casting or using a super type or interface of this instance, but is not limited to inheritance or compile time constraints. An instance implementing this method is not required to return non-
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 reobtained for subsequent use.Type Parameters
- T: any
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- type - Class<T>
- The type for which an instance shall be returned.
Returns
- ↪T
- an instance that is assignable to type or
null