Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LibraryConfig

Represents a reference to an application library and related configuration elements.

Hierarchy

  • LibraryConfig

Index

Constructors

Properties

Constructors

constructor

  • new LibraryConfig(idArg: string, uriArg: string): LibraryConfig

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

    Parameters

    • idArg: string

      The ID of the library.

    • uriArg: string

      The URI from which to download the library. Note: Must be relative.

    Returns LibraryConfig

Properties

async

async: boolean

Asynchronous loading mode which leverages the dojo require loader to load all modules in AMD format.

bundleUri

bundleUri: string

Uri to a cache bundle for the library. Applies only to libraries in async mode.

id

id: string

The configured ID of this external code reference

libraryDependencies

libraryDependencies: string[]

List of async library Ids that this async library depends on. There is no circular dependency detection or auto sorting packages, so it is important to define the libraries in the config in the correct order and include all dependencies.

loadModulesBundle

loadModulesBundle: boolean

Indicate if modules cache bundle should be loaded for each module. Applies only to libraries in async mode.

locales

locales: LibraryConfigLocale[]

Array of locale ID/URI elements to fetch for this piece of code.

location

location: string

Path to async library root. Applies only to libraries in async mode.

omitStyles

omitStyles: boolean

Don't inject any styles from this library.

packageName

packageName: string

Sets up a dojo Path for the specified package. It works in conjunction with location. Applies only to libraries in async mode.

position

position: number

The position in configuration that this library was declared at.

prefix

prefix: string

The prefix to use when requiring a module for a library in async mode, eg: 'Mapping/modules'

uri

uri: string

The configured URI of this external code reference.