mirror of
https://github.com/google/blockly.git
synced 2026-01-09 10:00:09 +01:00
037eb59b89
* chore: add linting for tsdoc * chore: don't require types on return * chore: remove redundant fileoverview from ts * chore: change return to returns and add some newlines * chore: remove license tag * chore: don't require params/return docs * chore: remove spurious struct tags * Revert "chore: change return to returns and add some newlines" This reverts commitd6d8656a45. * chore: don't auto-add param names * chore: disable require-param bc it breaks on this * return to returns and add line breaks * chore: configure additional jsdoc rules * chore: run format * Revert "chore: remove license tag" This reverts commit173455588a. * chore: allow license tag format * chore: only require jsdoc on exported items * chore: add missing jsdoc or silence where needed * chore: run format * chore: lint fixes
95 lines
2.2 KiB
TypeScript
95 lines
2.2 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright 2020 Google LLC
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
/**
|
|
* Workspace metrics definitions.
|
|
*
|
|
* @namespace Blockly.utils.Metrics
|
|
*/
|
|
import * as goog from '../../closure/goog/goog.js';
|
|
goog.declareModuleId('Blockly.utils.Metrics');
|
|
|
|
|
|
/** @alias Blockly.utils.Metrics */
|
|
export interface Metrics {
|
|
/** Height of the visible portion of the workspace. */
|
|
viewHeight: number;
|
|
|
|
/** Width of the visible portion of the workspace. */
|
|
viewWidth: number;
|
|
|
|
/** Height of the content. */
|
|
contentHeight: number;
|
|
|
|
/** Width of the content. */
|
|
contentWidth: number;
|
|
|
|
/** Height of the scroll area. */
|
|
scrollHeight: number;
|
|
|
|
/** Width of the scroll area. */
|
|
scrollWidth: number;
|
|
|
|
/**
|
|
* Top-edge of the visible portion of the workspace, relative to the workspace
|
|
* origin.
|
|
*/
|
|
viewTop: number;
|
|
|
|
/**
|
|
* Left-edge of the visible portion of the workspace, relative to the
|
|
* workspace origin.
|
|
*/
|
|
viewLeft: number;
|
|
|
|
/** Top-edge of the content, relative to the workspace origin. */
|
|
contentTop: number;
|
|
|
|
/** Left-edge of the content relative to the workspace origin. */
|
|
contentLeft: number;
|
|
|
|
/** Top-edge of the scroll area, relative to the workspace origin. */
|
|
scrollTop: number;
|
|
|
|
/** Left-edge of the scroll area relative to the workspace origin. */
|
|
scrollLeft: number;
|
|
|
|
/**
|
|
* Top-edge of the visible portion of the workspace, relative to the
|
|
* blocklyDiv.
|
|
*/
|
|
absoluteTop: number;
|
|
|
|
/**
|
|
* Left-edge of the visible portion of the workspace, relative to the
|
|
* blocklyDiv.
|
|
*/
|
|
absoluteLeft: number;
|
|
|
|
/**
|
|
* Height of the Blockly div (the view + the toolbox, simple of otherwise).
|
|
*/
|
|
svgHeight: number;
|
|
|
|
/** Width of the Blockly div (the view + the toolbox, simple or otherwise). */
|
|
svgWidth: number;
|
|
|
|
/** Width of the toolbox, if it exists. Otherwise zero. */
|
|
toolboxWidth: number;
|
|
|
|
/** Height of the toolbox, if it exists. Otherwise zero. */
|
|
toolboxHeight: number;
|
|
|
|
/** Top, bottom, left or right. Use TOOLBOX_AT constants to compare. */
|
|
toolboxPosition: number;
|
|
|
|
/** Width of the flyout if it is always open. Otherwise zero. */
|
|
flyoutWidth: number;
|
|
|
|
/** Height of the flyout if it is always open. Otherwise zero. */
|
|
flyoutHeight: number;
|
|
}
|