Interface: IMetricsManager

Properties

getAbsoluteMetrics

public

Gets the absolute left and absolute top in pixel coordinates. This is where the visible workspace starts in relation to the svg container.

Returns

non-null Blockly.MetricsManager.AbsoluteMetrics The absolute metrics for the workspace.

getContentMetrics

public

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).

Parameter

opt_getWorkspaceCoordinates

Optional

boolean

True to get the content metrics in workspace coordinates, false to get them in pixel coordinates.

Returns

non-null Blockly.MetricsManager.ContainerRegion The metrics for the content container.

getFlyoutMetrics

public

Gets the width and the height of the flyout on the workspace in pixel coordinates. Returns 0 for the width and height if the workspace has a category toolbox instead of a simple toolbox.

Parameter

opt_own

Optional

boolean

Whether to only return the workspace's own flyout.

Returns

non-null Blockly.MetricsManager.ToolboxMetrics The width and height of the flyout.

getMetrics

public

Returns an object with all the metrics required to size scrollbars for a top level workspace. The following properties are computed: Coordinate system: pixel coordinates, -left, -up, +right, +down .viewHeight: Height of the visible portion of the workspace. .viewWidth: Width of the visible portion of the workspace. .contentHeight: Height of the content. .contentWidth: Width of the content. .svgHeight: Height of the Blockly div (the view + the toolbox, simple or otherwise), .svgWidth: Width of the Blockly div (the view + the toolbox, simple or otherwise), .viewTop: Top-edge of the visible portion of the workspace, relative to the workspace origin. .viewLeft: Left-edge of the visible portion of the workspace, relative to the workspace origin. .contentTop: Top-edge of the content, relative to the workspace origin. .contentLeft: Left-edge of the content relative to the workspace origin. .absoluteTop: Top-edge of the visible portion of the workspace, relative to the blocklyDiv. .absoluteLeft: Left-edge of the visible portion of the workspace, relative to the blocklyDiv. .toolboxWidth: Width of the toolbox, if it exists. Otherwise zero. .toolboxHeight: Height of the toolbox, if it exists. Otherwise zero. .flyoutWidth: Width of the flyout if it is always open. Otherwise zero. .flyoutHeight: Height of the flyout if it is always open. Otherwise zero. .toolboxPosition: Top, bottom, left or right. Use TOOLBOX_AT constants to compare.

Returns

non-null Blockly.utils.Metrics Contains size and position metrics of a top level workspace.

getScrollMetrics

Returns the metrics for the scroll area of the workspace.

Parameter

opt_getWorkspaceCoordinates

Optional

boolean

True to get the scroll metrics in workspace coordinates, false to get them in pixel coordinates.

opt_viewMetrics

Optional

Blockly.MetricsManager.ContainerRegion

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.

Value must not be null.

opt_contentMetrics

Optional

Blockly.MetricsManager.ContainerRegion

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.

Value must not be null.

Returns

non-null Blockly.MetricsManager.ContainerRegion The metrics for the scroll container

getSvgMetrics

public

Gets the width and height of the workspace's parent svg element in pixel coordinates. This area includes the toolbox and the visible workspace area.

Returns

non-null Blockly.utils.Size The width and height of the workspace's parent svg element.

getToolboxMetrics

public

Gets the width, height and position of the toolbox on the workspace in pixel coordinates. Returns 0 for the width and height if the workspace has a simple toolbox instead of a category toolbox. To get the width and height of a simple toolbox @see getFlyoutMetrics.

Returns

non-null Blockly.MetricsManager.ToolboxMetrics The object with the width, height and position of the toolbox.

getViewMetrics

public

Gets the metrics for the visible workspace in either pixel or workspace coordinates. The visible workspace does not include the toolbox or flyout.

Parameter

opt_getWorkspaceCoordinates

Optional

boolean

True to get the view metrics in workspace coordinates, false to get them in pixel coordinates.

Returns

non-null Blockly.MetricsManager.ContainerRegion The width, height, top and left of the viewport in either workspace coordinates or pixel coordinates.

hasFixedEdges

package

Returns whether the scroll area has fixed edges.

Returns

boolean Whether the scroll area has fixed edges.