documentationfor yFiles for HTML 3.0.0.3

Usages of ItemCollection

Properties

sinksin AllPairsShortestPathsGets or sets a collection of sink (end, target) nodes.
sourcesin AllPairsShortestPathsGets or sets a collection of source (start) nodes.
subgraphEdgesin AllPairsShortestPathsGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin AllPairsShortestPathsGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin BetweennessCentralityGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin BetweennessCentralityGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
coreNodesin BfsGets or sets a collection of nodes to start from.
subgraphEdgesin BfsGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin BfsGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin BiconnectedComponentClusteringGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin BiconnectedComponentClusteringGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin BiconnectedComponentsGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin BiconnectedComponentsGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin BipartitionGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin BipartitionGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin ChainSubstructuresGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin ChainSubstructuresGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin ChainsGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin ChainsGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin CliqueSubstructuresGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin CliqueSubstructuresGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin ClosenessCentralityGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin ClosenessCentralityGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin ClusteringCoefficientGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin ClusteringCoefficientGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin ConnectedComponentsGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin ConnectedComponentsGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin CycleGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin CycleGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin CycleEdgesGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin CycleEdgesGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin CycleSubstructuresGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin CycleSubstructuresGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin DegreeCentralityGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin DegreeCentralityGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin EdgeBetweennessClusteringGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin EdgeBetweennessClusteringGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin EigenvectorCentralityGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin EigenvectorCentralityGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin FeedbackEdgeSetGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin FeedbackEdgeSetGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin GraphCentralityGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin GraphCentralityGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin GraphStructureAnalyzerGets or sets the collection of edges which define an induced subgraph for the algorithms to work on.
subgraphNodesin GraphStructureAnalyzerGets or sets the collection of nodes which define an induced subgraph for the algorithms to work on.
subgraphEdgesin HierarchicalClusteringGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin HierarchicalClusteringGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin IndependentSetsGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin IndependentSetsGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
affectedItemsin IntersectionsGets or sets the graph items that must be involved in each intersection.
subgraphEdgesin IntersectionsGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin IntersectionsGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin KCoreComponentsGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin KCoreComponentsGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin KMeansClusteringGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin KMeansClusteringGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
sinkin KShortestPathsGets or sets the sink (end, target) node of the path.
sourcein KShortestPathsGets or sets the source (start) node of the path.
subgraphEdgesin KShortestPathsGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin KShortestPathsGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin LabelPropagationClusteringGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin LabelPropagationClusteringGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin LongestPathGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin LongestPathGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin LouvainModularityClusteringGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin LouvainModularityClusteringGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
sinksin MaximumFlowGets or sets a collection of sink nodes.
sourcesin MaximumFlowGets or sets a collection of source nodes.
subgraphEdgesin MaximumFlowGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin MaximumFlowGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
sinkin MinimumCostFlowGets or sets a single sink node.
sourcein MinimumCostFlowGets or sets a single source node.
subgraphEdgesin MinimumCostFlowGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin MinimumCostFlowGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
startNodesin NeighborhoodGets or sets a collection of nodes from which to start the search.
subgraphEdgesin NeighborhoodGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin NeighborhoodGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin NodeAggregationGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin NodeAggregationGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
topLevelNodesin NodeAggregationGets or sets the top-level nodes of the aggregation info.
subgraphEdgesin PageRankGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin PageRankGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
endNodesin PathsGets or sets a collection of end nodes.
startNodesin PathsGets or sets a collection of start nodes.
subgraphEdgesin PathsGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin PathsGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin RankAssignmentGets or sets the collection of edges which define a subset of the graph for the algorithm to work on.
subgraphNodesin RankAssignmentGets or sets the collection of nodes which define a subset of the graph for the algorithm to work on.
startNodesin ReachabilityGets or sets a collection of nodes from which to determine reachability.
subgraphEdgesin ReachabilityGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin ReachabilityGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
sinkin ShortestPathGets or sets the sink (end, target) node of the path.
sourcein ShortestPathGets or sets the source (start) node of the path.
subgraphEdgesin ShortestPathGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin ShortestPathGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
sinksin SingleSourceShortestPathsGets or sets a collection of sink (end, target) nodes.
sourcein SingleSourceShortestPathsGets or sets the source (start) node.
subgraphEdgesin SingleSourceShortestPathsGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin SingleSourceShortestPathsGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin SpanningTreeGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin SpanningTreeGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin StarSubstructuresGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin StarSubstructuresGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin StronglyConnectedComponentsGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin StronglyConnectedComponentsGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin TransitiveClosureGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin TransitiveClosureGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin TransitiveEdgesGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin TransitiveEdgesGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
visibleNodesin TransitiveEdgesGets or sets a collection of nodes to start from.
subgraphEdgesin TransitiveReductionGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin TransitiveReductionGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
customRootNodein TreeAnalysisGets or sets the node that will be used as root of the directed rooted tree.
subgraphEdgesin TreeAnalysisGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin TreeAnalysisGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin TreeSubstructuresGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin TreeSubstructuresGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
subgraphEdgesin WeightCentralityGets or sets the collection of edges which define a subset of the graph for the algorithms to work on.
subgraphNodesin WeightCentralityGets or sets the collection of nodes which define a subset of the graph for the algorithms to work on.
exteriorEdgesin CircularLayoutDataGets or sets the collection of edges that are routed around the exterior of a circle formed by each partition.
excludesin ItemCollectionA collection of items which are explicitly excluded from this collection.
bfsLayerAssignerCoreNodesin HierarchicalLayoutDataGets or sets the collection of core nodes used by the BfsLayerAssigner.
folderNodesin HierarchicalLayoutDataGets or sets the collection of folder nodes used for recursive edge styles in incremental layout mode.
incrementalEdgesin HierarchicalLayoutDataGets or sets a collection of edges that should be sequenced incrementally.
incrementalNodesin HierarchicalLayoutDataGets or sets a collection of nodes that should be layered incrementally.
nodesBeforeBusin HierarchicalLayoutDataGets or sets the collection of grid component nodes that should be placed before the common bus segment.
tabularGroupsin HierarchicalLayoutDataGets or sets the collection of tabular group nodes whose children are arranged in a tabular fashion.
uniformPortAssignmentGroupsin HierarchicalLayoutDataGets or sets the collection of group nodes for which the ports of the adjacent edges are uniformly distributed.
edgeLabelsin LabelScopeDataA collection of edge labels that should be considered to be in scope by labeling algorithms that allow restricting the labels affected by them.
edgesin LabelScopeDataA collection of edges whose labels should be considered to be in scope by labeling algorithms that allow restricting the labels affected by them.
nodeLabelsin LabelScopeDataA collection of node labels that should be considered to be in scope by labeling algorithms that allow restricting the labels affected by them.
nodesin LabelScopeDataA collection of nodes whose labels should be considered to be in scope by labeling algorithms that allow restricting the labels affected by them.
affectedComponentsin ComponentLayoutDataGets or sets a collection of nodes that determine the components that shall be laid out.
splitEdgesin GenericLayoutGridStageDataGets or sets the collection of edges that should not be considered when calculating the sub-components.
affectedNodesin PlaceNodesAtBarycenterStageDataGets or sets the collection of nodes that should be affected by the PlaceNodesAtBarycenterStage.
collapsedSubtreeRootsin RadialGroupLayoutDataGets or sets the roots of collapsed subtrees in the hierarchy.
fixedNodesin RemoveOverlapsStageDataGets or sets the collection of nodes that are fixed and must not be moved.
subgraphEdgeLabelsin SubgraphLayoutStageDataGets or sets the collection of subgraph edge labels that are included in the graph, thus, are visible for the coreLayout of the SubgraphLayoutStage.
subgraphEdgesin SubgraphLayoutStageDataGets or sets the collection of subgraph edges that are included in the graph, thus, are visible for the coreLayout of the SubgraphLayoutStage.
subgraphNodeLabelsin SubgraphLayoutStageDataGets or sets the collection of subgraph node labels that are included in the graph, thus, are visible for the coreLayout of the SubgraphLayoutStage.
subgraphNodesin SubgraphLayoutStageDataGets or sets the collection of subgraph nodes that are included in the graph, thus, are visible for the coreLayout of the SubgraphLayoutStage.
overlappingNodesin OrganicLayoutDataGets or sets the collection of nodes that are allowed to overlap with other nodes.
firstSetin OrganicLayoutSeparationConstraintDepending on the constraint orientation, the set of nodes that lie to the left or above the separation axis.
secondSetin OrganicLayoutSeparationConstraintDepending on the constraint orientation, the set of nodes that lie to the right or below the separation axis.
nodesin OrganicScopeDataGets or sets the subset of nodes that are moved by the layout algorithm.
areaGroupNodein ClearAreaLayoutDataGets or sets the group node inside which the cleared area should be located.
areaNodesin ClearAreaLayoutDataGets or sets the collection of nodes that define the area which must be cleared.
expandedNodein ClearAreaLayoutDataGets or sets the node that was expanded and, thus, defines the area that must be cleared.
fixedNodesin FillAreaLayoutDataGets or sets the collection of nodes that are fixed and must not be moved.
edgesin PartialLayoutScopeDataGets or sets the collection of (partial) edges placed by the layout.
nodesin PartialLayoutScopeDataGets or sets the collection of (partial) nodes placed by the layout.
centerNodesin RadialLayoutDataGets or sets the collection of nodes that should be placed in the center.
nonTreeEdgesin RadialLayoutDataGets or sets the collection of edges explicitly marked as not belonging to a tree.
edgesin EdgeRouterScopeDataA collection of edges that should be considered to be in scope, that is, routed by EdgeRouter.
incidentNodesin EdgeRouterScopeDataA collection of nodes whose incident edges should be considered in scope, that is, routed by EdgeRouter.
edgesin EdgeScopeDataA collection of edges that should be considered to be in scope by layout algorithms that allow restricting the edges affected by them.
incidentNodesin EdgeScopeDataA collection of nodes whose incident edges should be considered to be in scope by layout algorithms that allow restricting the edges affected by them.
affectedEdgesin ParallelEdgeRouterDataGets or sets the collection of edges affected by this router.
leadingEdgesin ParallelEdgeRouterDataGets or sets the collection of leading edges.
interleavedNodesin RadialTreeLayoutDataGets or sets the collection of nodes whose children should be arranged in an interleaved fashion.
nonTreeEdgesin RadialTreeLayoutDataGets or sets the collection of edges explicitly marked as not belonging to a tree.
treeRootin RadialTreeLayoutDataGets or sets the mapping for marking the node that will be used as root node of the tree.
assistantNodesin TreeLayoutDataGets or sets the collection of nodes the AssistantSubtreePlacer considers as assistants.
leftRightSubtreePlacerLeftNodesin TreeLayoutDataGets or sets the set of nodes that are placed on the left side of the bus.
nonTreeEdgesin TreeLayoutDataGets or sets the collection of edges explicitly marked as not belonging to a tree.
singleSplitSubtreePlacerPrimaryNodesin TreeLayoutDataGets or sets the collection of nodes the SingleSplitSubtreePlacer places with its primaryPlacer.
treeRootin TreeLayoutDataGets or sets the mapping for marking the node that will be used as the root node of the tree.
nonTreeEdgesin TreeReductionStageDataGets or sets the collection of edges explicitly marked as not belonging to a tree.

