documentationfor yFiles for HTML 3.0.0.3

Usages of LayoutNodeLabel

Properties

nodeLabelsin LayoutGraphGets a live view of all LayoutNodeLabel instances contained in this graph.
labelsin LayoutNodeGets a live view of the labels associated with this node.

Method Return Values

createLayoutData (LayoutGraph)in CircularLayoutReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the CircularLayout.
createLayoutData (LayoutGraph)in CompactDiskLayoutReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the CompactDiskLayout.
createLayoutData (LayoutGraph)in HierarchicalLayoutReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the HierarchicalLayout.
createLayoutData (LayoutGraph)in GenericLabelingReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the GenericLabeling.
createLayoutData (LayoutGraph)in AlignmentStageReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the AlignmentStage.
createLayoutData (LayoutGraph)in BendSubstitutionStageReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to define the edges affected by the BendSubstitutionStage.
createLayoutData (LayoutGraph)in ComponentLayoutReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the ComponentLayout.
createLayoutData (LayoutGraph)in CurveFittingStageReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to define the edges affected by the CurveFittingStage.
createLayoutData (LayoutGraph)in GenericLayoutGridStageReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the GenericLayoutGridStage.
createLayoutData (LayoutGraph)in GivenCoordinatesLayoutReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the GivenCoordinatesLayout.
createLayoutData (LayoutGraph)in LayoutAnchoringStageReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the LayoutAnchoringStage.
addLabel (LayoutNode, number, number)in LayoutGraphCreates a new label for the specified node with the given dimensions.
addLabel (LayoutNode, IOrientedRectangle)in LayoutGraphCreates a new label for the specified node with the given layout.
createCompositeLayoutData (LayoutData<LayoutNode,LayoutEdge,LayoutNodeLabel,LayoutEdgeLabel>)in LayoutGraphReturns an instance of CompositeLayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that combines the given instances of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>.
createGenericLayoutData ()in LayoutGraphReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to easily associate custom item-specific data with a LayoutGraph.
getLayoutNodeLabel (ILabel)in LayoutGraphAdapterReturns the layout graph node label that corresponds to the given original label.
addItemData (NodeLabelDataKey<TValue>, function(LayoutNodeLabel):TValue, function(LayoutNodeLabel, TValue):void?)in LayoutGraphContextRegisters data for individual node labels at the graph with the specified NodeLabelDataKey<TValue>.
getItemData (NodeLabelDataKey<TValue>)in LayoutGraphContextGets data for individual node labels registered for the graph with the specified NodeLabelDataKey<TValue>.
getOriginalNodeLabel (LayoutNodeLabel)in LayoutGraphCopyDataReturns the original node label that corresponds to the given copied node label.
createLayoutData (LayoutGraph)in PlaceNodesAtBarycenterStageReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the PlaceNodesAtBarycenterStage.
createLayoutData (LayoutGraph)in PortPlacementStageReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the PortPlacementStage.
createLayoutData (LayoutGraph)in RadialGroupLayoutReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the RadialGroupLayout.
createLayoutData (LayoutGraph)in RecursiveGroupLayoutReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the RecursiveGroupLayout.
createLayoutData (LayoutGraph)in RemoveOverlapsStageReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the RemoveOverlapsStage.
createLayoutData (LayoutGraph)in SubgraphLayoutStageReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the SubgraphLayoutStage.
createLayoutData (LayoutGraph)in TabularLayoutReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the TabularLayout.
createLayoutData (LayoutGraph)in TemporaryGroupInsertionStageReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the TemporaryGroupInsertionStage.
createLayoutData (LayoutGraph)in MultiPageLayoutReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the MultiPageLayout.
createLayoutData (LayoutGraph)in OrganicLayoutReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the OrganicLayout.
createLayoutData (LayoutGraph)in OrthogonalLayoutReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the OrthogonalLayout.
createLayoutData (LayoutGraph)in ClearAreaLayoutReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the ClearAreaLayout.
createLayoutData (LayoutGraph)in FillAreaLayoutReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the FillAreaLayout.
createLayoutData (LayoutGraph)in PartialLayoutReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the PartialLayout.
createLayoutData (LayoutGraph)in RadialLayoutReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the RadialLayout.
createLayoutData (LayoutGraph)in CurveRoutingStageReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to define the edges affected by the CurveRoutingStage.
createLayoutData (LayoutGraph)in EdgeRouterReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the EdgeRouter.
createLayoutData (LayoutGraph)in OctilinearRoutingStageReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to define the edges affected by the OctilinearRoutingStage.
createLayoutData (LayoutGraph)in OrganicEdgeRouterReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the OrganicEdgeRouter.
createLayoutData (LayoutGraph)in SelfLoopRouterReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to define the edges affected by the SelfLoopRouter.
createLayoutData (LayoutGraph)in StraightLineEdgeRouterReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the StraightLineEdgeRouter.
createLayoutData (LayoutGraph)in SeriesParallelLayoutReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the SeriesParallelLayout.
createLayoutData (LayoutGraph)in RadialTreeLayoutReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the RadialTreeLayout.
createLayoutData (LayoutGraph)in TreeLayoutReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the TreeLayout.
createLayoutData (LayoutGraph)in TreeMapLayoutReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the TreeMapLayout.
createLayoutData (LayoutGraph)in TreeReductionStageReturns an instance of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that can be used to perform item-specific configurations for the TreeReductionStage.

