An interface for possible IPort candidates used by IPortCandidateProvider and the like.
Remarks
Note that if an instance's validity property is DYNAMIC this instance getPortCandidateAt method serves as a factory for the actual candidates.
Port candidates are rendered with CSS classes depending on their state. Each port candidate uses the yfiles-port-candidate-template CSS class and one or more of the following CSS classes: yfiles-valid, yfiles-invalid, yfiles-focused, yfiles-non-focused.
Related Reading in the Developer's Guide
Type Details
- yFiles module
- view
See Also
Properties
Gets the model parameter that will be used for the locationParameter if this candidate is chosen.
Remarks
Gets the possible owner of the port to be created for this candidate.
Gets the port instance that is already live in the graph if this candidate wraps an existing port or null otherwise.
Gets whether this instance is a valid port candidate.
Remarks
See Also
Methods
If the client decides to use this port candidate, this method will serve as a factory to create the instance.
Remarks
Parameters
A map of options to pass to the method.
- context - IInputModeContext
- The input mode context for which the port will be created. Implementations can depend on it providing an IGraph instance in the lookup of the instance.
Returns
- ↪IPort
- The port instance to use if this candidate has been chosen. This method may not return
null.
Throws
See Also
Returns a candidate that is derived from this instance that best fits the provided location.
Remarks
Parameters
A map of options to pass to the method.
- context - IInputModeContext
- The input mode context for which a concrete candidate is queried.
- location - Point
- The location for which a candidate should be returned.