GoodData JS SDK GoodDataJS
gooddata-js v13.5.0

config Class

Defined in: src/config.ts:5
Module: config

Config module holds SDK configuration variables

Currently its only custom domain - which enabled using sdk from different domain (using CORS)

Never set properties directly - always use setter methods

Show:

createModule

(
  • configStorage
)

Defined in src/config.ts:58

Config factory

Parameters

  • configStorage Object | Null

    config object

Returns

SDK config module

getBootstrapData

()

Provided by the report module.

Defined in src/bootstrap.ts:6

Returns information about currently logged in user from bootstrap resource

getCustomDomain

()

Defined in src/config.ts:85

Returns current domain

getJsPackage

() Object private

Defined in src/config.ts:109

Returns JS package and version info

Returns

Object:

with 'name' and 'version' properties

getMapboxToken

(
  • bootstrapData
)

Provided by the report module.

Defined in src/bootstrap.ts:14

Returns the mapboxToken for using GeoPushpinChart

Parameters

  • bootstrapData Any
    • data from bootstrap resource

sanitizeConfig

() Object | Undefined

Defined in src/config.ts:34

Returns sanitized config

Returns

Object | Undefined:

config with sanitized domain

setCustomDomain

(
  • domain
)

Defined in src/config.ts:72

Sets custom domain. Parameter is url which has always to be https:// (if you don't provide it, we will do it for you).

RegExp inspired taken from https://github.com/jarib/google-closure-library/blob/master/closure/goog/string/linkify.js

Parameters

  • domain String | Null

    valid domain starting with https:// or null for removing

setJsPackage

(
  • name
  • version
)
private

Defined in src/config.ts:94

Sets JS package and version info

Parameters

  • name String

    package name

  • version String

    package version (semver)

© GoodData 2019