SmartComponents

Module: standardPlayer/ComponentParameters

This object provides access to the SmartComponent parameters.

Methods

<inner> asBool(name) → {boolean}

Gets a parameter converted to bool.

Parameters:
Name Type Description
name string

The name for the parameter.
Returns:

"true" if the parameter value is true, otherwise "false".

Type
boolean

<inner> asCssColor(name, defaultValue) → {string}

Gets a parameter converted to a css color value. The #-prefix will be added automatically if not present.

Parameters:
Name Type Description
name string

The name for the parameter.
defaultValue string

A default value.
Returns:

The parameter value. If the parameter not exists, the default value will be returned.

Type
string

<inner> asHTML(name, defaultValue) → {object}

Gets a parameter as HTML.

Parameters:
Name Type Description
name string

The name for the parameter.
defaultValue string

A default value.
Returns:

The parameter value. If the parameter not exists, the default value will be returned.

Type
object

<inner> asNumber(name, defaultValue) → {object}

Gets a parameter converted to a number.

Parameters:
Name Type Description
name string

The name for the parameter.
defaultValue string

A default value.
Returns:

The parameter value. If the parameter is not a number, the default value will be returned.

Type
object

<inner> get(name, defaultValue) → {string}

Gets a parameter.

Parameters:
Name Type Description
name string

The name for the parameter.
defaultValue string

A default value.
Returns:

The parameter value. If the parameter not exists, the default value will be returned.

Type
string