Modules

This section describes the modules that ship with the Geocortex Viewer for HTML5. Each module's documentation lists the module, view, and view model properties that are specific to that module. In addition, all modules, views, and view models have the properties listed in Common Settings for Modules, Views, and View Models below.

Common Settings for Modules, Views, and View Models

Each module in the modules section of a configuration file has the following properties:

• moduleName: The name of the module.

• moduleType: The type of module.

• deferLoading: To make the module load only as needed rather than on startup, set to true. By default, this property is false or omitted (also false).

  Do not set this property to true on any module where it is not configured in the default configuration. Doing so is unsupported and may prevent the Viewer from starting. This property only has an effect when the application's deferredModuleLoading property is set to true.

• isEnabled: To ignore the module and prevent it from being loaded, set to false. By default, this property is true or omitted (also true).

• libraryId: (optional) The ID of the library to download. If libraryId is not specified, the module downloads the default library.

• configuration: Module-specific configuration that is passed to the module when it is initialized. If there is no module-specific configuration for a module, its configuration property is empty.

  For information on the configuration for a specific module, see the documentation for that module. To locate the module's documentation, refer to the Modules section in this help system's table of contents—it lists all the modules that ship with the Geocortex Viewer for HTML5.

• views: An array of views of the module. If the module does not have any views, then the array is empty.

  Each view specified in a configuration file has the following properties:

  • id: The view's unique ID. The ID is used to reference the configured view, for example when activating it using a view command such as ActivateView.

  • viewModelId: (optional) The configured view model that the view is to be bound to. Views with a view model ID are attached to the referenced view model as soon as the view model is instantiated and initialized. Configured views without a view model ID have an anonymous (blank) view model attached.

  • visible: (optional) Specifies whether or not the view should be activated when it is first hosted in a region. The default is false.

    A view with the visible flag set to true in configuration is activated by the view manager when it is created. This causes the host region to activate the view. The behavior of view activation depends on the region adapter used, but generally an activated view becomes visible and interactive.

  • markup: The path to use to render the view. The view markup is created when the view is hosted or activated by its host region. This path represents the relative file system path where the HTML resource was found when compiled, based on the compilation root specified when running the resource compiler tool.

  • region: The region that the view is hosted in. If the referenced region does not exist at the time of view creation, the view is considered to be pending—it is added to the region when the region becomes available. See Regions for a list of regions.

  • isManaged: (optional) Specifies whether a view is to be managed or not. The meaning of "managed" is open-ended. A component that displays a list of views or allows a user to activate and deactivate views can choose to observe this setting or not. This allows views to opt out of being displayed in components such as window managers, docks, or toolbars that show active views.

  • configuration: View-specific configuration that is passed to the view when it is initialized. If there is no view-specific configuration for a particular view, its configuration setting is empty.

    For information on the configuration for a specific view, see the documentation for the module the view belongs to. To locate the module's documentation, refer to the Modules section in this help system's table of contents—it lists all the modules that ship with the Geocortex Viewer for HTML5.

• viewModels: An array of view models of the module. If the module does not have any view models, then the array is empty.

  Each view model specified in a configuration file has the following properties:

  • id: The view model's unique ID, used to reference the view model. Configured views have a viewModelId property that references the view model ID.

  • type: The type of view model. This is used by the application to instantiate the view model.

  • configuration: View model-specific configuration that is passed to the view model when it is initialized. If there is no view model-specific configuration for a particular view model, its configuration property is empty.

    For information on the configuration for a specific view model, see the documentation for the module that the view model belongs to. To locate the module's documentation, refer to the Modules section in this help system's table of contents—it lists all the modules that ship with the Geocortex Viewer for HTML5.

See also...

Application-Wide Settings in the Configuration Files