Method Return Values

add (TValue)in ItemCollectionMappingAdds the specified value which will be associated with all items in the returned item collection.
addItemCollection (NodeDataKey<boolean>, ItemCollectionConvertible<TNode>?)in GenericLayoutDataAdds a set of TNodes in the graph that will be passed to the LayoutGraph.
addItemCollection (NodeLabelDataKey<boolean>, ItemCollectionConvertible<TNodeLabel>?)in GenericLayoutDataAdds a set of node labels in the graph that will be passed to the LayoutGraph.
addItemCollection (EdgeLabelDataKey<boolean>, ItemCollectionConvertible<TEdgeLabel>?)in GenericLayoutDataAdds a set of edge labels in the graph that will be passed to the LayoutGraph.
addItemCollection (EdgeDataKey<boolean>, ItemCollectionConvertible<TEdge>?)in GenericLayoutDataAdds a set of TEdge in the graph that will be passed to the LayoutGraph.
addAlignmentConstraint (ConstraintOrientation, number?)in OrganicConstraintDataAdds constraints that cause the given nodes to align parallel to the specified axis.
addEllipse (boolean, number?)in OrganicConstraintDataAdds constraints that cause the specified nodes to be arranged on the border of an ellipse with the given aspect ratio.
addFixedDistances (ConstraintOrientation)in OrganicConstraintDataAdds constraints to fix the positions of the specified nodes in relation to one another along one coordinate axis.
addFloatingBounds (Size)in OrganicConstraintDataAdds constraints that prevent the specified nodes from occupying an area larger than the defined bounds.
addPinnedBounds (Rect)in OrganicConstraintDataAdds constraints that prevent the given nodes from being placed outside the specified rectangle.
addRectangle (number?)in OrganicConstraintDataAdds constraints that cause the specified nodes to be arranged on the border of a rectangle with the given aspect ratio.
addRegularAlignmentConstraint (ConstraintOrientation, number?)in OrganicConstraintDataAdds constraints that cause the given nodes to be aligned parallel to the specified axis.

