Show:
Extends EndPoint

Used to access the current set of show notes

Access this object via the showNotes property.

Table of Contents

Methods

close ()

Inherited from EndPoint: EndPoint.js:55

Closes the end point and stops listening for events.

This method no longer needs to be explicitly called as end points are now automatically closed when the last event listener is removed.

open ()

Inherited from EndPoint: EndPoint.js:35

Opens this end point and starts listening for events.

This method no longer needs to be explicitly called as end points are now automatically opened when the first event listener is attached.

Use this method to keep the end point open even when no event listeners are attached.

untilOpen () Promise

Inherited from EndPoint: EndPoint.js:137

Returns a promise that will be resolved when this end point is opened

Returns:

Promise

Example:

let C = new CantabileApi();
   C.application.open();
await C.application.untilOpen();

Properties

items

ShowNote[]

Defined in ShowNotes.js:33

An array of show note items

Events

changed

Defined in ShowNotes.js:53

Fired when anything about the current set of show notes changes

itemAdded

Defined in ShowNotes.js:46

Fired after a new show note has been added

Event Payload:

  • index Number

    The zero based index of the newly added item

itemChanged

Defined in ShowNotes.js:98

Fired when something about an show note has changed

Event Payload:

  • index Number

    The zero based index of the item that changed

itemMoved

Defined in ShowNotes.js:82

Fired when an show note has been moved

Event Payload:

  • from Number

    The zero based index of the item before being moved

  • to Number

    The zero based index of the item's new position

itemRemoved

Defined in ShowNotes.js:66

Fired after a show note has been removed

Event Payload:

  • index Number

    The zero based index of the removed item

reload

Defined in ShowNotes.js:112

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