Namespace: APPLICATION_CONTEXT

APPLICATION_CONTEXT

Namespaces Members Methods
Source:

Namespaces

config

Members

(static) AppCache :XOpatStorage.Cache

Global Application Cache. Should not be used directly: cache is avaialble within plugins as this.cache object.
Type:
XOpatStorage.Cache
Source:

(static) AppCookies :XOpatStorage.Cookies

Global Application Cookies.
Type:
XOpatStorage.Cookies
Source:

(static) env :xoEnv

Get the ENV configuration used to run the viewer.
Type:
xoEnv
Source:

(static) secure :boolean

Check if viewer requires secure mode execution.
Type:
boolean
Source:

(static) sessionName

Get sessionName value (fallback refereceId) from the configuration.
Source:

(static) url :string

Get the current URL (without data, just the index entry point).
Type:
string
Source:

Methods

(static) activePluginIds() → {Array.<string>}

Get the list of active plugin IDs.
Source:
Returns:
Type
Array.<string>

(static) beginApplicationLifecycle(data, background, visualizations) → {Promise.<void>}

Run the first viewer configuration. This method should be called once at the beginning of the app lifecycle.
Parameters:
Name Type Description
data
background
visualizations
Source:
Returns:
Type
Promise.<void>

(static) getOption(name, defaultValue, cache) → {string|*}

Get option, preferred way of accessing the viewer config values.
Parameters:
Name Type Description
name
defaultValue
cache
Source:
Returns:
Type
string | *

(static) openViewerWith(data, background, visualizations)

Open desired configuration on the current viewer
Parameters:
Name Type Description
data
background
visualizations
Source:

(static) pluginIds() → {Array.<string>}

Get the list of all plugin IDs.
Source:
Returns:
Type
Array.<string>

(static) referencedId() → {string}

Get the current FILE ID viewed (zero-index item in stacked mode).
Source:
Returns:
Type
string

(static) referencedName(stripSuffix) → {string}

Get the current FILE name viewed (zero-index item in stacked mode).
Parameters:
Name Type Description
stripSuffix boolean if true and the returned data is read from config.data field, an attempt to return only filename from the file ID.
Source:
Returns:
Type
string

(static) setOption(name;, value, cache)

Set option, preferred way of accessing the viewer config values.
Parameters:
Name Type Description
name;
value
cache
Source: