Global

Members

(constant) ExhibitionEventType :string

Source:
Properties:
Name Type Description
UPDATE_VISITOR_PREFERENCE string

update-visitor-preference
Type:
  • string

(constant) HintBoxContentType :string

Source:
Properties:
Name Type Description
NAVIGATION_MOVEMENT string

navigation-movement
NAVIGATION_PERSPECTIVE string

navigation-perspective
NAVIGATION_TOPVIEW string

navigation-topview
ARTWORK_INFO string

artwork-info
ARTWORK_SINGLE_VIEW string

artwork-single-view
ARTWORK_LOADING_HIGHRES string

artwork-loading-highres
ACTIVATE_AUDIO string

activate-audio
ACTIVATE_RESHUFFLING string

activate-reshuffling
Type:
  • string

(constant) HowlerSoundEventType :string

Source:
Properties:
Name Type Description
MUTE string

mute
UNMUTE string

unmute
Type:
  • string

(constant) HttpRequestErrorType :string

Source:
Properties:
Name Type Description
TIMEOUT string
ABORT string
Type:
  • string

(constant) HttpRequestEventType :string

Source:
Properties:
Name Type Description
DOWNLOAD_PROGRESS string
UPLOAD_PROGRESS string
Type:
  • string

(constant) HttpRequestResponseType :string

Source:
Properties:
Name Type Description
DEFAULT string
ARRAY_BUFFER string
BLOB string
DOCUMENT string
TEXT string
Type:
  • string

(constant) LayerEventType :string

Source:
Properties:
Name Type Description
SHOW_LAYER string

show-layer
HIDE_LAYER string

hide-layer
UPDATE_LAYER string

update-layer
Type:
  • string

(constant) LayerType :string

Source:
Properties:
Name Type Description
EXHIBIT string

exhibit-layer
GUIDING string

guiding-layer
INSTALLATION string

installation-frame
MEDIA string

media-layer
VISITOR string

visitor-layer
BLOCKING string

blocking-layer
Type:
  • string

(constant) MoveType :string

Source:
Properties:
Name Type Description
LEFT string

left
RIGHT string

right
UP string

up
DOWN string

down
MOUSE_LEFT string

mouse-left
MOUSE_RIGHT string

mouse-right
MOUSE_UP string

mouse-up
MOUSE_DOWN string

mouse-down
TOUCH_LEFT string

touch-left
TOUCH_RIGHT string

touch-right
TOUCH_UP string

touch-up
TOUCH_DOWN string

touch-down
ZOOM_IN string

zoom-in
ZOOM_OUT string

zoom-out
TOUCH_ZOOM_IN string

touch-zoom-in
TOUCH_ZOOM_OUT string

touch-zoom-out
PAD_LEFT string

pad-left
PAD_RIGHT string

pad-right
PAD_UP string

pad-up
PAD_DOWN string

pad-down
PAD_LEFT_HORIZONTAL string

padLeftHorizontal
PAD_LEFT_VERTICAL string

padLeftVertical
PAD_RIGHT_HORIZONTAL string

padRightHorizontal
PAD_RIGHT_VERTICAL string

padRightVertical
Type:
  • string

(constant) WorldEventType :string

Source:
Properties:
Name Type Description
ERROR string

error-world
START_BUILDING string

start-building-world
LOADED string

loaded-world
LOAD_PROGRESS string

loading-world-progress
ACTIVATE string

activate-world
SHOW_GUIDING string

show-world-guiding
HIDE_GUIDING string

hide-world-guiding
COMPLETE_GUIDING string

complete-world-guiding
PAUSE_RENDERING string

pause-rendering
START_RENDERING string

start-rendering
CHANGE_MUTING string

change-muting
SWITCH_WORLD_VIEW string

switch-world-view
SWITCH_EXHIBIT_VIEW string

switch-exhibit-view
ACTIVATE_EXHIBIT string

activate-view
DEACTIVATE_EXHIBIT string

deactivate-view
UPDATE_CONTROLLING string

update-controlling
Type:
  • string

(constant) WorldState :string

