documentationfor yFiles for HTML 2.6

Usages of PortCandidate

Properties

portCandidatein IPortCandidateSetEntryGets the actual PortCandidate associated with this IPortCandidateSetEntry.

Method Return Values

createCandidate (PortDirections, number?)in PortCandidateFactory method that creates a free PortCandidate instance with the given direction and cost of usage.
createCandidate (number, number, PortDirections, number?)in PortCandidateFactory method that creates a fixed PortCandidate instance with the given cost of usage, direction and offset values.
createCandidate (PortConstraint)in PortCandidateFactory method that returns a free PortCandidate instance with zero cost of usage and the direction specified by the side of the given PortConstraint.

Method Parameters

add (PortCandidate, number?)in PortCandidateSetAdds a PortCandidate with the given capacity to this PortCandidateSet.
calculateBendCost (Edge, YList, PortCandidate, PortCandidate)in OrthogonalPatternEdgeRouterCalculates the costs for all bends of the given path.
calculateCost (Edge, YList, PortCandidate, PortCandidate)in OrthogonalPatternEdgeRouterCalculates the edge cost of a possible edge path, in order to determine which path is the best, i.e., the cheapest.
calculateCrossingCosts (Edge, YList, PortCandidate, PortCandidate)in OrthogonalPatternEdgeRouterCalculates the overall crossing costs of the given path, including edge crossings, edge overlaps and node crossings.
calculateEdgeLength (Edge, YList, PortCandidate, PortCandidate)in OrthogonalPatternEdgeRouterCalculates the costs for the length of the given path.
calculatePortCandidateCost (Edge, YList, PortCandidate, PortCandidate)in OrthogonalPatternEdgeRouterCalculates the costs for the chosen PortCandidates.
calculateSelfLoopSelfSidePenaltyCost (Edge, YList, PortCandidate, PortCandidate)in OrthogonalPatternEdgeRouterCalculates the extra penalty that is added to the path's cost if the edge is a self-loop and source and target ports have the same direction.
valueOfPortCandidate (PortCandidate)in PartitionCellBorderReturns the type of the border that is defined by the given PortCandidate.