Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Internet Explorer alert
This browser is not recommended for use with smartdevicelink.com, and may not function properly. Upgrade to a different browser to guarantee support of all features.
close alert
US
JP
US
JP
To Top Created with Sketch. To Top
To Bottom Created with Sketch. To Bottom
JavaScript Suite Documentation

VrHelpItem Class Reference

Constructors

Instance Methods

Constructors

new VrHelpItem(parameters)

Initializes an instance of VrHelpItem.

Instance Methods

vrHelpItem.getImage() ⇒ Image

Get the Image

Kind: Instance method of VrHelpItem
Returns: Image - the KEY_IMAGE value

vrHelpItem.getPosition() ⇒ Number

Get the Position

Kind: Instance method of VrHelpItem
Returns: Number - the KEY_POSITION value

vrHelpItem.getText() ⇒ String

Get the Text

Kind: Instance method of VrHelpItem
Returns: String - the KEY_TEXT value

vrHelpItem.setImage(image) ⇒ VrHelpItem

Set the Image

Kind: Instance method of VrHelpItem
Returns: VrHelpItem - The class instance for method chaining.

ParamTypeDescription
image Image Image struct for VR Help item - The desired Image.

vrHelpItem.setPosition(position) ⇒ VrHelpItem

Set the Position

Kind: Instance method of VrHelpItem
Returns: VrHelpItem - The class instance for method chaining.

ParamTypeDescription
position Number Position to display item in VR Help list - The desired Position. {'num_min_value': 1, 'num_max_value': 100}

vrHelpItem.setText(text) ⇒ VrHelpItem

Set the Text

Kind: Instance method of VrHelpItem
Returns: VrHelpItem - The class instance for method chaining.

ParamTypeDescription
text String Text to display for VR Help item - The desired Text. {'string_min_length': 1, 'string_max_length': 500}
View on GitHub.com