Stay organized with collections
Save and categorize content based on your preferences.
blockly > Grid > alignXY
Grid.alignXY() method
Given a coordinate, return the nearest coordinate aligned to the grid.
Signature:
alignXY(xy: Coordinate): Coordinate;
Parameters
| Parameter |
Type |
Description |
| xy |
Coordinate |
A workspace coordinate. |
Returns:
Coordinate
Workspace coordinate of nearest grid point. If there's no change, return the same coordinate object.
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."],[[["\u003cp\u003eThe \u003ccode\u003ealignXY\u003c/code\u003e method aligns a given workspace coordinate to the nearest grid point.\u003c/p\u003e\n"],["\u003cp\u003eIt takes a \u003ccode\u003eCoordinate\u003c/code\u003e object as input, representing the workspace coordinate to be aligned.\u003c/p\u003e\n"],["\u003cp\u003eThe method returns a \u003ccode\u003eCoordinate\u003c/code\u003e object representing the nearest grid point, potentially returning the original coordinate if no alignment is needed.\u003c/p\u003e\n"]]],["The `alignXY` method, part of the Grid class, takes a workspace coordinate (`xy`) as input. It calculates and returns the nearest coordinate that aligns with the grid. If the input coordinate is already aligned, the same coordinate object is returned. The method's signature is `alignXY(xy: Coordinate): Coordinate;`, accepting a Coordinate type and returning a Coordinate type. The core action is finding and returning the grid-aligned coordinate.\n"],null,["[blockly](./blockly.md) \\\u003e [Grid](./blockly.grid_class.md) \\\u003e [alignXY](./blockly.grid_class.alignxy_1_method.md)\n\nGrid.alignXY() method\n\nGiven a coordinate, return the nearest coordinate aligned to the grid.\n\n**Signature:** \n\n alignXY(xy: Coordinate): Coordinate;\n\nParameters\n\n| Parameter | Type | Description |\n|-----------|-------------------------------------------------------------|-------------------------|\n| xy | [Coordinate](./blockly.utils_namespace.coordinate_class.md) | A workspace coordinate. |\n\n**Returns:**\n\n[Coordinate](./blockly.utils_namespace.coordinate_class.md)\n\nWorkspace coordinate of nearest grid point. If there's no change, return the same coordinate object."]]
