Show:

F2.Constants.Events Class

Events constants

Properties

Name Description
APP_SCRIPTS_LOADED static

The APP_SCRIPTS_LOADED event is fired when all the scripts defined in the AppManifest have been loaded.

APP_SYMBOL_CHANGE static

The APP_SYMBOL_CHANGE event is fired when the symbol is changed in an app. It is up to the app developer to fire this event. Returns an object with the symbol and company name:

{ symbol: 'MSFT', name: 'Microsoft Corp (NASDAQ)' }
APP_WIDTH_CHANGE static

The APP_WIDTH_CHANGE event will be fired by the container when the width of an app is changed. The app's instanceId should be concatenated to this constant. Returns an object with the gridSize and width in pixels:

{ gridSize:8, width:620 }
CONTAINER_LOCALE_CHANGE static

The CONTAINER_LOCALE_CHANGE event will be fired by the container when the locale of the container has changed. This event should only be fired by the container or container provider. Returns an object with the updated locale (IETF-defined standard language tag):

{ locale: 'en-us' }
CONTAINER_SYMBOL_CHANGE static

The CONTAINER_SYMBOL_CHANGE event is fired when the symbol is changed at the container level. This event should only be fired by the container or container provider. Returns an object with the symbol and company name:

{ symbol: 'MSFT', name: 'Microsoft Corp (NASDAQ)' }
CONTAINER_WIDTH_CHANGE static

The CONTAINER_WIDTH_CHANGE event will be fired by the container when the width of the container has changed.

RESOURCE_FAILED_TO_LOAD static deprecated

The RESOURCE_FAILED_TO_LOAD event will be fired by the container when it fails to load a script or style.

Properties

APP_SCRIPTS_LOADED String final static

The APP_SCRIPTS_LOADED event is fired when all the scripts defined in the AppManifest have been loaded.


APP_SYMBOL_CHANGE String final static

The APP_SYMBOL_CHANGE event is fired when the symbol is changed in an app. It is up to the app developer to fire this event. Returns an object with the symbol and company name:

{ symbol: 'MSFT', name: 'Microsoft Corp (NASDAQ)' }

APP_WIDTH_CHANGE String final static

The APP_WIDTH_CHANGE event will be fired by the container when the width of an app is changed. The app's instanceId should be concatenated to this constant. Returns an object with the gridSize and width in pixels:

{ gridSize:8, width:620 }

CONTAINER_LOCALE_CHANGE String final static

The CONTAINER_LOCALE_CHANGE event will be fired by the container when the locale of the container has changed. This event should only be fired by the container or container provider. Returns an object with the updated locale (IETF-defined standard language tag):

{ locale: 'en-us' }

CONTAINER_SYMBOL_CHANGE String final static

The CONTAINER_SYMBOL_CHANGE event is fired when the symbol is changed at the container level. This event should only be fired by the container or container provider. Returns an object with the symbol and company name:

{ symbol: 'MSFT', name: 'Microsoft Corp (NASDAQ)' }

CONTAINER_WIDTH_CHANGE String final static

The CONTAINER_WIDTH_CHANGE event will be fired by the container when the width of the container has changed.


RESOURCE_FAILED_TO_LOAD String deprecated final static

Defined in sdk\src\constants.js:179

Deprecated: since 1.4

The RESOURCE_FAILED_TO_LOAD event will be fired by the container when it fails to load a script or style.