documentationfor yFiles for HTML 3.0.0.3

Properties

edgeAnchoringPoliciesin LayoutAnchoringStageDataGets or sets the mapping of edges to LayoutAnchoringPolicy values, specifying which part of the edge should be used to calculate the anchor point.
edgeLabelAnchoringPoliciesin LayoutAnchoringStageDataGets or sets the mapping of edge labels to LayoutAnchoringPolicy values, specifying which part of the edge label should be used to calculate the anchor point.
nodeAnchoringPoliciesin LayoutAnchoringStageDataGets or sets the mapping of nodes to LayoutAnchoringPolicy values, specifying which part of the node should be used to calculate the anchor point.
nodeLabelAnchoringPoliciesin LayoutAnchoringStageDataGets or sets the mapping of node labels to LayoutAnchoringPolicy values, specifying which part of the node label should be used to calculate the anchor point.
anchoredItemsin LayoutExecutorGets or sets the mapping of graph items to LayoutAnchoringPolicy values, specifying which part of the items should be used to anchor the graph during layout.
anchoredItemsin LayoutExecutorAsyncGets or sets the mapping of graph items to LayoutAnchoringPolicy values, specifying which part of the items should be used to anchor the graph during layout.

Fields

EDGE_ANCHORING_POLICY_DATA_KEYin LayoutAnchoringStageA data key used to specify the edges that should be used to calculate the anchor point.
EDGE_LABEL_ANCHORING_POLICY_DATA_KEYin LayoutAnchoringStageA data key used to specify the edge labels that should be used to calculate the anchor point.
NODE_ANCHORING_POLICY_DATA_KEYin LayoutAnchoringStageA data key used to specify the nodes that should be used to calculate the anchor point.
NODE_LABEL_ANCHORING_POLICY_DATA_KEYin LayoutAnchoringStageA data key used to specify the node labels that should be used to calculate the anchor point.

Method Return Values

from (LayoutAnchoringPolicy)in LayoutAnchoringPolicyConverts the given argument to an enum constant of this enum type.

Method Parameters

applyLayout (ILayoutAlgorithm, LayoutData<INode,IEdge,ILabel,ILabel>?, TimeSpan?, TimeSpan?, ItemMapping<IPort,PortAdjustmentPolicy>?, ItemMapping<IPort,PortPlacementPolicy>?, ItemMapping<ILabel,PortLabelPolicy>?, ItemMapping<IModelItem,LayoutAnchoringPolicy>?, ItemMapping<ILabel,LabelPlacementPolicy>?, function(INode, INode):number?, function(IEdge, IEdge):number?)in IGraphRuns an ILayoutAlgorithm synchronously on the given graph.
from (LayoutAnchoringPolicy)in LayoutAnchoringPolicyConverts the given argument to an enum constant of this enum type.
getName (LayoutAnchoringPolicy)in LayoutAnchoringPolicyReturns the name of the given enum constant.
getReference (LayoutNode, LayoutAnchoringPolicy)in LayoutAnchoringStageGets the reference bounds for a node based on the specified LayoutAnchoringPolicy.
getReference (LayoutEdge, LayoutAnchoringPolicy)in LayoutAnchoringStageGets the reference bounds for an edge based on the specified LayoutAnchoringPolicy.
getReference (LayoutNodeLabel, LayoutAnchoringPolicy)in LayoutAnchoringStageGets the reference bounds for a node label based on the specified LayoutAnchoringPolicy.
getReference (LayoutEdgeLabel, LayoutAnchoringPolicy)in LayoutAnchoringStageGets the reference bounds for an edge label based on the specified LayoutAnchoringPolicy.
LayoutAnchoringStageData ()in LayoutAnchoringStageData
LayoutExecutor (GraphComponent, ILayoutAlgorithm, )in LayoutExecutorInitializes a new instance of the LayoutExecutor class.
LayoutExecutor (GraphComponent, IGraph, ILayoutAlgorithm, )in LayoutExecutorInitializes a new instance of the LayoutExecutor class.
LayoutExecutorAsync (function(object):Promise<object>, GraphComponent, LayoutDescriptor?, LayoutData<INode,IEdge,ILabel,ILabel>?, )in LayoutExecutorAsyncCreates a new instance of a layout execution helper that will asynchronously perform the calculations and optionally animate the layout on the given graphComponent.
LayoutExecutorAsync (function(object):Promise<object>, IGraph, LayoutDescriptor?, LayoutData<INode,IEdge,ILabel,ILabel>?, )in LayoutExecutorAsyncCreates a new instance of a layout execution helper that will asynchronously perform the calculations and apply the results on the provided graph.
applyLayoutAnimated (ILayoutAlgorithm, TimeSpan?, LayoutData<INode,IEdge,ILabel,ILabel>?, TimeSpan?, TimeSpan?, boolean?, ItemMapping<IPort,PortAdjustmentPolicy>?, ItemMapping<IPort,PortPlacementPolicy>?, ItemMapping<ILabel,PortLabelPolicy>?, ItemMapping<IModelItem,LayoutAnchoringPolicy>?, Insets?, ItemMapping<ILabel,LabelPlacementPolicy>?, function(INode, INode):number?, function(IEdge, IEdge):number?)in GraphComponentRuns a layout on the graph of the GraphComponent and animates the transition.