Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ModuleManager

A module manager is responsible for managing a series of modules associated with an application.

Hierarchy

Index

Constructors

constructor

  • Initializes a module manager with the specified application.

    memberof

    ModuleManager

    Parameters

    Returns ModuleManager

Accessors

sourceIds

  • get sourceIds(): string[]
  • Returns string[]

Methods

add

  • Adds a module to the application.

    The specified module must either be an instance of a class that implements the IMapSourceModule interface or a loader function that loads and initializes the module on-demand.

    memberof

    ModuleManager

    Parameters

    • module: IMapSourceModule
    • Default value overrides: any = null
    • Default value constructorOpts: any = null

    Returns void

addGroup

  • Adds a module group to the application.

    memberof

    ModuleManager

    Parameters

    Returns void

has

  • has(type: string): boolean
  • Returns whether the listeners are registered for the specified event name.

    memberof

    EventDispatcher

    Parameters

    • type: string

    Returns boolean

insertAt

  • insertAt(index: number, module: IMapSourceModule, overrides?: any, constructorOpts?: any): void
  • Adds a module to the application and inserts its control at the specified index.

    The specified module must either be an instance of a class that implements the IMapSourceModule interface or a loader function that loads and initializes the module on-demand.

    Parameters

    • index: number
    • module: IMapSourceModule
    • Default value overrides: any = null
    • Default value constructorOpts: any = null

    Returns void

off

  • Removes a registered listener function for the specified event.

    memberof

    EventDispatcher

    Parameters

    • type: string

      Name of the event to remove the listener for.

    • callback: Function

      Handler function to remove so it won't be executed next time the event is triggered.

    • Default value scope: any = null

    Returns EventDispatcher

offAll

on

  • on(type: string, callback: Function, scope?: any, priority?: number): EventDispatcher
  • Registers a listener function to be executed each time an event occurs

    memberof

    EventDispatcher

    Parameters

    • type: string

      Name of the event to listen for. Value can contain multiple event names separated by spaces to trigger the same handler function for each event name.

    • callback: Function

      Handler function to be called when the event occurs

    • Default value scope: any = null
    • Default value priority: number = 0

    Returns EventDispatcher

once

  • once(type: string, callback: Function, scope?: any, priority?: number): EventDispatcher
  • Registers a listener function to be executed the first time an event occurs.

    memberof

    EventDispatcher

    Parameters

    • type: string

      Name of the event to listen for. Value can contain multiple event names separated by spaces to trigger the same handler function for each event name.

    • callback: Function

      Handler function to be called when the event occurs

    • Default value scope: any = null
    • Default value priority: number = 0

    Returns EventDispatcher

remove

  • Removes a module from the application.

    memberof

    ModuleManager

    Parameters

    Returns void

removeById

  • removeById(identifier: string): void
  • Parameters

    • identifier: string

    Returns void

trigger

  • Triggers the specified event so that all registered listeners will be executed with the specified parameters.

    memberof

    EventDispatcher

    Parameters

    • type: any

      Event name to trigger

    • Default value data: any = null

    Returns EventDispatcher

Generated using TypeDoc