A LabelCandidate describes one valid placement for a label considering the label model.
Remarks
Default Values of Properties
| customProfit | 0 | |
| edgeOverlapPenalty | 1 | |
| nodeOverlapPenalty | 1 |
Type Details
- yfiles module
- layout-core
- yfiles-umd modules
- All layout modules, view-layout-bridge
- Legacy UMD name
- yfiles.layout.LabelCandidate
See Also
Constructors
LabelCandidate
(pos: YPoint, size: YDimension, param: Object, owner: ILabelLayout, internal?: boolean)Creates a new instance of LabelCandidate described by location, size, model parameter and internal flag.
Parameters
A map of options to pass to the method.
- pos - YPoint
- the location of the upper left corner of the candidate
- size - YDimension
- the size of the candidate
- param - Object
- the parameters of the label model associated with this candidate
- owner - ILabelLayout
- the label associated with the candidate
- internal - boolean
trueif the candidate is allowed to overlap with its owner,falseotherwise
LabelCandidate
(labelBox: YOrientedRectangle, param: Object, owner: ILabelLayout, internal?: boolean)Creates a new instance of LabelCandidate described by its box, model parameter and internal flag.
Parameters
A map of options to pass to the method.
- labelBox - YOrientedRectangle
- the box that specifies the candidate's size and position
- param - Object
- the parameters of the label model associated with this candidate
- owner - ILabelLayout
- the label associated with the candidate
- internal - boolean
trueif the candidate is allowed to overlap with its owner,falseotherwise
Properties
Gets the bounding box of this candidate.
Remarks
Implements
Gets the oriented box of this candidate.
Remarks
Gets or sets the custom profit for this candidate.
Remarks
The profit describes the priority of this candidate with respect to other candidates. Labeling algorithms will use the profit to decide which candidate to choose.
The value is restricted to the interval [0,1], where 1 specifies the highest possible profit.
Default Value
0.Throws
- Exception({ name: 'ArgumentError' })
- if the specified value lies outside of
[0,1]
Gets or sets a penalty for a candidate position that overlaps the path of an edge.
Remarks
0 and 1, where 0 means that an overlap is considered unimportant and 1 means that an overlap is considered severe.Default Value
1.Throws
- Exception({ name: 'ArgumentError' })
- if the specified penalty is outside
[0,1]
Gets the height of the candidate's bounding box.
Remarks
See Also
Gets the coordinates of the upper-left corner of the candidate's bounds.
Remarks
See Also
Gets or sets a penalty for a candidate position that overlaps the box of a node.
Remarks
0 and 1, where 0 means that an overlap is considered unimportant and 1 means that an overlap is considered severe.Default Value
1.Throws
- Exception({ name: 'ArgumentError' })
- if the specified penalty is outside
[0,1]
Gets the sum of node overlap penalty and edge overlap penalty.
Gets the ILabelLayout for which this candidate was created.
Gets whether or not this candidate's box had already been chosen by the labeling algorithm.
Remarks
See Also
Gets the width and height of the candidate's bounds.
Remarks
See Also
Gets the width of the candidate's bounds.
Remarks
See Also
Gets the minimum x-coordinate of the candidate's bounds.
Remarks
See Also
Gets the minimum y-coordinate of the candidate's bounds.
Remarks
See Also
Methods
Replaces the model parameter and box of the owner with the model parameter and box of this candidate.
Remarks
See Also
Returns a string representation of this LabelCandidate.
Remarks
Returns
- ↪string
- a representation of the candidate