Class WorkspaceCommentSvg

id

isComment

workspace

addFocus

• addFocus(): void

  Focus this comment. Highlight it visually.

  Returns void

  Package

addSelect

• addSelect(): void

  Select this comment. Highlight it visually.

  Returns void

  Package

dispose

• dispose(): void

  Dispose of this comment.

  Returns void

  Package

getBoundingRectangle

• getBoundingRectangle(): Blockly.utils.Rect

  Returns the coordinates of a bounding box describing the dimensions of this comment. Coordinate system: workspace coordinates.

  Returns Blockly.utils.Rect

  Object with coordinates of the bounding box.

  Package

getContent

• getContent(): string

  Returns this comment's text.

  Returns string

  Comment text.

  Package

getHeight

• getHeight(): number

  Get comment height.

  Returns number

  Comment height.

  Package

getRelativeToSurfaceXY

• getRelativeToSurfaceXY(): Blockly.utils.Coordinate

  Return the coordinates of the top-left corner of this comment relative to the drawing surface's origin (0,0), in workspace units. If the comment is on the workspace, (0, 0) is the origin of the workspace coordinate system. This does not change with workspace scale.

  Returns Blockly.utils.Coordinate

  Object with .x and .y properties in workspace coordinates.

  Package

getSvgRoot

• getSvgRoot(): SVGElement

  Return the root node of the SVG or null if none exists.

  Returns SVGElement

  The root SVG node (probably a group).

  Package

getWidth

• getWidth(): number

  Get comment width.

  Returns number

  Comment width.

  Package

getXY

• getXY(): Blockly.utils.Coordinate

  Get stored location.

  Returns Blockly.utils.Coordinate

  The comment's stored location. This is not valid if the comment is currently being dragged.

  Package

initSvg

• initSvg(opt_noSelect?: boolean): void

  Create and initialize the SVG representation of a workspace comment. May be called more than once.

  Parameters

  • Optionalopt_noSelect: boolean

    Text inside text area will be selected if false

  Returns void

  Package

isDeletable

• isDeletable(): boolean

  Get whether this comment is deletable or not.

  Returns boolean

  True if deletable.

  Package

isEditable

• isEditable(): boolean

  Get whether this comment is editable or not.

  Returns boolean

  True if editable.

isMovable

• isMovable(): boolean

  Get whether this comment is movable or not.

  Returns boolean

  True if movable.

  Package

moveBy

• moveBy(dx: number, dy: number): void

  Move a comment by a relative offset.

  Parameters

  • dx: number

    Horizontal offset, in workspace units.

  • dy: number

    Vertical offset, in workspace units.

  Returns void

  Package

moveDuringDrag

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

  Move this comment during a drag, taking into account whether we are using a drag surface to translate blocks.

  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

moveToDragSurface

• moveToDragSurface(): void

  Move this comment to its workspace's drag surface, accounting for positioning. Generally should be called at the same time as setDragging(true). Does nothing if useDragSurface_ is false.

  Returns void

  Package

removeFocus

• removeFocus(): void

  Unfocus this comment. Remove its highlighting.

  Returns void

  Package

removeSelect

• removeSelect(): void

  Unselect this comment. Remove its highlighting.

  Returns void

  Package

select

• select(): void

  Select this comment. Highlight it visually.

  Returns void

  Package

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

setContent

• setContent(content: string): void

  Set this comment's content.

  Parameters

  • content: string

    Comment content.

  Returns void

  Package

setDeletable

• setDeletable(deletable: boolean): void

  Set whether this comment is deletable or not.

  Parameters

  • deletable: boolean

    True if deletable.

  Returns void

  Package

setDeleteStyle

• setDeleteStyle(enable: boolean): void

  Update the cursor over this comment by adding or removing a class.

  Parameters

  • enable: boolean

    True if the delete cursor should be shown, false otherwise.

  Returns void

  Package

setDragging

• setDragging(adding: boolean): void

  Recursively adds or removes the dragging class to this node and its children.

  Parameters

  • adding: boolean

    True if adding, false if removing.

  Returns void

  Package

setEditable

• setEditable(editable: boolean): void

  Set whether this comment is editable or not.

  Parameters

  • editable: boolean

    True if editable.

  Returns void

setHeight

• setHeight(height: number): void

  Set comment height.

  Parameters

  • height: number

    Comment height.

  Returns void

  Package

setMovable

• setMovable(movable: boolean): void

  Set whether this comment is movable or not.

  Parameters

  • movable: boolean

    True if movable.

  Returns void

  Package

setWidth

• setWidth(width: number): void

  Set comment width.

  Parameters

  • width: number

    comment width.

  Returns void

  Package

showContextMenu

• showContextMenu(e: Event): void

  Show the context menu for this workspace comment.

  Parameters

  • e: Event

    Mouse event.

  Returns void

  Package

toCopyData

• toCopyData(): CopyData

  Encode a comment for copying.

  Returns CopyData

  Copy metadata.

  Package

toXml

• toXml(opt_noId?: boolean): Element

  Encode a comment subtree as XML, but don't serialize the XY coordinates. This method avoids some expensive metrics-related calls that are made in toXmlWithXY().

  Parameters

  • Optionalopt_noId: boolean

    True if the encoder should skip the comment ID.

  Returns Element

  Tree of XML elements.

  Package

toXmlWithXY

• toXmlWithXY(opt_noId?: boolean): Element

  Encode a comment subtree as XML with XY coordinates.

  Parameters

  • Optionalopt_noId: boolean

    True if the encoder should skip the comment ID.

  Returns Element

  Tree of XML elements.

  Package

translate

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

  Transforms a comment by setting the translation on the transform attribute of the block's SVG.

  Parameters

  • x: number

    The x coordinate of the translation in workspace units.

  • y: number

    The y coordinate of the translation in workspace units.

  Returns void

  Package

unselect

• unselect(): void

  Unselect this comment. Remove its highlighting.

  Returns void

  Package

updateMovable

• updateMovable(): void

  Add or remove the UI indicating if this comment is movable or not.

  Returns void

  Package