Interface that can be used to find ports at specific locations in the canvas.
Inheritance Hierarchy
IPortSelectionTester
Remarks
Type Details
- yfiles module
- view-component
- yfiles-umd modules
- All view modules
- Legacy UMD name
- yfiles.input.IPortSelectionTester
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.
Static Methods
Creates an implementation of the interface IPortSelectionTester from the given definition.
Remarks
The given object must contain exactly the abstract members of the IPortSelectionTester interface. No member may be omitted and no additional members can be added. While additional custom members can later be added directly on the instance, this is discouraged.
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.
Returns
- ↪IPortSelectionTester
- An instance of the IPortSelectionTester interface based on the given definition.