Interface IBubble

dispose

getRelativeToSurfaceXY

• getRelativeToSurfaceXY(): Blockly.utils.Coordinate

  Return the coordinates of the top-left corner of this bubble's body relative to the drawing surface's origin (0,0), in workspace units.

  Returns Blockly.utils.Coordinate

  Object with .x and .y properties.

getSvgRoot

• getSvgRoot(): SVGElement

  Return the root node of the bubble's SVG group.

  Returns SVGElement

  The root SVG node of the bubble's group.

moveDuringDrag

• moveDuringDrag(
      dragSurface: BlockDragSurfaceSvg,
      newLoc: Blockly.utils.Coordinate,
  ): void

  Move this bubble during a drag, taking into account whether or not there is a drag surface.

  Parameters

  • dragSurface: BlockDragSurfaceSvg

    The surface that carries rendered items during a drag, or null if no drag surface is in use.

  • newLoc: Blockly.utils.Coordinate

    The location to translate to, in workspace coordinates.

  Returns void

moveTo

• moveTo(x: number, y: number): void

  Move the bubble to the specified location in workspace coordinates.

  Parameters

  • x: number

    The x position to move to.

  • y: number

    The y position to move to.

  Returns void

setAutoLayout

• setAutoLayout(enable: boolean): void

  Set whether auto-layout of this bubble is enabled. The first time a bubble is shown it positions itself to not cover any blocks. Once a user has dragged it to reposition, it renders where the user put it.

  Parameters

  • enable: boolean

    True if auto-layout should be enabled, false otherwise.

  Returns void

setDeleteStyle

• setDeleteStyle(enable: boolean): void

  Update the style of this bubble when it is dragged over a delete area.

  Parameters

  • enable: boolean

    True if the bubble is about to be deleted, false otherwise.

  Returns void

setDragging

• setDragging(adding: boolean): void

  Triggers a move callback if one exists at the end of a drag.

  Parameters

  • adding: boolean

    True if adding, false if removing.

  Returns void