Interface FrameworkEvents

Callable

• __call(eventName: "ApplicationConfigLoadedEvent"): TypedEvent<function>
• __call(eventName: "ApplicationNativeReadyEvent"): TypedEvent<function>
• __call(eventName: "ApplicationNativeRemovedEvent"): TypedEvent<function>
• __call(eventName: "ApplicationOfflineEvent"): TypedEvent<function>
• __call(eventName: "ApplicationOnlineEvent"): TypedEvent<function>
• __call(eventName: "ApplicationResizedEvent"): TypedEvent<function>
• __call(eventName: "ApplicationShutdownEvent"): TypedEvent<function>
• __call(eventName: "ConfigurationLoadFailedEvent"): TypedEvent<function>
• __call(eventName: "LibraryDownloadedEvent"): TypedEvent<function>
• __call(eventName: "ModuleInitializedEvent"): TypedEvent<function>
• __call(eventName: "ModuleInitializationFailedEvent"): TypedEvent<function>
• __call(eventName: "RegionActivatedEvent"): TypedEvent<function>
• __call(eventName: "RegionDeactivatedEvent"): TypedEvent<function>
• __call(eventName: "TraceEvent"): TypedEvent<function>
• __call(eventName: "ViewActivatedEvent"): TypedEvent<function>
• __call(eventName: "ViewContainerActivatedEvent"): TypedEvent<function>
• __call(eventName: "ViewContainerDeactivatedEvent"): TypedEvent<function>
• __call(eventName: "ViewDeactivatedEvent"): TypedEvent<function>
• __call(eventName: "ViewDimensionsChangedEvent"): TypedEvent<function>
• __call(eventName: "ViewHostedEvent"): TypedEvent<function>
• __call(eventName: "ViewInitializedEvent"): TypedEvent<function>
• __call(eventName: "ViewUnhostedEvent"): TypedEvent<function>
• __call(eventName: "ViewerLibrariesDownloadedEvent"): TypedEvent<function>
• __call(eventName: "NetworkConnectivityChangedEvent"): TypedEvent<function>
• __call(eventName: string): TypedEvent<any>

• Raised when the application has received and processed its configuration materials.

  docs-gcx-event

  geocortex.framework

  name

  ApplicationConfigLoadedEvent

  introduced

  2.0

  gcx-event-category

  Load

  Parameters

  • eventName: "ApplicationConfigLoadedEvent"

  Returns TypedEvent<function>

• Raised when native application components have been initialized and are ready for use.

  docs-gcx-event

  geocortex.framework

  name

  ApplicationNativeReadyEvent

  Parameters

  • eventName: "ApplicationNativeReadyEvent"

  Returns TypedEvent<function>

• Raised when native application components have moved to a non-ready state.

  docs-gcx-event

  geocortex.framework

  name

  ApplicationNativeRemovedEvent

  Parameters

  • eventName: "ApplicationNativeRemovedEvent"

  Returns TypedEvent<function>

• Raised when the application goes into the offline state.

  docs-gcx-event

  geocortex.framework

  name

  ApplicationOfflineEvent

  introduced

  1.1

  gcx-event-category

  Offline

  Parameters

  • eventName: "ApplicationOfflineEvent"

  Returns TypedEvent<function>

• Raised when the application goes into the online state.

  docs-gcx-event

  geocortex.framework

  name

  ApplicationOnlineEvent

  introduced

  1.1

  gcx-event-category

  Offline

  Parameters

  • eventName: "ApplicationOnlineEvent"

  Returns TypedEvent<function>

• Raised when the application is resized.

  docs-gcx-event

  geocortex.framework

  name

  ApplicationResizedEvent

  introduced

  1.1

  gcx-event-category

  Interface

  Parameters

  • eventName: "ApplicationResizedEvent"

  Returns TypedEvent<function>

• Raised when the application has been instructed to shut down.

  docs-gcx-event

  geocortex.framework

  name

  ApplicationShutdownEvent

  introduced

  1.0

  gcx-event-category

  Start-Up, Initialization and Shutdown

  Parameters

  • eventName: "ApplicationShutdownEvent"

  Returns TypedEvent<function>

• Raised when an error is encountered while parsing configuration.

  docs-gcx-event

  geocortex.framework

  name

  ConfigurationLoadFailedEvent

  introduced

  1.0

  gcx-event-category

  Load

  Parameters

  • eventName: "ConfigurationLoadFailedEvent"

  Returns TypedEvent<function>

• Raised when a library file specified in configuration is successfully marked as having been downloaded.

  docs-gcx-event

  geocortex.framework

  name

  LibraryDownloadedEvent

  introduced

  1.0

  gcx-event-category

  Start-Up, Initialization and Shutdown

  Parameters

  • eventName: "LibraryDownloadedEvent"

  Returns TypedEvent<function>

