Stay organized with collections
Save and categorize content based on your preferences.
blockly > utils > svgMath > getDocumentScroll
Gets the document scroll distance as a coordinate object. Copied from Closure's goog.dom.getDocumentScroll.
Signature:
export declare function getDocumentScroll(): Coordinate;
Returns:
Coordinate
Object with values 'x' and 'y'.
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\u003egetDocumentScroll()\u003c/code\u003e function retrieves the horizontal and vertical scroll distances of the document.\u003c/p\u003e\n"],["\u003cp\u003eIt returns a \u003ccode\u003eCoordinate\u003c/code\u003e object containing the \u003ccode\u003ex\u003c/code\u003e (horizontal) and \u003ccode\u003ey\u003c/code\u003e (vertical) scroll positions.\u003c/p\u003e\n"],["\u003cp\u003eThis function is adapted from Closure's \u003ccode\u003egoog.dom.getDocumentScroll\u003c/code\u003e for use within Blockly.\u003c/p\u003e\n"]]],[],null,["[blockly](./blockly.md) \\\u003e [utils](./blockly.utils_namespace.md) \\\u003e [svgMath](./blockly.utils_namespace.svgmath_namespace.md) \\\u003e [getDocumentScroll](./blockly.utils_namespace.svgmath_namespace.getdocumentscroll_1_function.md)\n\nutils.svgMath.getDocumentScroll() function\n------------------------------------------\n\nGets the document scroll distance as a coordinate object. Copied from Closure's goog.dom.getDocumentScroll.\n\n**Signature:** \n\n export declare function getDocumentScroll(): Coordinate;\n\n**Returns:**\n\n[Coordinate](./blockly.utils_namespace.coordinate_class.md)\n\nObject with values 'x' and 'y'."]]