Method Parameters

AllPairsShortestPaths ()in AllPairsShortestPaths
BetweennessCentrality ()in BetweennessCentrality
Bfs ()in Bfs
BiconnectedComponentClustering ()in BiconnectedComponentClustering
BiconnectedComponents ()in BiconnectedComponents
Bipartition ()in Bipartition
ChainSubstructures ()in ChainSubstructures
Chains ()in Chains
CliqueSubstructures ()in CliqueSubstructures
ClosenessCentrality ()in ClosenessCentrality
ClusteringCoefficient ()in ClusteringCoefficient
ConnectedComponents ()in ConnectedComponents
Cycle ()in Cycle
CycleEdges ()in CycleEdges
CycleSubstructures ()in CycleSubstructures
DegreeCentrality ()in DegreeCentralityCreates a new instance.
EdgeBetweennessClustering ()in EdgeBetweennessClustering
EigenvectorCentrality ()in EigenvectorCentrality
FeedbackEdgeSet ()in FeedbackEdgeSet
GraphCentrality ()in GraphCentrality
GraphStructureAnalyzer (IGraph, )in GraphStructureAnalyzerCreates a new instance for the given graph.
HierarchicalClustering ()in HierarchicalClustering
IndependentSets ()in IndependentSets
Intersections ()in IntersectionsCreates a new Intersections instance with default settings.
KCoreComponents ()in KCoreComponents
KMeansClustering ()in KMeansClustering
KShortestPaths ()in KShortestPaths
LabelPropagationClustering ()in LabelPropagationClustering
LongestPath ()in LongestPath
LouvainModularityClustering ()in LouvainModularityClustering
MaximumFlow ()in MaximumFlow
MinimumCostFlow ()in MinimumCostFlow
Neighborhood ()in Neighborhood
NodeAggregation ()in NodeAggregationCreates a new instance with default settings.
PageRank ()in PageRank
Paths ()in Paths
RankAssignment ()in RankAssignment
Reachability ()in Reachability
ShortestPath ()in ShortestPath
SingleSourceShortestPaths ()in SingleSourceShortestPaths
SpanningTree ()in SpanningTree
StarSubstructures ()in StarSubstructures
StronglyConnectedComponents ()in StronglyConnectedComponents
TransitiveClosure ()in TransitiveClosure
TransitiveEdges ()in TransitiveEdges
TransitiveReduction ()in TransitiveReduction
TreeAnalysis ()in TreeAnalysis
TreeSubstructures ()in TreeSubstructures
WeightCentrality ()in WeightCentrality
CircularLayoutData ()in CircularLayoutDataCreates a new instance of CircularLayoutData<TNode,TEdge,TNodeLabel,TEdgeLabel> which helps configuring CircularLayout.
HierarchicalLayoutData ()in HierarchicalLayoutData
ComponentLayoutData ()in ComponentLayoutData
GenericLayoutGridStageData ()in GenericLayoutGridStageData
PlaceNodesAtBarycenterStageData ()in PlaceNodesAtBarycenterStageData
RadialGroupLayoutData ()in RadialGroupLayoutData
RemoveOverlapsStageData ()in RemoveOverlapsStageData
SubgraphLayoutStageData ()in SubgraphLayoutStageData
OrganicLayoutData ()in OrganicLayoutData
ClearAreaLayoutData ()in ClearAreaLayoutData
FillAreaLayoutData ()in FillAreaLayoutData
RadialLayoutData ()in RadialLayoutData
ParallelEdgeRouterData ()in ParallelEdgeRouterData
RadialTreeLayoutData ()in RadialTreeLayoutData
TreeLayoutData ()in TreeLayoutData
TreeReductionStageData ()in TreeReductionStageData