com.yworks.yfiles.layout.labeling.GreedyMISLabeling

Package	com.yworks.yfiles.layout.labeling
Class	public class GreedyMISLabeling
Inheritance	GreedyMISLabeling MISLabelingAlgorithm AbstractLabelingAlgorithm AbstractLayoutStage YObject Object

This class places the labels of a graph using a greedy strategy. This is the fastest label placing algorithm provided.

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		applyPostprocessing : Boolean Getter: Returns true if the postprocessing step is applied.	AbstractLabelingAlgorithm
		autoFlippingEnabled : Boolean Determines whether or not edge labels associated with a "free" label model (see for example y.view.SmartEdgeLabelModel) should be automatically flipped if they would be upside-down.	AbstractLabelingAlgorithm
		boxesToNodesInternal : Map [read-only]	MISLabelingAlgorithm
		conflictGraphInternal : Graph [read-only]	MISLabelingAlgorithm
		coreLayouter : Layouter Specifies the core layouter.	AbstractLayoutStage
		customProfitModelRatio : Number Getter: Returns the custom profit model ratio.	MISLabelingAlgorithm
		edgeGroupOverlapAllowed : Boolean Getter: Returns whether edge labels may overlap with edges belonging to the same edge group.	AbstractLabelingAlgorithm
		graph : LayoutGraph	MISLabelingAlgorithm
		moveInternalNodeLabels : Boolean Specifies true if the labeling algorithm is allowed to move internal node labels.	AbstractLabelingAlgorithm
		nodesToIDInternal : NodeMap [read-only]	MISLabelingAlgorithm
		optimizationStrategy : int Specifies the optimization strategy of the labeling algorithm.	MISLabelingAlgorithm
		placeEdgeLabels : Boolean Specifies whether labels assigned to edges in a graph should be placed or ignored.	AbstractLabelingAlgorithm
		placeNodeLabels : Boolean Specifies whether labels assigned to nodes in a graph should be placed or ignored.	AbstractLabelingAlgorithm
		profitModel : ProfitModel Sets the profit model that is used to rank the available positions for each label.	AbstractLabelingAlgorithm
		rects : YList [read-only] Returns the set of all generated candidate rectangles.	AbstractLabelingAlgorithm
		removeEdgeOverlaps : Boolean Specifies how label candidates which overlap with edges are handled.	AbstractLabelingAlgorithm
		removeNodeOverlaps : Boolean Specifies how label candidates which overlap with nodes are handled.	AbstractLabelingAlgorithm
		selectedLabelsDpKey : Object Getter: Returns the labeling selection DataProvider key.	AbstractLabelingAlgorithm
		storeRects : Boolean Specifies whether the candidate rectangles should be stored to be retrieved.	AbstractLabelingAlgorithm
		useAlternativeSideHandling : Boolean Getter: Returns true if the preference on which side of an edge a corresponding label should be placed is interpreted by human perception instead of always following the edge from source to target.	AbstractLabelingAlgorithm

Protected Properties

Hide Inherited Protected Properties

