Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ModuleGroup

A module group is a container module for one or more child modules.

Hierarchy

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

  • Creates and initializes a module group instance with the optional array of child modules if provided. Alternatively, child modules can be loaded on-demand using the group's load() method.

    memberof

    ModuleGroup

    Parameters

    Returns ModuleGroup

Accessors

account

  • Aeris account associated with the module group.

    readonly
    memberof

    MapSourceModule

    Returns Account

app

  • Application the module group was initialized with.

    readonly
    memberof

    MapSourceModule

    Returns InteractiveMapApp

id

  • get id(): string
  • Module identifier

    readonly
    memberof

    ModuleGroup

    Returns string

map

  • Application map instance.

    readonly
    memberof

    MapSourceModule

    Returns InteractiveMap

modules

  • Array of child modules associated with the group.

    For groups that load on-demand modules, this value will be null until the modules have been loaded via the group's load() method.

    readonly
    memberof

    ModuleGroup

    Returns IMapSourceModule[]

Methods

controls

  • controls(): any
  • Returns the app controls configuration for the module.

    memberof

    ModuleGroup

    Returns any

initialize

  • Initializes the module group with the specified AerisWeather account and application.

    memberof

    MapSourceModule

    Parameters

    Returns void

load

  • Loads the child modules associated with the module group. This is an asynchronous method that returns a Promise that provides the array of modules for the group once they've been loaded.

    memberof

    ModuleGroup

    Returns Promise<IMapSourceModule[]>

Generated using TypeDoc