Cantabile JavaScript API Cantabile JavaScript API

  • API Docs for Version: 4.0.0

    • Show:

    Application

    Extends EndPoint

    Interface to the application object

    Access this object via the application 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

    bankedProgramNumberFormat

    String

    Defined in Application.js:109

    The preferred banked program display format - "SeparateBanks","CombinedBanks","Plain" or "ZeroPadded"

    baseProgramNumber

    Number

    Defined in Application.js:102

    The base program number (0 or 1)

    build

    Number

    Defined in Application.js:80

    The application's build number

    build

    ColorEntry[]

    Defined in Application.js:87

    An array of color entries for the color index table

    busy

    Boolean

    Defined in Application.js:94

    The application's busy status

    companyName

    String

    Defined in Application.js:45

    The application's company name

    edition

    String

    Defined in Application.js:66

    The application edition string

    name

    String

    Defined in Application.js:52

    The application name

    version

    String

    Defined in Application.js:59

    The application version string

    Events

    busyChanged

    Defined in Application.js:118

    Fired when the application busy state changes

    Event Payload:

    • busy Boolean

      True if the app is currently busy

    changed

    Defined in Application.js:22

    Fired when any of the application properties change

    open

    Defined in Application.js:28

    Fired when the application object has initially loaded