Show Inherited Protected Properties

	Property		Defined By
		boxesToNodes : Map	MISLabelingAlgorithm
		conflictGraph : Graph the conflict graph	MISLabelingAlgorithm
		nodesToBoxes : NodeMap holds for each node in the conflictGraph the corresponding LabelCandidate	MISLabelingAlgorithm
		nodesToID : NodeMap holds for each node in the conflictGraph the corresponding integer index of the Label[]	MISLabelingAlgorithm

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		GreedyMISLabeling(init:Boolean = true)	GreedyMISLabeling
		canLayout(graph:LayoutGraph):Boolean [override] Returns true.	AbstractLabelingAlgorithm
		doLayout(graph:LayoutGraph):void [override] Place the labels in the graph.	AbstractLabelingAlgorithm
		equals(o:Object):Boolean	YObject
		getClass():Class [override]	GreedyMISLabeling
		getProfit(l:LabelCandidate):Number Returns the profit model that is used to rank the available positions for each label.	AbstractLabelingAlgorithm
		hashCode():int	YObject
		label(gl:LayoutGraph):void Place the labels in the graph.	AbstractLabelingAlgorithm
		labelSome(gl:LayoutGraph, key:Object):void Place a subset of the labels.	AbstractLabelingAlgorithm
		labelSome2(gl:LayoutGraph, nodeLabels:YList, edgeLabels:YList):void Place some labels in the graph.	AbstractLabelingAlgorithm
		newGreedyMISLabeling():GreedyMISLabeling [static]	GreedyMISLabeling

Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		assignProfit():NodeMap Creates a node map which assigns to each node the profit.	MISLabelingAlgorithm
		canLayoutCore(graph:LayoutGraph):Boolean Queries the core layouter whether or not the given graph can be laid out.	AbstractLayoutStage
		checkGroupNodeSize(layout:GraphLayout, node:Object):void This method throws an com.yworks.bridge.util.IllegalArgumentException if the width/height of the given group node object is zero.	AbstractLabelingAlgorithm
		checkNodeSize(layout:GraphLayout, node:Object):void This method throws an com.yworks.bridge.util.IllegalArgumentException if the width/height of the given node object is zero.	AbstractLabelingAlgorithm
		createEdges():void Creates one edge between two nodes if the corresponding label candidates are intersecting.	MISLabelingAlgorithm
		doLayoutCore(graph:LayoutGraph):void Invokes the layout routine of the core layouter.	AbstractLayoutStage
		foundEdgeOverlap(lc:LabelCandidate, e:Edge, eSegment:LineSegment):void Calculates the overlapping factor between a label candidate and an edge segment.	MISLabelingAlgorithm
		foundHaloOverlap(lc:LabelCandidate, n:Node, haloRect:YRectangle):void Calculates the overlapping factor between a label candidate and a node halo.	MISLabelingAlgorithm
		foundLabelOverlap(lc1:LabelCandidate, lc2:LabelCandidate, e:Edge):void Calculates the overlapping factor between two label candidates.	MISLabelingAlgorithm
		foundNodeOverlap(lc:LabelCandidate, n:Node, nBox:YRectangle):void Calculates the overlapping factor between a label candidate and a node.	MISLabelingAlgorithm
		initAbstractLabelingAlgorithm():void	AbstractLabelingAlgorithm
		initAbstractLayoutStage1():void	AbstractLayoutStage
		initAbstractLayoutStage2(core:Layouter):void	AbstractLayoutStage
		initGreedyMISLabeling():void	GreedyMISLabeling
		initMISLabelingAlgorithm():void	MISLabelingAlgorithm

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		LABEL_MODEL_DPKEY : Object = y.layout.labeling.AbstractLabelingAlgorithm.LABEL_MODEL_DPKEY [static] com.yworks.yfiles.base.DataProvider key to specify for each com.yworks.yfiles.layout.EdgeLabelLayout s and each com.yworks.yfiles.layout.NodeLabelLayout a replacement com.yworks.yfiles.layout.EdgeLabelModel or com.yworks.yfiles.layout.NodeLabelModel, respectively, that is used by the labeling algorithm instead of the original label model.	AbstractLabelingAlgorithm
		OPTIMIZATION_BALANCED : int = 0 [static] Use a balanced optimization strategy.	MISLabelingAlgorithm
		OPTIMIZATION_EDGE_OVERLAP : int = 3 [static] Use an optimization strategy that especially reduces overlaps between labels and edges.	MISLabelingAlgorithm
		OPTIMIZATION_LABEL_OVERLAP : int = 2 [static] Use an optimization strategy that especially reduces overlaps between labels.	MISLabelingAlgorithm
		OPTIMIZATION_NODE_OVERLAP : int = 1 [static] Use an optimization strategy that especially reduces overlaps between labels and nodes as well as labels and node halos.	MISLabelingAlgorithm
		OPTIMIZATION_NONE : int = 4 [static] Use no optimization strategy.	MISLabelingAlgorithm

Constructor Detail

GreedyMISLabeling

()

Constructor

public function GreedyMISLabeling(init:Boolean = true)

Parameters

init:Boolean (default = true)

Method Detail

getClass

()

method

override public function getClass():Class

Returns

Class

initGreedyMISLabeling

()

method

protected final function initGreedyMISLabeling():void

newGreedyMISLabeling

()

method

public static function newGreedyMISLabeling():GreedyMISLabeling

Returns

GreedyMISLabeling

Wed Oct 7 2015, 04:43 PM +02:00

yFiles FLEX Client Layout Extension 1.5 API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
GreedyMISLabeling	Properties \| Methods \| Constants