$k. VCMOptions

new VCMOptions()

Used to set VCM runtime options

Methods

css() → {string}

Function to access the css

Only supported in the following application environment(s): View-Configuration-Mapper

Since
  • 5.4.0
Returns:
Type: 
string

language() → {string}

Function to access the language

Only supported in the following application environment(s): View-Configuration-Mapper

Since
  • 5.4.0
Returns:
Type: 
string

languages() → {Array.<string>}

Function to access the accepted languages

Only supported in the following application environment(s): View-Configuration-Mapper

Since
  • 5.6.0
Returns:
Type: 
Array.<string>

setCSS() → {string}

Function to set the css

Only supported in the following application environment(s): View-Configuration-Mapper

Since
  • 5.4.0
Returns:
Type: 
string

setCustomOption(variable, value)

set the value of the given variable

Parameters:
NameTypeDescription
variablestring
value

supported variable types include all javascript base types and arrays of the latter

Since
  • 5.4.0

setLanguage() → {string}

Function to set the language

Only supported in the following application environment(s): View-Configuration-Mapper

Since
  • 5.4.0
Throws:

If an invalid language was specified

Type
$k.exception.InvalidLanguage
Returns:
Type: 
string

setLanguages(languages)

Function to set the preferred languages

Only supported in the following application environment(s): View-Configuration-Mapper

Parameters:
NameTypeDescription
languagesArray.<string>

Languages in order of preference

Since
  • 5.6.0
Throws:

If an invalid language was specified

Type
$k.exception.InvalidLanguage

setTranslations()

Function to set the translations

Only supported in the following application environment(s): View-Configuration-Mapper

Since
  • 5.4.0