Class GraphComment

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

Hierarchy (View Summary)

GraphObject
- GraphComment

Index

Constructors

Properties

_bounds _description _id _title

Accessors

backgroundColor bounds description id position size textColor title

Methods

clone markAsDirty

Events

Constructors

constructor

new GraphComment(): GraphComment

Returns GraphComment

Overrides GraphObject.constructor

Properties

`Protected`_bounds

_bounds: Rect2

`Protected`_description

_description: string

`Protected` `Readonly`_id

_id: UUID

`Protected`_title

_title: string

Accessors

backgroundColor

get backgroundColor(): SRGBColor

Comment color

Returns SRGBColor
set backgroundColor(value: Immutable<SRGBColor>): void
Parameters
- value: Immutable<SRGBColor>
Returns void

bounds

get bounds(): Immutable<Rect2>

The bounds of the comment in the graph.

Returns Immutable<Rect2>
set bounds(value: Immutable<Rect2>): void
Parameters
- value: Immutable<Rect2>
Returns void

description

get description(): string

The comment description, rendered as multi-line text.

Returns string
set description(value: string): void
Parameters
- value: string
Returns void

id

get id(): UUID

Gets the ID of the comment.

Returns UUID

Overrides GraphObject.id

position

get position(): Immutable<Vector2>

Position of this comment in the graph.

Returns Immutable<Vector2>
set position(value: Immutable<Vector2>): void
Parameters
- value: Immutable<Vector2>
Returns void

size

get size(): Immutable<Size2>

Size of this comment in the graph.

Returns Immutable<Size2>
set size(value: Immutable<Size2>): void
Parameters
- value: Immutable<Size2>
Returns void

textColor

get textColor(): SRGBColor

Comment text color

Returns SRGBColor
set textColor(value: Immutable<SRGBColor>): void
Parameters
- value: Immutable<SRGBColor>
Returns void

title

get title(): string

The comment title, rendered as single-line text.

Returns string
set title(value: string): void
Parameters
- value: string
Returns void

Methods

clone

clone(): GraphComment

Clones this instance.

Returns GraphComment

Overrides GraphObject.clone

markAsDirty

markAsDirty(): void

Method that must be called whenever the Comment is dirtied.

Returns void

Events

`Readonly`onDirty

onDirty: Event<[]>

An event invoked whenever the comment is dirtied.