INodeLabelLayoutModel defines the properties of the model associated with a INodeLabelLayout.
Remarks
A INodeLabelLayoutModel provides a set of possible candidates for the placement of a node label. It also defines a parameter that describes the current location of the label.
It is important that all state information is encapsulated in the model parameter. INodeLabelLayoutModel instances may be shared between multiple node labels but produce different parameters for labels with different locations.
Type Details
- yfiles module
- layout-core
- yfiles-umd modules
- All layout modules, view-layout-bridge
- Legacy UMD name
- yfiles.layout.INodeLabelLayoutModel
See Also
Properties
Gets a model parameter that encodes the default position of this model's allowed node label positions.
Remarks
Methods
Creates a model parameter that represents the given node label position within this model.
Remarks
The created model parameter is the closest parameter representation of the given label location that can be achieved within this model.
This parameter can be passed to getLabelPlacement to retrieve the current label box.
A model parameter can be an arbitrary Object. However it must contain all information to allow restoring of the encoded location with this INodeLabelLayoutModel.
Parameters
A map of options to pass to the method.
- labelBounds - YOrientedRectangle
- the box of the label, encoding the label location for which the parameter should be created
- nodeLayout - INodeLayout
- the layout of the node to which the label belongs
Returns
- ↪Object
- the model parameter representing the given label location
See Also
Returns all NodeLabelCandidates that describe valid label positions within this model.
Remarks
Parameters
A map of options to pass to the method.
- labelLayout - INodeLabelLayout
- the label for which candidates should be generated
- nodeLayout - INodeLayout
- the layout of the node to which the label belongs
Returns
- ↪YList
- a list of NodeLabelCandidate instances
getLabelPlacement
(labelSize: YDimension, nodeLayout: INodeLayout, param: Object) : YOrientedRectangleReturns the bounds of the label for the position encoded by the given model parameter.
Parameters
A map of options to pass to the method.
- labelSize - YDimension
- the width and height of the label
- nodeLayout - INodeLayout
- the layout of the node to which the label belongs
- param - Object
- the model parameter that describes the abstract position of the label within this model
Returns
- ↪YOrientedRectangle
- the oriented box of the label