Packagecom.yworks.yfiles.layout
Interfacepublic interface ProfitModel
Implementors ExtendedLabelCandidateProfitModel, LabelRanking

This is an interface for ranking LabelCandidates.



Public Methods
 MethodDefined By
  
getProfit(candidate:LabelCandidate):Number
Returns the profit for placing a label-candidate.
ProfitModel
Method Detail
getProfit()method
public function getProfit(candidate:LabelCandidate):Number

Returns the profit for placing a label-candidate. Higher profit means higher probability that the candidate is chosen by a labeling algorithm.

Parameters

candidate:LabelCandidate — a label candidate

Returns
Number — a value between 0 and 1.