• Raised when a module is initialized.

  docs-gcx-event

  geocortex.framework

  name

  ModuleInitializedEvent

  introduced

  1.0

  gcx-event-category

  Start-Up, Initialization and Shutdown

  Parameters

  • eventName: "ModuleInitializedEvent"

  Returns TypedEvent<function>

• Raised when a module fails to initialize.

  docs-gcx-event

  geocortex.framework

  name

  ModuleInitializationFailedEvent

  introduced

  1.0

  gcx-event-category

  Start-Up, Initialization and Shutdown

  Parameters

  • eventName: "ModuleInitializationFailedEvent"

  Returns TypedEvent<function>

• Raised when a view is activated in a region that previously had no active views.

  docs-gcx-event

  geocortex.framework

  name

  RegionActivatedEvent

  introduced

  1.0

  gcx-event-category

  Interface

  Parameters

  • eventName: "RegionActivatedEvent"

  Returns TypedEvent<function>

• Raised when the last active view in a region is deactivated.

  docs-gcx-event

  geocortex.framework

  name

  RegionDeactivatedEvent

  introduced

  1.0

  gcx-event-category

  Interface

  Parameters

  • eventName: "RegionDeactivatedEvent"

  Returns TypedEvent<function>

• Raised by each trace operation. Allows pluggable tracing and logging functionality.

  docs-gcx-event

  geocortex.framework

  name

  TraceEvent

  introduced

  1.0

  gcx-event-category

  Debugging

  Parameters

  • eventName: "TraceEvent"

  Returns TypedEvent<function>

• Raised when a view is activated in a region.

  docs-gcx-event

  geocortex.framework

  name

  ViewActivatedEvent

  introduced

  1.0

  gcx-event-category

  Interface

  Parameters

  • eventName: "ViewActivatedEvent"

  Returns TypedEvent<function>

• Raised when a view container is activated in a region.

  docs-gcx-event

  geocortex.framework

  name

  ViewContainerActivatedEvent

  introduced

  1.0

  gcx-event-category

  Interface

  Parameters

  • eventName: "ViewContainerActivatedEvent"

  Returns TypedEvent<function>

• Raised when a view container is deactivated in a region.

  docs-gcx-event

  geocortex.framework

  name

  ViewContainerDeactivatedEvent

  introduced

  2.1

  gcx-event-category

  Interface

  Parameters

  • eventName: "ViewContainerDeactivatedEvent"

  Returns TypedEvent<function>

• Raised when a view is deactivated in a region.

  docs-gcx-event

  geocortex.framework

  name

  ViewDeactivatedEvent

  introduced

  1.0

  gcx-event-category

  Interface

  Parameters

  • eventName: "ViewDeactivatedEvent"

  Returns TypedEvent<function>

• Raised by views when they wish to notify other components that their dimensions have changed.

  docs-gcx-event

  geocortex.framework

  name

  ViewDimensionsChangedEvent

  introduced

  1.0

  gcx-event-category

  Interface

  Parameters

  • eventName: "ViewDimensionsChangedEvent"

  Returns TypedEvent<function>

• Raised when a view is added to a region.

  docs-gcx-event

  geocortex.framework

  name

  ViewHostedEvent

  introduced

  1.0

  gcx-event-category

  Interface

  Parameters

  • eventName: "ViewHostedEvent"

  Returns TypedEvent<function>

• Raised when a view is created and bound to a view model for the first time.

  docs-gcx-event

  geocortex.framework

  name

  ViewInitializedEvent

  introduced

  2.6

  gcx-event-category

  Interface

  Parameters

  • eventName: "ViewInitializedEvent"

  Returns TypedEvent<function>

• Raised when a view is removed from a region.

  docs-gcx-event

  geocortex.framework

  name

  ViewUnhostedEvent

  introduced

  1.0

  gcx-event-category

  Interface

  Parameters

  • eventName: "ViewUnhostedEvent"

  Returns TypedEvent<function>

• Raised when all library files specified in configuration are successfully processed. This event is raised even if one or more library downloads fail, in which case an error will be added to the viewer log.

  docs-gcx-event

  geocortex.framework

  name

  ViewerLibrariesDownloadedEvent

  introduced

  1.0

  gcx-event-category

  Start-Up, Initialization and Shutdown

  Parameters

  • eventName: "ViewerLibrariesDownloadedEvent"

  Returns TypedEvent<function>

• Raised when network connectivity is changed.

  docs-gcx-event

  geocortex.framework

  name

  NetworkConnectivityChangedEvent

  introduced

  2.9.1

  gcx-event-category

  Network

  Parameters

  • eventName: "NetworkConnectivityChangedEvent"

  Returns TypedEvent<function>

• Events exposed by the framework.

  Parameters

  • eventName: string

  Returns TypedEvent<any>