com.yworks.yfiles.layout.LabelLayoutKeys

Package	com.yworks.yfiles.layout
Class	public class LabelLayoutKeys
Inheritance	LabelLayoutKeys YObject Object

This interface provides label-specific keys that can be used to add data providers to a layout graph.

Label aware layout algorithms like HierarchicLayouter (com.yworks.yfiles.layout.hierarchic.HierarchicLayouter) may look for such data providers.

Instead of setting up label layout data and data providers one can also use the layout stage com.yworks.yfiles.layout.LabelLayoutTranslator to automatically translate information provided by the standard label layout classes com.yworks.yfiles.layout.EdgeLabelLayout and com.yworks.yfiles.layout.NodeLabelLayout to layout data accessible by the keys defined below.

	Method	Defined By
		equals(o:Object):Boolean	YObject
		getClass():Class	YObject
		hashCode():int	YObject

Public Constants

	Constant		Defined By
		EDGE_LABEL_LAYOUT_KEY : Object = LabelLayoutKeys.EDGE_LABEL_LAYOUT_KEY [static] Key that is used to add or access a data provider to a graph that must return for each edge of the graph an array of type com.yworks.yfiles.layout.LabelLayoutData.	LabelLayoutKeys
		IGNORE_LABEL_KEY : Object = y.layout.LabelLayoutKeys.IGNORE_LABEL_KEY [static] Key that is used to store whether or not a label (i.e., an instance of com.yworks.yfiles.layout.LabelLayout) should be considered during layout.	LabelLayoutKeys
		NODE_LABEL_LAYOUT_KEY : Object = LabelLayoutKeys.NODE_LABEL_LAYOUT_KEY [static] Key that is used to add or access a data provider to a graph that must returns for each node of the graph an array of type com.yworks.yfiles.layout.LabelLayoutData.	LabelLayoutKeys

Constant Detail

EDGE_LABEL_LAYOUT_KEY

Constant

public static const EDGE_LABEL_LAYOUT_KEY:Object = LabelLayoutKeys.EDGE_LABEL_LAYOUT_KEY

Key that is used to add or access a data provider to a graph that must return for each edge of the graph an array of type com.yworks.yfiles.layout.LabelLayoutData.

IGNORE_LABEL_KEY

Constant

public static const IGNORE_LABEL_KEY:Object = y.layout.LabelLayoutKeys.IGNORE_LABEL_KEY

Key that is used to store whether or not a label (i.e., an instance of com.yworks.yfiles.layout.LabelLayout) should be considered during layout. A label is ignored if the data provider registered with this key is not null and com.yworks.yfiles.base.DataProvider.getBool() returns true.

Currently this key is directly considered by the following layout algorithms: com.yworks.yfiles.layout.router.polyline.EdgeRouter. Furthermore, layout stage com.yworks.yfiles.layout.LabelLayoutTranslator only translates labels that should not be ignored.

NODE_LABEL_LAYOUT_KEY

Constant

public static const NODE_LABEL_LAYOUT_KEY:Object = LabelLayoutKeys.NODE_LABEL_LAYOUT_KEY

Key that is used to add or access a data provider to a graph that must returns for each node of the graph an array of type com.yworks.yfiles.layout.LabelLayoutData.

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
LabelLayoutKeys	Methods \| Constants