Source:
Properties:
Name Type Description
READY string

ready
ACTIVE string

active
ERROR string

error
Type:
  • string

(constant) useRetinaImages :boolean

Description:

  • When the window.devicePixelRatio is greater than 1 use retina images.

Source:

When the window.devicePixelRatio is greater than 1 use retina images.

Type:
  • boolean

Methods

createRetinaFilePath(path) → {string}

Description:

  • Change the pathname so that @2x is added before the file extension.

Source:
Parameters:
Name Type Description
path string
Returns:
Type
string

createShortText(text, maxCharacters, preventWordCutopt) → {string}

Description:

  • Shorten the text up to a maximum number of characters. At the end of the new shorter text ... added.

Source:
Parameters:
Name Type Attributes Default Description
text string
maxCharacters number
preventWordCut boolean <optional>
 false
Returns:
Type
string

getBrowserPoints(event, scaleopt) → {Array.<Coordinate>}

Description:

  • Gibt eine Liste der Interaktionspunkte eines Ereignisses zurück. Diese Methode berücksichtigt die Unterschiede zwischen den Geräten.

Source:
Parameters:
Name Type Attributes Default Description
event Event
scale number <optional>
 1
Returns:
Type
Array.<Coordinate>

getFileName(path) → {string}

Description:

  • Returns from a pafd only the filename without its extension.

Source:
Parameters:
Name Type Description
path string
Returns:
Type
string

getGermanMonthName(month) → {string}

Description:

  • Gets german moth name aut of a list [0-11]

Source:
Parameters:
Name Type Description
month number

Desired month 0-11
Returns:
Type
string

getJson(url, opt_requestHeadersopt) → {Promise}

Description:

  • Creates a GET request for the specified [url].

    Returns a parsed json object as promise result.

Source:
Parameters:
Name Type Attributes Default Description
url string
opt_requestHeaders Map <optional>
 null
Returns:
Type
Promise

getQueryParams(urlSearch) → {Object}

Description:

  • Gets the query parameters of window.location.search as an object for better handling.

Source:
Parameters:
Name Type Description
urlSearch string

Is equal to window.location.search
Returns:
Type
Object

getString(url, opt_requestHeadersopt) → {Promise}

Description:

  • Creates a GET request for the specified [url].

Source:
Parameters:
Name Type Attributes Default Description
url string
opt_requestHeaders Map <optional>
 null
Returns:
Type
Promise

msToTime(time, hideZeroHoursopt, showMillisecondsopt) → {string}

Description:

  • Generate a timestring with optionla include of milliseconds

Source:
Parameters:
Name Type Attributes Default Description
time number

in milliseconds
hideZeroHours boolean <optional>
 false

Don't show zero hours if the time is lass than on hour
showMilliseconds boolean <optional>
 false
Returns:
Type
string

postFormData(url, data, opt_responseTypeopt, opt_requestHeadersopt) → {Promise}

Description:

  • Makes a server POST request with the specified data encoded as form data.

    This is roughly the POST equivalent of getString. This method is similar to sending a FormData object with broader browser support but limited to String values.

Source:
Parameters:
Name Type Attributes Description
url string
data ArrayBuffer | ArrayBufferView | Blob | Document | FormData | string | Map
opt_responseType string <optional>
opt_requestHeaders Map <optional>
Returns:
Type
Promise

request(url, opt_methodopt, opt_responseTypeopt, opt_data, opt_requestHeadersopt) → {Promise}

Description:

  • Creates and sends a URL request for the specified [url].

    By default request will perform an HTTP GET request, but a different method (POST, PUT, DELETE, etc) can be used by specifying the [method] parameter. (See also [HttpRequest2.postFormData] for POST requests only.

    The Promise is completed when the response is available.

Source:
Parameters:
Name Type Attributes Default Description
url string
opt_method string <optional>
 GET
opt_responseType string <optional>
opt_data ArrayBuffer | ArrayBufferView | Blob | Document | FormData | string | Map null
opt_requestHeaders Map <optional>
 null
Returns:
Type
Promise