An IProfitModel that returns the profit of a label candidate for instances of ExtendedNodeLabelCandidate and ExtendedEdgeLabelCandidate.
Remarks
This class is used by LayoutExecutor and LayoutGraphAdapter to convert an IGraph into a corresponding Graph. Unless that conversion needs to be customized, or aforementioned classes cannot be used, this class usually doesn't need to be used explicitly.
Type Details
- yfiles module
- view-layout-bridge
- yfiles-umd modules
- view-layout-bridge
- Legacy UMD name
- yfiles.layout.ExtendedLabelCandidateProfitModel
Methods
Returns the profit for placing a label-candidate.
Remarks
This implementation returns the profit for instances of ExtendedNodeLabelCandidate or 0.0 for other LabelCandidates.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- candidate - LabelCandidate
- a label candidate
Returns
- ↪number
- a value between 0 and 1.