Application Class

Interface to the application object

Access this object via the Cantabile#application property.

class Application extends EndPoint {
    get companyName(): string;
    get name(): string;
    get version(): string;
    get edition(): string;
    get copyright(): string;
    get build(): number;
    get colors(): ColorEntry[];
    get busy(): boolean;
    get baseProgramNumber(): number;
    get bankedProgramNumberFormat(): string;
}

#Properties

#bankedProgramNumberFormat

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

get bankedProgramNumberFormat(): string;

#baseProgramNumber

The base program number (0 or 1)

get baseProgramNumber(): number;

#build

The application's build number

get build(): number;

#busy

The application's busy status

get busy(): boolean;

#colors

An array of ColorEntry items for the color index table

get colors(): ColorEntry[];

#companyName

The application's company name

get companyName(): string;

#copyright

The application's copyright message

get copyright(): string;

#edition

The application edition string

get edition(): string;

#name

The application name

get name(): string;

#version

The application version string

get version(): string;

#Events

#'busyChanged' Event

Fired when the application's busy state changes

application.on('busyChanged', (busy: boolean) => { });

• busy True if the app is currently busy

#'changed' Event

Fired when any of the application properties change

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

#'connected' Event

Fired when the application object has initially connected

application.on('connected', () => { });