Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IAppProps

App component properties

export
interface

IAppProps

Hierarchy

  • IAppProps

Index

Properties

Methods

Properties

Optional appSettings

appSettings?: Dictionary<string>
since

0.14.8

Optional externalBaseLayers

externalBaseLayers?: IExternalBaseLayer[]

The list of external base layers

memberof

IAppProps

remarks

This option is for when you are passing in a Web Layout to the viewer, but you still want to provide external base layers. If passing in an Application Definition, this option is redundant as the Application Definition itself can define the set of external base layers

initCommand

initCommand: IViewerInitCommand

The command that will carry out viewer initialization

memberof

IAppProps

since

0.14

layout

layout: string | AdHocLayoutTemplate

The layout to use

since

0.14 type changed to include AdHocLayoutTemplate

Optional locale

locale?: string

The locale to use

Optional mapguide

mapguide?: IMapGuideAppProps

MapGuide-specific options

memberof

IAppProps

since

0.14

resourceId

resourceId: string | (() => Promise<ApplicationDefinition>)

A resource id to a Web Layout or Application Definition or a function that will fetch the required Application Definition.

memberof

IAppProps

Optional urlPropsIgnore

urlPropsIgnore?: string[]

If specified, tells the application to not sync the following URL params to the URL, and to skip reading these params when initializing/refreshing.

memberof

IAppProps

since

0.14

Methods

Optional onInit

  • A callback function that will be called when the viewer has finished initializing

    Parameters

    Returns void

Generated using TypeDoc