Class: Flyout | Blockly | Google Developers

Class: Flyout

Constructor

new Flyout(workspaceOptions)

Class for a flyout.

Parameter
workspaceOptions	Object Dictionary of options for the workspace. Value must not be null.

Parameter

workspaceOptions

Object

Dictionary of options for the workspace.

Value must not be null.

Properties

autoClose

boolean

Does the flyout automatically close when a block is created?

buttons_

protected

non-null Array of non-null Blockly.FlyoutButton

List of visible buttons.

CORNER_RADIUS

constant

number

Corner radius of the flyout background.

dragAngleRange_

protected

number

Range of a drag angle from a flyout considered "dragging toward workspace". Drags that are within the bounds of this many degrees from the orthogonal line to the flyout edge are considered to be "drags toward the workspace". Example: Flyout Edge Workspace [block] / <-within this angle, drags "toward workspace" | [block] ---- orthogonal to flyout boundary ---- | [block] \ | The angle is given in degrees from the orthogonal.

This is used to know when to create a new block and when to scroll the flyout. Setting it to 360 means that all drags create a new block.

GAP_X

constant

number

Gap between items in horizontal flyouts. Can be overridden with the "sep" element.

GAP_Y

constant

number

Gap between items in vertical flyouts. Can be overridden with the "sep" element.

height_

protected

number

Height of flyout.

MARGIN

constant

number

Margin around the edges of the blocks in the flyout.

RTL

boolean

Is RTL vs LTR.

SCROLLBAR_PADDING

constant

number

Top/bottom padding between scrollbar and edge of flyout background.

toolboxPosition_

protected

number

Position of the toolbox and flyout relative to the workspace.

width_

protected

number

Width of flyout.

workspace_

protected

non-null Blockly.Workspace

Methods

addBlockListeners_

protected

addBlockListeners_(root, block, rect)

Add listeners to a block that has been added to the flyout.

Parameter
root	Element The root node of the SVG group the block is in. Value must not be null.
block	Blockly.Block The block to add listeners for. Value must not be null.
rect	Element The invisible rectangle under the block that acts as a mat for that block. Value must not be null.

Parameter

root

Element

The root node of the SVG group the block is in.

Value must not be null.

block

Blockly.Block

The block to add listeners for.

Value must not be null.

rect

Element

The invisible rectangle under the block that acts as a mat for that block.

Value must not be null.

createBlock

package

createBlock(originalBlock) returns Blockly.BlockSvg

Create a copy of this block on the workspace.

Parameter
originalBlock	Blockly.BlockSvg The block to copy from the flyout. Value must not be null.

Parameter

originalBlock

Blockly.BlockSvg

The block to copy from the flyout.

Value must not be null.

Returns: Blockly.BlockSvg The newly created block, or null if something went wrong with deserialization.

createDom

createDom(tagName) returns Element

Creates the flyout's DOM. Only needs to be called once. The flyout can either exist as its own svg element or be a g element nested inside a separate svg element.

Parameter
tagName	string The type of tag to put the flyout in. This should be

Parameter

tagName

string

The type of tag to put the flyout in. This should be

Returns: non-null Element The flyout's SVG group.

createRect_

protected

createRect_(block, x, y, blockHW, index) returns SVGElement

Create and place a rectangle corresponding to the given block.

Parameter
block	Blockly.Block The block to associate the rect to. Value must not be null.
x	number The x position of the cursor during this layout pass.
y	number The y position of the cursor during this layout pass.
blockHW	{height: number, width: number} The height and width of the block. Value must not be null.
index	number The index into the mats list where this rect should be placed.

Returns: non-null SVGElement Newly created SVG element for the rectangle behind the block.

dispose

dispose()

Dispose of this flyout. Unlink from all DOM elements to prevent memory leaks.

getHeight

getHeight() returns number

Get the height of the flyout.

Returns: number The width of the flyout.

getWidth

getWidth() returns number

Get the width of the flyout.

Returns: number The width of the flyout.

getWorkspace

package

getWorkspace() returns Blockly.WorkspaceSvg

Get the workspace inside the flyout.

Returns: non-null Blockly.WorkspaceSvg The workspace inside the flyout.

hide

hide()

Hide and empty the flyout.

init

init(targetWorkspace)

Initializes the flyout.

Parameter
targetWorkspace	Blockly.Workspace The workspace in which to create new blocks. Value must not be null.

Parameter

targetWorkspace

Blockly.Workspace

The workspace in which to create new blocks.

Value must not be null.

initFlyoutButton_

protected

initFlyoutButton_(button, x, y)

Initialize the given button: move it to the correct location, add listeners, etc.

Parameter
button	Blockly.FlyoutButton The button to initialize and place. Value must not be null.
x	number The x position of the cursor during this layout pass.
y	number The y position of the cursor during this layout pass.

Parameter

button

Blockly.FlyoutButton

The button to initialize and place.

Value must not be null.

number

The x position of the cursor during this layout pass.

number

The y position of the cursor during this layout pass.

isBlockCreatable_

package

isBlockCreatable_(block) returns boolean

Does this flyout allow you to create a new instance of the given block? Used for deciding if a block can be "dragged out of" the flyout.

Parameter
block	Blockly.BlockSvg The block to copy from the flyout. Value must not be null.

Parameter

block

Blockly.BlockSvg

The block to copy from the flyout.

Value must not be null.

Returns: boolean True if you can create a new instance of the block, false otherwise.

isScrollable

package

isScrollable() returns boolean

Returns: boolean True if this flyout may be scrolled with a scrollbar or by dragging.

isVisible

isVisible() returns boolean

Is the flyout visible?

Returns: boolean True if visible.

moveRectToBlock_

protected

moveRectToBlock_(rect, block)

Move a rectangle to sit exactly behind a block, taking into account tabs, hats, and any other protrusions we invent.

Parameter
rect	SVGElement The rectangle to move directly behind the block. Value must not be null.
block	Blockly.BlockSvg The block the rectangle should be behind. Value must not be null.

Parameter

rect

SVGElement

The rectangle to move directly behind the block.

Value must not be null.

block

Blockly.BlockSvg

The block the rectangle should be behind.

Value must not be null.

positionAt_

protected

positionAt_(width, height, x, y)

Update the view based on coordinates calculated in position().

Parameter
width	number The computed width of the flyout's SVG group
height	number The computed height of the flyout's SVG group.
x	number The computed x origin of the flyout's SVG group.
y	number The computed y origin of the flyout's SVG group.

reflow

reflow()

Reflow blocks and their mats.

setContainerVisible

setContainerVisible(visible)

Set whether this flyout's container is visible.

Parameter
visible	boolean Whether the container is visible.

Parameter

visible

boolean

Whether the container is visible.

setVisible

setVisible(visible)

Set whether the flyout is visible. A value of true does not necessarily mean that the flyout is shown. It could be hidden because its container is hidden.

Parameter
visible	boolean True if visible.

Parameter

visible

boolean

True if visible.

show

show(xmlList)

Show and populate the flyout.

Parameter
xmlList	(non-null Array or string) List of blocks to show. Variables and procedures have a custom set of blocks.

Parameter

xmlList

(non-null Array or string)

List of blocks to show. Variables and procedures have a custom set of blocks.

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 our Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated July 24, 2019.