Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ModuleConfig

Represents a configured module, including any configured {@link geocortex.framework.ui.ViewBase} and {@link geocortex.framework.ui.ViewModelBase} objects belonging to the module.<

Hierarchy

  • ModuleConfig

Index

Constructors

Properties

Constructors

constructor

  • new ModuleConfig(moduleName: string, moduleType: string, configuration: any, libraryId: string): ModuleConfig

  • Initializes a new instance of the {@link geocortex.framework.config.ModuleConfig} class

    param:

    moduleName The name of the module this configuration item represents.

    param:

    moduleType The type name of the module this configuration item represents.

    param:

    configuration The configuration object to pass to the module during initialization.

    param:

    libraryId The configured library ID that this module belongs to.

    Parameters

    • moduleName: string
    • moduleType: string
    • configuration: any
    • libraryId: string

    Returns ModuleConfig

Properties

configuration

configuration: any

The configuration material to pass to the module upon initialization.

deferLoading

deferLoading: boolean

Should the loading of this module be deferred until a provided command or view is accessed?

isEnabled

isEnabled: boolean

If this flag is set to false the module will not load under any circumstance. Used to turn things off while preserving config.

libraryId

libraryId: string

The configured ID of the library that this module's implementation can be found in.

moduleDependencies

moduleDependencies: string[]

A list of modules that need to load first, before this module. Models any 'soft dependencies' between modules

moduleName

moduleName: string

The configured name of the module.

moduleType

moduleType: string

The configured type name of the module instance.

overrideLoadBundle

overrideLoadBundle: boolean

Indicate that a modules cache bundle should be loaded, independently of the library "loadModulesBundle" setting. Applies only to libraries in async mode.

require

require: string

Require path to the module class.

viewConfigs

viewConfigs: ViewConfig[]

An array of {@link geocortex.framework.config.ViewConfig} objects configured for this module.

viewModelConfigs

viewModelConfigs: ViewModelConfig[]

An array of {@link geocortex.framework.config.ViewModelConfig} objects configured for this module.