blockly > utils

utils namespace

Classes

Class	Description
Coordinate	Class for representing coordinates and positions.
Rect	Class for representing rectangular regions.
Size	Class for representing sizes consisting of a width and height.
Svg	A name with the type of the SVG element stored in the generic.

Enumerations

Enumeration	Description
KeyCodes	Key codes for common characters. Copied from Closure's goog.events.KeyCodes This list is not localized and therefore some of the key codes are not correct for non US keyboard layouts. See comments below.

Functions

Function	Description
checkMessageReferences(message)	Validates that any %{MSG_KEY} references in the message refer to keys of the Msg string table.
getBlockTypeCounts(block, opt_stripFollowing)	Get a map of all the block's descendants mapping their type to the number of children with that type.
getDocumentScroll()	Gets the document scroll distance as a coordinate object. Copied from Closure's goog.dom.getDocumentScroll.
getRelativeXY(element)	Return the coordinates of the top-left corner of this element relative to its parent. Only for SVG elements and children (e.g. rect, g, path).
is3dSupported()	Check if 3D transforms are supported by adding an element and attempting to set the property.
parseBlockColour(colour)	Parse a block colour from a number or string, as provided in a block definition.
replaceMessageReferences(message)	Replaces string table references in a message, if the message is a string. For example, "%{bky_my_msg}" and "%{BKY_MY_MSG}" will both be replaced with the value in Msg['MY_MSG'].
runAfterPageLoad(fn)	Calls a function after the page has loaded, possibly immediately.
screenToWsCoordinates(ws, screenCoordinates)	Converts screen coordinates to workspace coordinates.
tokenizeInterpolation(message)	Parse a string with any number of interpolation tokens (%1, %2, ...). It will also replace string table references (e.g., %{bky_my_msg} and %{BKY_MY_MSG} will both be replaced with the value in Msg['MY_MSG']). Percentage sign characters '%' may be self-escaped (e.g., '%%').

Interfaces

Interface	Description
Metrics

Namespaces

Namespace	Description
aria
array
browserEvents
colour
deprecation
dom
extensions
idGenerator
math
object
parsing
string
style
svgMath
svgPaths
toolbox
userAgent
xml

Variables

Variable	Description
getInjectionDivXY_