Class Flyout

autoClose

CORNER_RADIUS

GAP_X

GAP_Y

horizontalLayout

id

MARGIN

RTL

SCROLLBAR_MARGIN

targetWorkspace

createBlock

• createBlock(originalBlock: Blockly.BlockSvg): Blockly.BlockSvg

  Create a copy of this block on the workspace.

  Parameters

  • originalBlock: Blockly.BlockSvg

    The block to copy from the flyout.

  Returns Blockly.BlockSvg

  The newly created block.

  Throws

  if something went wrong with deserialization.

  Package

createDom

• createDom(
      tagName:
          | string
          | Blockly.utils.Svg<SVGGElement>
          | Blockly.utils.Svg<SVGSVGElement>,
  ): SVGElement

  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.

  Parameters

  • tagName: string | Blockly.utils.Svg<SVGGElement> | Blockly.utils.Svg<SVGSVGElement>

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

  Returns SVGElement

  The flyout's SVG group.

dispose

• dispose(): void

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

  Returns void

  Suppress

getClientRect

• getClientRect(): Blockly.utils.Rect

  Returns the bounding rectangle of the drag target area in pixel units relative to viewport.

  Returns Blockly.utils.Rect

  The component's bounding box.

getFlyoutScale

• getFlyoutScale(): number

  Get the scale (zoom level) of the flyout. By default, this matches the target workspace scale, but this can be overridden.

  Returns number

  Flyout workspace scale.

getHeight

• getHeight(): number

  Get the height of the flyout.

  Returns number

  The width of the flyout.

getWidth

• getWidth(): number

  Get the width of the flyout.

  Returns number

  The width of the flyout.

getWorkspace

• getWorkspace(): WorkspaceSvg

  Get the workspace inside the flyout.

  Returns WorkspaceSvg

  The workspace inside the flyout.

  Package

getX

• getX(): number

  Calculates the x coordinate for the flyout position.

  Returns number

  X coordinate.

getY

• getY(): number

  Calculates the y coordinate for the flyout position.

  Returns number

  Y coordinate.

hide

• hide(): void

  Hide and empty the flyout.

  Returns void

init

• init(targetWorkspace: WorkspaceSvg): void

  Initializes the flyout.

  Parameters

  • targetWorkspace: WorkspaceSvg

    The workspace in which to create new blocks.

  Returns void

isBlockCreatable_

• isBlockCreatable_(block: Blockly.BlockSvg): 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.

  Parameters

  • block: Blockly.BlockSvg

    The block to copy from the flyout.

  Returns boolean

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

  Package

isDragTowardWorkspace

• isDragTowardWorkspace(currentDragDeltaXY: Blockly.utils.Coordinate): boolean

  Determine if a drag delta is toward the workspace, based on the position and orientation of the flyout. This is used in determineDragIntention_ to determine if a new block should be created or if the flyout should scroll.

  Parameters

  • currentDragDeltaXY: Blockly.utils.Coordinate

    How far the pointer has moved from the position at mouse down, in pixel units.

  Returns boolean

  True if the drag is toward the workspace.

  Package

isScrollable

• isScrollable(): boolean

  Returns boolean

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

  Package

isVisible

• isVisible(): boolean

  Is the flyout visible?

  Returns boolean

  True if visible.

onDragEnter

• onDragEnter(_dragElement: IDraggable): void

  Handles when a cursor with a block or bubble enters this drag target.

  Parameters

  • _dragElement: IDraggable

    The block or bubble currently being dragged.

  Returns void

onDragExit

• onDragExit(_dragElement: IDraggable): void

  Handles when a cursor with a block or bubble exits this drag target.

  Parameters

  • _dragElement: IDraggable

    The block or bubble currently being dragged.

  Returns void

onDragOver

• onDragOver(_dragElement: IDraggable): void

  Handles when a cursor with a block or bubble is dragged over this drag target.

  Parameters

  • _dragElement: IDraggable

    The block or bubble currently being dragged.

  Returns void

onDrop

• onDrop(_dragElement: IDraggable): void

  Handles when a block or bubble is dropped on this component. Should not handle delete here.

  Parameters

  • _dragElement: IDraggable

    The block or bubble currently being dragged.

  Returns void

position

• position(): void

  Position the flyout.

  Returns void

reflow

• reflow(): void

  Reflow blocks and their mats.

  Returns void

setContainerVisible

• setContainerVisible(visible: boolean): void

  Set whether this flyout's container is visible.

  Parameters

  • visible: boolean

    Whether the container is visible.

  Returns void

setVisible

• setVisible(visible: boolean): void

  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.

  Parameters

  • visible: boolean

    True if visible.

  Returns void

shouldPreventMove

• shouldPreventMove(_dragElement: IDraggable): boolean

  Returns whether the provided block or bubble should not be moved after being dropped on this component. If true, the element will return to where it was when the drag started.

  Parameters

  • _dragElement: IDraggable

    The block or bubble currently being dragged.

  Returns boolean

  Whether the block or bubble provided should be returned to drag start.

show

• show(flyoutDef: string | FlyoutDefinition): void

  Show and populate the flyout.

  Parameters

  • flyoutDef: string | FlyoutDefinition

    Contents to display in the flyout. This is either an array of Nodes, a NodeList, a toolbox definition, or a string with the name of the dynamic category.

  Returns void

wouldDelete

• wouldDelete(element: IDraggable, couldConnect: boolean): boolean

  Returns whether the provided block or bubble would be deleted if dropped on this area. This method should check if the element is deletable and is always called before onDragEnter/onDragOver/onDragExit.

  Parameters

  • element: IDraggable

    The block or bubble currently being dragged.

  • couldConnect: boolean

    Whether the element could could connect to another.

  Returns boolean

  Whether the element provided would be deleted if dropped on this area.