Stay organized with collections
Save and categorize content based on your preferences.
blockly > ConnectionDB > searchForClosest
ConnectionDB.searchForClosest() method
Find the closest compatible connection to this connection.
Signature:
searchForClosest(conn: RenderedConnection, maxRadius: number, dxy: Coordinate): {
connection: RenderedConnection | null;
radius: number;
};
Parameters
Parameter |
Type |
Description |
conn |
RenderedConnection |
The connection searching for a compatible mate. |
maxRadius |
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["The `searchForClosest` method helps find the nearest compatible connection within a given radius for a provided connection."],["It considers an offset to account for connection dragging and returns the closest connection (or null) along with the distance."]]],["The `searchForClosest()` method in `ConnectionDB` locates the nearest compatible connection. It takes a `RenderedConnection` (`conn`), a `maxRadius` (number), and a `Coordinate` (`dxy`) for location offset as parameters. It returns an object containing two properties: `connection`, which is either a found `RenderedConnection` or `null`, and `radius`, the distance to the found connection. The method identifies the closest matching connection within the defined radius.\n"]]