Interface that can be used to find ports at specific locations in the canvas.
Inheritance Hierarchy
IPortSelectionTester
Remarks
Type Details
- yFiles module
- view
Methods
Returns the port at the given world coordinate position or null if there is no such port.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- context - IInputModeContext
- The input mode context to use for querying the position.
- location - Point
- The coordinates of the position in the world coordinate system.
Returns
- ↪IPort?
- The port at the position or
null.
Returns the ports for the given marquee rectangle.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- context - IInputModeContext
- The input mode context to use for querying the position.
- rectangle - Rect
- The marquee selection box in the world coordinate system.
Returns
- ↪IEnumerable<IPort>
- An enumerable over the ports inside the marquee selection box.
Returns the ports within the given lasso path.
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- context - IInputModeContext
- The input mode context to use for querying the position.
- lassoPath - GeneralPath
- A lasso path in world coordinates.
Returns
- ↪IEnumerable<IPort>
- An enumerable over the ports inside the
lassoPath.
Static Methods
Parameters
options - Object
A map of options to pass to the method.
A map of options to pass to the method.
- getHitPort - function(IInputModeContext, Point):IPort
Returns the port at the given world coordinate position or
nullif there is no such port.This property holds the implementation for getHitPort.
- getPortsInBox - function(IInputModeContext, Rect):IEnumerable<IPort>
Returns the ports for the given marquee rectangle.
This property holds the implementation for getPortsInBox.
- getPortsInPath - function(IInputModeContext, GeneralPath):IEnumerable<IPort>
Returns the ports within the given lasso path.
This property holds the implementation for getPortsInPath.