Eclipse BIRT Report Object Model (ROM)

EmbeddedImage Structure

# Structure Overview

Holds an reusable image embedded within the design file.

### Details

Display Name: | Embedded Image
Since: | 1.0

### Property Summary

data
  The binary data for the image.
libReference
  Property that holds a reference to an embbeded image in a target library.
name
  Name of the embbed image.
type
  Format type of the image.

### Description

BIRT allows images to be embedded within the design file. This is most useful for reports created in an external application and submitted to a server for immediate, one-time execution. If report designs are created with the BIRT designer, and are saved on disk, the developer will probably find it easier to use external images referenced with a file name or URL.

# Property Detail

## data Property

The binary data for the image.

### Details

Type: | literalString
Since: | 1.0
Required: | No
Display Name: | Data
JavaScript Type: |
Default Value: | None
Runtime Settable: | No

### Description

This property contains the image itself as an array of bytes. Data is store in the XML design file using base-64 encoding.

## libReference Property

Property that holds a reference to an embbeded image in a target library.

### Details

Type: | structRef
Since: | 2.0
Required: | No
Display Name: | Library Reference
JavaScript Type: |
Default Value: | None
Runtime Settable: | No

### Description

When reuse an embedded image from a library, a local embbeded image is created which has a reference to the base image in the target library. That's very similar to element extends, which has a child-parent relationship

## name Property

Name of the embbed image.

### Details

Type: | memberKey
Since: | 1.0
Required: | Yes
Display Name: | Name
JavaScript Type: |
Default Value: | None
Runtime Settable: | No

### Description

Name is required for an embedded image, and it should be unique within all the embedded images.

## type Property

Format type of the image.

### Details

Type: | choice (imageType)
Since: | 1.0
Required: | No
Display Name: | Type
JavaScript Type: |
Default Value: | None
Runtime Settable: | No

### Choices

Name | Display Name | Value | Description
image/bmp | image/bmp | image/bmp |
image/gif | image/gif | image/gif |
image/png | image/png | image/png |
image/x-png | image/x-png | image/x-png |
image/jpeg | image/jpeg | image/jpeg |
image/ico | image/ico | image/ico |
image/tiff | image/tiff | image/tiff |
image/svg+xml | image/svg+xml | image/svg+xml |

### Description

Defines the type of the image using MIME types. Many image formats provides a unique "Magic Number" at the first few bytes of the image raw data. However, this solution is not guaranteed to work for all images and all image formats. To avoid problems, the application should specify the image type whenever possible.