ShowNotes Class

Used to access the current set of show notes

Access this object via the Cantabile#showNotes property.

class ShowNotes extends EndPoint {
    getV1Raw(): Promise<object>;
    get items(): ShowNote[];
    get markdown(): any;
    storeMarkdown(markdown: string): Promise<void>;
}

#Properties

#items

An array of ShowNote items

get items(): ShowNote[];

#markdown

The markdown show notes

get markdown(): any;

#Methods

#getV1Raw()

Get's the original v1 show notes in raw json format

getV1Raw(): Promise<object>;

#storeMarkdown()

Stores the markdown notes for the current song

storeMarkdown(markdown: string): Promise<void>;

• markdown The markdown to store

#Events

#'changed' Event

Fired when anything about the current set of show notes changes

showNotes.on('changed', () => { });

#'itemAdded' Event

Fired after a new show note has been added

showNotes.on('itemAdded', (index: Number) => { });

• index The zero based index of the newly added item

#'itemChanged' Event

Fired when something about an show note has changed

showNotes.on('itemChanged', (index: Number) => { });

• index The zero based index of the item that changed

#'itemMoved' Event

Fired when an show note has been moved

showNotes.on('itemMoved', (from: Number, to: Number) => { });

• from The zero based index of the item before being moved

• to The zero based index of the item's new position

#'itemRemoved' Event

Fired after a show note has been removed

showNotes.on('itemRemoved', (index: Number) => { });

• index The zero based index of the removed item

#'markdownChanged' Event

Fired when the markdown notes have changed

showNotes.on('markdownChanged', () => { });

#'reload' Event

Fired when the entire set of show notes has changed (eg: after loading a new song)

showNotes.on('reload', () => { });