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
Documentation
Image

Image Class Reference

Constructors

Instance Methods

Constructors

new Image(parameters)

Initalizes an instance of Image.

Instance Methods

image.getImageType() ⇒ ImageType

Get the ImageType

Kind: Instance method of Image
Returns: ImageType - the KEY_IMAGE_TYPE value

image.getIsTemplate() ⇒ Boolean

Get the IsTemplate

Kind: Instance method of Image
Returns: Boolean - the KEY_IS_TEMPLATE value

image.getValueParam() ⇒ String

Get the ValueParam

Kind: Instance method of Image
Returns: String - the KEY_VALUE value

image.setImageType(type) ⇒ Image

Set the ImageType

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

ParamTypeDescription
type ImageType Describes, whether it is a static or dynamic image. - The desired ImageType.

image.setIsTemplate(template) ⇒ Image

Set the IsTemplate

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

ParamTypeDescription
template Boolean If true, the image is a template image and can be recolored by the HMI - The desired IsTemplate.

image.setValueParam(value) ⇒ Image

Set the ValueParam

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

ParamTypeDescription
value String Either the static hex icon value or the binary image file name identifier (sent by PutFile). - The desired ValueParam. {'string_min_length': 0, 'string_max_length': 65535}
View on GitHub.com
Previous Section Next Section