I

IPortSelectionTester

Show Usages
Interface that can be used to find ports at specific locations in the canvas.
Inheritance Hierarchy

Remarks

This interface is mostly provided through the lookup of IPortOwner implementations such as INode.

Members

No filters for this type

Methods

getHitPort

(context: IInputModeContext, location: Point): IPort
abstract
Returns the port at the given world coordinate position or null if there is no such port.
abstract

Parameters

context: IInputModeContext
The input mode context to use for querying the position.
location: Point
The coordinates of the position in the world coordinate system.

Return Value

IPort
The port at the position or null.

getPortsInBox

(context: IInputModeContext, rectangle: Rect): IEnumerable<IPort>
abstract
Returns the ports for the given marquee rectangle.
abstract

Parameters

context: IInputModeContext
The input mode context to use for querying the position.
rectangle: Rect
The marquee selection box in the world coordinate system.

Return Value

IEnumerable<IPort>
An enumerable over the ports inside the marquee selection box.

getPortsInPath

(context: IInputModeContext, lassoPath: GeneralPath): IEnumerable<IPort>
abstract
Returns the ports within the given lasso path.
abstract

Parameters

context: IInputModeContext
The input mode context to use for querying the position.
lassoPath: GeneralPath
A lasso path in world coordinates.

Return Value

IEnumerable<IPort>
An enumerable over the ports inside the lassoPath.

Static Methods

create

(): IPortSelectionTester
static
Creates an implementation of the interface IPortSelectionTester from the given definition.
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.
static

Parameters

Return Value

IPortSelectionTester
An instance of the IPortSelectionTester interface based on the given definition.