pivotick v3.0.0

---

pivotick / Note

Class: Note

Defined in: Note.ts:38

Constructors

Constructor

new Note(options, domID): Note

Defined in: Note.ts:62

Parameters

options

NoteOptions = {}

domID

string = ...

Returns

Note

Methods

clearAttachmentDirty()

clearAttachmentDirty(): void

Defined in: Note.ts:172

Returns

void

---

clearDirty()

clearDirty(): void

Defined in: Note.ts:160

Returns

void

---

getAttachedElement()

getAttachedElement(): AttachedElement | undefined

Defined in: Note.ts:127

Returns

AttachedElement | undefined

---

getGraphElement()

getGraphElement(): SVGGElement | null

Defined in: Note.ts:111

Returns

SVGGElement | null

---

isAttachmentDirty()

isAttachmentDirty(): boolean

Defined in: Note.ts:176

Returns

boolean

---

isDirty()

isDirty(): boolean

Defined in: Note.ts:164

Returns

boolean

---

isEditing()

isEditing(): boolean

Defined in: Note.ts:119

Returns

boolean

---

markAttachmentDirty()

markAttachmentDirty(): void

Defined in: Note.ts:168

Returns

void

---

markDirty()

markDirty(): void

Defined in: Note.ts:156

Returns

void

---

setAttachedElement()

setAttachedElement(attachedElement): void

Defined in: Note.ts:131

Parameters

attachedElement

AttachedElement | undefined

Returns

void

---

setColor()

setColor(color): void

Defined in: Note.ts:97

Parameters

color

string

Returns

void

---

setContent()

setContent(content): void

Defined in: Note.ts:92

Parameters

content

string

Returns

void

---

setEditing()

setEditing(editing): void

Defined in: Note.ts:123

Parameters

editing

boolean

Returns

void

---

setGraphElement()

setGraphElement(el): void

Defined in: Note.ts:107

Parameters

el

SVGGElement

Returns

void

---

setPosition()

setPosition(x, y): void

Defined in: Note.ts:82

Parameters

x

number

y

number

Returns

void

---

setSize()

setSize(width, height): void

Defined in: Note.ts:87

Parameters

width

number

height

number

Returns

void

---

setSurface()

setSurface(surface): void

Defined in: Note.ts:102

Parameters

surface

NoteSurface

Returns

void

---

toJSON()

toJSON(): NoteOptions

Defined in: Note.ts:141

The plain options that rebuild this note: new Note(note.toJSON()) or graph.addNote(note.toJSON()) on another graph. Visibility is left out, as hiding notes is a view state rather than part of the note.

Returns

NoteOptions

Properties

color

color: string

Defined in: Note.ts:49

---

content

content: string

Defined in: Note.ts:48

---

domID

readonly domID: string

Defined in: Note.ts:60

---

height

height: number

Defined in: Note.ts:46

---

id

id: string

Defined in: Note.ts:40

---

surface

surface: NoteSurface

Defined in: Note.ts:50

---

visible

visible: boolean

Defined in: Note.ts:51

---

width

width: number

Defined in: Note.ts:45

---

x

x: number

Defined in: Note.ts:42

---

y

y: number

Defined in: Note.ts:43