Stay organized with collections
Save and categorize content based on your preferences.
blockly > MetricsManager > getScrollMetrics
Returns the metrics for the scroll area of the workspace.
Signature:
getScrollMetrics(opt_getWorkspaceCoordinates?: boolean, opt_viewMetrics?: ContainerRegion, opt_contentMetrics?: ContainerRegion): ContainerRegion;
Parameters
| Parameter |
Type |
Description |
| opt_getWorkspaceCoordinates |
boolean |
(Optional) True to get the scroll metrics in workspace coordinates, false to get them in pixel coordinates. |
| opt_viewMetrics |
ContainerRegion |
(Optional) The view metrics if they have been previously computed. Passing in null may cause the view metrics to be computed again, if it is needed. |
| opt_contentMetrics |
ContainerRegion |
(Optional) The content metrics if they have been previously computed. Passing in null may cause the content metrics to be computed again, if it is needed. |
Returns:
ContainerRegion
The metrics for the scroll 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.
[[["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 `MetricsManager.getScrollMetrics()` method returns the scroll area metrics for the Blockly workspace."],["This method can optionally return metrics in workspace or pixel coordinates, and takes optional pre-computed view and content metrics."],["The returned `ContainerRegion` object contains the scroll container's metrics."]]],["The `getScrollMetrics` method, part of `MetricsManager`, retrieves scroll area metrics of a workspace. It can return metrics in either workspace or pixel coordinates, controlled by the `opt_getWorkspaceCoordinates` parameter. Optional parameters `opt_viewMetrics` and `opt_contentMetrics` allow pre-computed metrics to be provided to potentially avoid recalculation. The method returns a `ContainerRegion` object containing the scroll container's metrics.\n"]]
