Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents configuration for a Framework application.

Hierarchy

  • ConfigurationModel

Index

Constructors

constructor

  • Initializes a new instance of the ConfigurationModel class.

    Parameters

    • app: Application

      The {@link geocortex.framework.application.Application} that this configuration model belongs to.

    Returns ConfigurationModel

Properties

app

The {@link geocortex.framework.application.Application} that this configuration model belongs to.

application

application: ApplicationJson

Global application configuration values from the "application" section.

defaultLibraryId

defaultLibraryId: string

The configured ID of the default library. Modules with no explicit libraryId reference will be considered as belonging to the default library.

externalLocaleReferences

externalLocaleReferences: LibraryConfigLocale[]

An array of references to external locale resources.

globals

globals: any

"Global" configuration values that can be referenced elsewhere in configuration.

libraryConfigs

libraryConfigs: LibraryConfig[]

An array of {@link geocortex.framework.config.LibraryConfig} objects representing external library dependencies.

libraryModules

libraryModules: object

An object map that maps a library ID to a collection of {@link geocortex.framework.config.ModuleConfig} objects belonging to that library.

Type declaration

moduleConfigs

moduleConfigs: ModuleConfig[]

An array of {@link geocortex.framework.config.ModuleConfig} objects representing all of the configured modules in this configuration model.

version

version: string

The configuration version of the model.

viewerId

viewerId: string

The configured ID of this viewer.

widgetConfigs

widgetConfigs: WidgetConfig[]

An array of {@link geocortex.framework.config.WidgetConfig} objects representing all of the configured widgets in this configuration model.

Methods

parse

  • parse(configuration: string, callback?: function): void
  • Builds this configuration model from JSON.

    Parameters

    • configuration: string

      The JSON string or object to parse.

    • Optional callback: function

      The callback to fire when configuration loading has completed.

    Returns void