blockly > IMetricsManager > getContentMetrics
IMetricsManager.getContentMetrics() method
Gets content metrics in either pixel or workspace coordinates. The content area is a rectangle around all the top bounded elements on the workspace (workspace comments and blocks).
Signature:
getContentMetrics(opt_getWorkspaceCoordinates?: boolean): ContainerRegion;
Parameters
| Parameter |
Type |
Description |
| opt_getWorkspaceCoordinates |
boolean |
(Optional) True to get the content metrics in workspace coordinates, false to get them in pixel coordinates. |
Returns:
ContainerRegion
The metrics for the content container.
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 `getContentMetrics()` method calculates the size and position of the area containing all blocks and comments on a Blockly workspace."],["It allows you to retrieve these measurements in either pixel or workspace coordinates by using the optional `opt_getWorkspaceCoordinates` parameter."],["The method returns a `ContainerRegion` object which holds the calculated dimensions and position of the content area."]]],["The `getContentMetrics()` method retrieves content metrics, representing a rectangle around all top-level elements (blocks and comments) on the workspace. It accepts an optional boolean parameter, `opt_getWorkspaceCoordinates`. When `true`, it returns metrics in workspace coordinates; when `false` or omitted, it returns metrics in pixel coordinates. The method's output is a `ContainerRegion` object, containing the content container's metrics.\n"]]
