Packagecom.yworks.graph.model
Interfacepublic interface IEdgePortCandidateProvider
ImplementorsAllCandidatesEdgePortCandidateProvider, CurrentEdgePortsCandidateProvider

This interface can be used to query IPortCandidates for a specific existing IEdge.

Implementations of this interface can be queried using the lookup method of an IEdgeimplementation. This interface provides alternative candidates for the IEdge.sourcePort or IEdge.targetPort of an edge.


Public Methods
 MethodDefined by
  
getSourcePortCandidates(context:IInputModeContext, graph:IGraph):Iterable
Returns all source port candidates that may be used for the edge.
IEdgePortCandidateProvider
  
getTargetPortCandidates(context:IInputModeContext, graph:IGraph):Iterable
Returns all target port candidates that may be used for the edge.
IEdgePortCandidateProvider
Method detail
getSourcePortCandidates()method
public function getSourcePortCandidates(context:IInputModeContext, graph:IGraph):Iterable

Returns all source port candidates that may be used for the edge.

The iterable may both contain valid and invalid port candidates.

Parameters
context:IInputModeContext — The context for which the candidates should be provided.
 
graph:IGraph — The graph for which the candidates should be queried.

Returns
Iterable — An iterable over all source port candidates that are associated with the current context edge.
getTargetPortCandidates()method 
public function getTargetPortCandidates(context:IInputModeContext, graph:IGraph):Iterable

Returns all target port candidates that may be used for the edge.

The iterable may both contain valid and invalid port candidates.

Parameters
context:IInputModeContext — The context for which the candidates should be provided.
 
graph:IGraph — The graph for which the candidates should be queried.

Returns
Iterable — An iterable over all target port candidates that are associated with the current context edge.