Show TOC

Function documentationAnimation Renderer Locate this document in the navigation structure

 

This action is used with the Animated Objects function. The image type of the output can be .png, .gif, or .jpeg.

The image can be:

  • Sent as a transaction output

  • Generated as XML output for client-side rendering through an SVG plug-in

  • Saved as a static image with the Image Saver action

Once saved, it can be used as an image in a Web page or report.

Features

The Animation Rendereraction works with predefined animated objects or custom animated objects, which are stored as SVA files. You select an animated object from the list of available objects. The animated object may specify input parameters, such as numbers, colors, and strings. Colors are treated as strings and can be a literal color (red), a hex color (#FF0000), or an RGB color [rgb(255,0,0)]. These input parameters are linked as needed.

This action generates an SVG document with animation applied to the image. By default, the action generates an image in one of the supported formats. You can override the default width and height. SVG images are rendered without losing detail or clarity when expanded or contracted, so they can fit into reports regardless of original size.

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

Property

Data Type

Access

Use

AnimatedObjectName

String

In and out

The animated object that is used to create the image output using server-side rendering or the SVG-type XML output.

ImageFormat

String

In and out

The image type. The options are image/png, image/gif, image/jpeg.

ScaledHeight

Integer

In and out

The desired image height.

ScaledWidth

Integer

In and out

The desired image width.

RenderImage

Boolean

In and out

Indicates if the image should be displayed.

Output

XML

Out

The SVG-type XML document that represents the final image including any data mapping or manipulation.

EncodedImage

String

Out

The string version of the image.

Height

Integer

Out

The original image height.

Width

Integer

Out

The original image width.

Success

Boolean

Out

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