Show TOC

Function documentationImage Creator Locate this document in the navigation structure

 

This action is used to create an image of a specified size and background color. The image is then used as a palette onto which other images can be added to create a compound graphics object such as those in digital dashboard or cockpit applications. The image type can be .png, .gif, or .jpeg. To save the image, use the Image Saver action.

Features

The properties for this action are listed in the following table:

Property

Data Type

Access

Use

ImageFormat

String

In and out

The image can be saved as image/png, image/gif, or image/jpeg.

Height

Integer

In and out

The desired image height.

Width

Integer

In and out

The desired image width.

BackgroundColor

String

In and out

The background color of the image. The value can be a literal color (red), hex color (#FF0000), or RGB color [rgb(255,0,0)]. You can also select a value from a color palette.

EncodedImage

String

Out

The image encoded as a string.

Success

Boolean

Out

Indicates whether the action succeeded or failed. If it failed, errors are displayed in the server trace log.