Class WorkspaceComment

id

isComment

workspace

dispose

• dispose(): void

  Dispose of this comment.

  Returns void

  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

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

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

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

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

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