Image Class Reference
Constructors
Instance Methods
- getImageType() ⇒
ImageType - getIsTemplate() ⇒
Boolean - getValueParam() ⇒
String - setImageType(type) ⇒
Image - setIsTemplate(template) ⇒
Image - setValueParam(value) ⇒
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.
| Param | Type | Description |
|---|---|---|
| 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.
| Param | Type | Description |
|---|---|---|
| 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.
| Param | Type | Description |
|---|---|---|
| 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} |