blockly > RenderedConnection > closest
RenderedConnection.closest() method
Find the closest compatible connection to this connection. All parameters are in workspace units.
Signature:
closest(maxLimit: number, dxy: Coordinate): {
connection: RenderedConnection | null;
radius: number;
};
Parameters
| Parameter |
Type |
Description |
| maxLimit |
number |
The maximum radius to another connection. |
| dxy |
Coordinate |
Offset between this connection's location in the database and the current location (as a result of dragging). |
Returns:
{ connection: RenderedConnection | null; radius: number; }
Contains two properties: 'connection' which is either another connection or null, and 'radius' which is the distance.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-18 UTC.
[null,null,["Last updated 2024-09-18 UTC."],[[["The `RenderedConnection.closest()` method locates the nearest compatible connection within a specified radius, considering potential dragging offsets."],["It returns an object containing the closest connection (or null if none found) and the distance to that connection."],["The search radius and drag offset are provided as input parameters to the method."]]],["The `closest()` method in `RenderedConnection` finds the nearest compatible connection within a specified radius (`maxLimit`). It considers an offset (`dxy`) representing a connection's movement. The method returns an object with two properties: `connection`, which is the closest `RenderedConnection` or `null` if none found, and `radius`, the distance to that connection. All calculations use workspace units.\n"]]
