Class Bubble__Class

constructor

• new Bubble__Class(
      workspace: WorkspaceSvg,
      content: Element,
      shape: Element,
      anchorXY: Blockly.utils.Coordinate,
      bubbleWidth: number,
      bubbleHeight: number,
  ): Bubble__Class

  Class for UI bubble.

  Parameters

  • workspace: WorkspaceSvg

    The workspace on which to draw the bubble.

  • content: Element

    SVG content for the bubble.

  • shape: Element

    SVG element to avoid eclipsing.

  • anchorXY: Blockly.utils.Coordinate

    Absolute position of bubble's anchor point.

  • bubbleWidth: number

    Width of bubble, or null if not resizable.

  • bubbleHeight: number

    Height of bubble, or null if not resizable.

  Returns Bubble__Class

  Implements

disposed

dispose

• dispose(): void

  Dispose of this bubble.

  Returns void

getBubbleSize

• getBubbleSize(): Blockly.utils.Size

  Get the dimensions of this bubble.

  Returns Blockly.utils.Size

  The height and width of the bubble.

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.

isDeletable

• isDeletable(): boolean

  Get whether this bubble is deletable or not.

  Returns boolean

  True if deletable.

  Package

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

  Package

moveTo

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

  Move the bubble group 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

  Package

promote

• promote(): boolean

  Move this bubble to the top of the stack.

  Returns boolean

  Whether or not the bubble has been moved.

  Package

registerMoveEvent

• registerMoveEvent(callback: Function): void

  Register a function as a callback event for when the bubble is moved.

  Parameters

  • callback: Function

    The function to call on move.

  Returns void

registerResizeEvent

• registerResizeEvent(callback: Function): void

  Register a function as a callback event for when the bubble is resized.

  Parameters

  • callback: Function

    The function to call on resize.

  Returns void

setAnchorLocation

• setAnchorLocation(xy: Blockly.utils.Coordinate): void

  Notification that the anchor has moved. Update the arrow and bubble accordingly.

  Parameters

  • xy: Blockly.utils.Coordinate

    Absolute location.

  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

  Package

setBubbleSize

• setBubbleSize(width: number, height: number): void

  Size this bubble.

  Parameters

  • width: number

    Width of the bubble.

  • height: number

    Height of the bubble.

  Returns void

setColour

• setColour(hexColour: string): void

  Change the colour of a bubble.

  Parameters

  • hexColour: string

    Hex code of colour.

  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

  Package

setSvgId

• setSvgId(id: string): void

  Expose the block's ID on the bubble's top-level SVG group.

  Parameters

  • id: string

    ID of block.

  Returns void

showContextMenu

• showContextMenu(_e: Event): void

  Show the context menu for this bubble.

  Parameters

  • _e: Event

    Mouse event.

  Returns void

  Package