A label model for node labels that lie outside of the node's layout bounds.
Remarks
This label model supports eight positions outside of the layout's bounds.
It uses the label's preferredSize for the size of the label layout.
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.graph.ExteriorLabelModel
See Also
Sample Graphs
Constructors
Properties
Gets or sets the insets to use by this model.
Remarks
The insets are in fact "outsets", i.e. they are treated as margins. Positive values will increase the distance of the labels to the node.
The default is (0,0,0,0)
Methods
Creates a default parameter that can be used for this model.
Creates a new parameter that is associated with this instance for the provided position.
Parameters
A map of options to pass to the method.
- position - ExteriorLabelModelPosition
- The position constant that describes the position of the label.
Returns
- ↪ILabelModelParameter
- A new parameter instance.
Provides a lookup context for the given combination of label and parameter.
Parameters
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
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
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
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
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
See Also
Implements
Constants
A predefined parameter instance that places the label outside the node at the right side.
Remarks
Sample Graphs
A predefined parameter instance that places the label outside the node at the top.
Remarks
Sample Graphs
A predefined parameter instance that places the label outside the node at the upper right corner.
Remarks
Sample Graphs
A predefined parameter instance that places the label outside the node at the upper left corner.
Remarks
Sample Graphs
A predefined parameter instance that places the label outside the node at the bottom.
Remarks
Sample Graphs
A predefined parameter instance that places the label outside the node at the lower right corner.
Remarks
Sample Graphs
A predefined parameter instance that places the label outside the node at the lower left corner.
Remarks
Sample Graphs
A predefined parameter instance that places the label outside the node at the left side.