Interface WellknownConfigKeys

Lists well known config property names and their types.

interface WellknownConfigKeys {
    app-base-url: string;
    app-launch-default-app: string;
    app-launch-jsonp-enabled: boolean;
    app-launch-prefetch-enabled: boolean;
    app-launch-prefetch-main: boolean;
    app-launch-prefetch-params-compressed: boolean;
    app-launch-prefetch-with-post-enabled: boolean;
    app-launch-statistics-enabled: boolean;
    apprt-boot-loader-info: any;
    apprt-jsregistry-url: string;
    arcgis-portal-url: string;
    debug: boolean;
    dgrid-touchscroll: boolean;
    esri-conf: {
        [prop: string]: SupportedValueTypes;
    };
    esri-identity-allow-credentials-over-http: boolean;
    esri-identity-app-token-enabled: boolean;
    esri-identity-app-token-url: string;
    esri-identity-state-name: string;
    esri-identity-state-name-prefix: string;
    esri-identity-state-persist: boolean;
    geolocation-update-interval: number;
    locale: string;
    log-deprecations: boolean;
    logging: string;
    mobile-fix-viewport: boolean;
    mobile-fix-viewport-force: boolean;
    oauth-access-token-expiration: number;
    oauth-app-id: string;
    oauth-enabled: boolean;
    oauth-popup-callback-page: string;
    oauth-use-popup: boolean;
    request-max-url-length: number;
    request-proxy-disabled: boolean;
    request-proxy-rules: {
        origin: string;
        proxyUrl?: string;
    }[];
    request-proxy-url: string;
    request-return-dojo-deferred: boolean;
    request-timeout: number;
    request-trusted-servers: string[];
    supported-locales: string[];
    testing-jsregistry-url: string;
    warn-on-slow-graphics-performance: boolean;
}

Properties

app-base-url: string

URL pointing to the current app directory.

app-launch-default-app: string

The name of the default application.

app-launch-jsonp-enabled: boolean

Defines that the app.json and bundles.json requests should use jsonp.

Deprecated

this support will be dropped for security reasons.

app-launch-prefetch-enabled: boolean

Defines that pre-fetching of module.js files via registry/layer.js is enabled.

app-launch-prefetch-main: boolean

Defines that during the pre-fetching main.js files should be included.

Deprecated

the settings is obsolete.

app-launch-prefetch-params-compressed: boolean

Defines that the layer.js request is using gzip encoded parameters to keep the parameter size short.

app-launch-prefetch-with-post-enabled: boolean

Defines that switching to HTTP POST is allowed during layer.js pre-fetching.

app-launch-statistics-enabled: boolean

Enables statistics calculation during app start.

apprt-boot-loader-info: any

Information of apprt-boot for the Launcher.

apprt-jsregistry-url: string

Registry URL used to fetch the apprt system.

arcgis-portal-url: string

A global configured Enterprise-Portal URL.

debug: boolean

Is the debug mode enabled

dgrid-touchscroll: boolean

Is touch scroll enabled for dgrid.

esri-conf: {
    [prop: string]: SupportedValueTypes;
}

Plain esri key, provides a way to configure the properties in esri/config. Used by apprt-esri-init.

Type declaration

esri-identity-allow-credentials-over-http: boolean

Allows the esri/IdentityManager to send credentials via http. Note this is only intended for development purpose and should never be enabled during production.

esri-identity-app-token-enabled: boolean

Enables the use of the /agol/token endpoint.

esri-identity-app-token-url: string

URL to the /agol/token endpoint of map.apps. Which provides an technical user token to e.g. consume a geolocation service as anonymous app user.

esri-identity-state-name: string

The name of the state in the local storage.

esri-identity-state-name-prefix: string

The prefix of the state in the local storage. If this is not configured then the default prefix is the app location. This should prevent interferences between apps.

esri-identity-state-persist: boolean

Enables the persistence of the esri/identity/IdentityManager state in the local storage.

geolocation-update-interval: number

Refresh interval for geo-location updates.

locale: string

The configured locale. Use apprt-core/Locale.getCurrent() to access the value.

log-deprecations: boolean

True if deprecation messages shall be logged.

logging: string

The global logging configuration. A string of the format logger:LEVEL,other:LEVEL. Level = DEBUG, INFO, WARN, ERROR, OFF Is interpreted by apprt-core/Logger

mobile-fix-viewport: boolean

Is an algorithm to re-calculate the viewport size for mobile enabled.

mobile-fix-viewport-force: boolean

Should the use of the fix algorithm be enforced.

oauth-access-token-expiration: number

Which expiration should the requested oauth token have.

oauth-app-id: string

The client-id or app-id to authenticated with.

oauth-enabled: boolean

Enables client side oauth for the application.

oauth-popup-callback-page: string

URL to a callback page which consumes the access token. Only of interest if oauth-use-popup is true.

oauth-use-popup: boolean

Should the login dialog be shown inside a popup.

request-max-url-length: number

Maximal allowed URL length before automatically switching to POST.

request-proxy-disabled: boolean

Disables automatic CORS proxy fallback.

request-proxy-rules: {
    origin: string;
    proxyUrl?: string;
}[]

Proxy use rules.

Type declaration

  • origin: string
  • Optional proxyUrl?: string
request-proxy-url: string

The default proxy URL.

request-return-dojo-deferred: boolean

Flag for apprt-request to return dojo/Deferred instead of Promises.

request-timeout: number

Default request timeout.

request-trusted-servers: string[]

The trusted servers. Required for secure CORS communication.

supported-locales: string[]

The globally supported locales.

testing-jsregistry-url: string

URL to the js-registry providing the test bundles. Only available during test execution.

warn-on-slow-graphics-performance: boolean

May show a warning to the user if the device is unlikely to render a graphical application with acceptable performance. Setting this to false disables the warning for all users.

Generated using TypeDoc