Class GraphComment

The GraphComment class implements a region in the graph that contains additional meta data such as comments.

Hierarchy (view full)

Constructors

Properties

_bounds: Rect2
_description: string
_id: UUID
_title: string

Accessors

  • get backgroundColor(): Color
  • Comment color

    Returns Color

  • set backgroundColor(value): void
  • Parameters

    Returns void

  • get description(): string
  • The comment description, rendered as multi-line text.

    Returns string

  • set description(value): void
  • Parameters

    • value: string

    Returns void

  • get id(): UUID
  • Gets the ID of the comment.

    Returns UUID

  • get textColor(): Color
  • Comment text color

    Returns Color

  • set textColor(value): void
  • Parameters

    Returns void

  • get title(): string
  • The comment title, rendered as single-line text.

    Returns string

  • set title(value): void
  • Parameters

    • value: string

    Returns void

Methods

  • Method that must be called whenever the Comment is dirtied.

    Returns void

Events

onDirty: Event<[], void>

An event invoked whenever the comment is dirtied.