Method Parameters

modifyCandidates (LayoutGraph, IMapper<LayoutNodeLabel,IEnumerable<LabelCandidate>>, IMapper<LayoutEdgeLabel,IEnumerable<LabelCandidate>>)in GenericLabelingCallback method to influence the label candidates available to the labeling algorithm before the algorithm is applied.
modifyWeights (LayoutGraph, IMapper<LayoutNodeLabel,IEnumerable<LabelCandidate>>, IMapper<LayoutEdgeLabel,IEnumerable<LabelCandidate>>)in GenericLabelingCallback method to influence the choice of LabelCandidates immediately before the final label positions are chosen.
buildCandidates (LayoutNodeLabel)in NodeLabelCandidatesReturns all LabelCandidates that describe valid label positions.
addLayoutData (LayoutData<LayoutNode,LayoutEdge,LayoutNodeLabel,LayoutEdgeLabel>)in ContextModificationStageAdds the specified layout data to be temporarily applied by this stage.
addReplacementMap (NodeLabelDataKey<T>, IMapper<LayoutNodeLabel,T>)in ContextModificationStageAdds the specified key to the data keys whose associated data is temporarily replaced by this stage.
getReference (LayoutNodeLabel, LayoutAnchoringPolicy)in LayoutAnchoringStageGets the reference bounds for a node label based on the specified LayoutAnchoringPolicy.
applyLayout (ILayoutAlgorithm, LayoutData<LayoutNode,LayoutEdge,LayoutNodeLabel,LayoutEdgeLabel>?)in LayoutGraphRuns an ILayoutAlgorithm synchronously on the given LayoutGraph, applying the given layoutData.
contains (LayoutNodeLabel)in LayoutGraphDetermines whether this graph contains the specified node label.
createCompositeLayoutData (LayoutData<LayoutNode,LayoutEdge,LayoutNodeLabel,LayoutEdgeLabel>)in LayoutGraphReturns an instance of CompositeLayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> that combines the given instances of LayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel>.
remove (LayoutNodeLabel)in LayoutGraphRemoves the given label from its node.
createNodeLabelCandidate (ILabel, ILabel, ILabelModelParameter, LayoutNodeLabel)in LayoutGraphAdapterCreates a LabelCandidate for a given label and ILabelModelParameter combination.
getOriginalLabel (LayoutNodeLabel)in LayoutGraphAdapterReturns the original node label that corresponds to the given layout graph label.
addItemData (NodeLabelDataKey<TValue>, IMapper<LayoutNodeLabel,TValue>)in LayoutGraphContextRegisters data for individual node labels at the graph with the specified NodeLabelDataKey<TValue>.
addItemData (NodeLabelDataKey<TValue>, function(LayoutNodeLabel):TValue, function(LayoutNodeLabel, TValue):void?)in LayoutGraphContextRegisters data for individual node labels at the graph with the specified NodeLabelDataKey<TValue>.
pushLayer (LayoutData<LayoutNode,LayoutEdge,LayoutNodeLabel,LayoutEdgeLabel>?)in LayoutGraphContextPushes a new layer onto the context, optionally applying layout data.
getOriginalNodeLabel (LayoutNodeLabel)in LayoutGraphCopyDataReturns the original node label that corresponds to the given copied node label.
getNodeLabelId (LayoutNodeLabel)in MultiPageLayoutContextGets the unique ID of the associated node label.
getOriginalItem (LayoutNodeLabel, MultiPageLayoutResult)in MultiPageLayoutDataReturns the label of the original input graph that corresponds to the provided node label of the LayoutGraph returned by the MultiPageLayout.