Displays an image within the report.
Reports often display images in various formats: corporate logos, product images, icons, and so on. Popular image formats are JPEG for photographs, and GIF, PNG and SVG for computer-generated graphics such as logos.
The image item provides an image in one of a number of formats. The image can come from a number of sources. The image item can be sized to the image (in which case the height and width attributes are ignored), or the image can be sized or clipped to fit the item. Images are always scaled proportionately.
The image item is similar to the Image report element in RDL, the image control in AFC and the picture item in Crystal. Key features include:
The image element should provide a number of options for handling images that are larger or smaller than the size of the element itself:
The following table shows which properties are used for each image source type.
Property | Embedded | File | URL | Computed |
Image Name | X | |||
URI | X | X | ||
Value Expression | X | |||
Type Expression | X | |||
Size | X | X | X | X |
An optional hyperlink for this image.
Provides a hyperlink from this image.
An optional help text for the image.
An optional help text for the image. The help text can contain HTML formatting and can be externalized. The web viewer shows this as "balloon help."
helpTextID property
An optional text message to display in place of the image in a web browser.
An optional text message to display in place of the image in a web browser.
altTextID property
Resource key for the altText property.
Resource key that allows externalizing and localizing the value of the altText property.
altText property
The kind of image reference.
The image can be provided in a number of formats. The choice here determines which of the other properties that BIRT will consider when obtaining the image value.
The expr option is not available in Release 1.0. That is, the image cannot be retrieved from a database in Release 1.0.
The identifier for the image if the type is File or URL.
The identifier for the image if the type is File or URL. The type of image is inferred from the image file content or HTTP response.
The name of an embedded image if the Source type is Embedded.
The name of an embedded image if the Source type is Embedded.
An expression which returns the image contents.
An expression which returns the image contents.
An expression that returns the type of the image expressed as a MIME type.
An expression that returns the type of the image expressed as a MIME type: image/jpeg, image/png, image/gif, etc. If omitted, BIRT will attempt to infer the image type from the data in the image itself.
How to manage the relationship between image and item size.
Script executed when the element is created in the Factory.
Executed when the element is created in the Factory. Called after the item is created, but before the item is saved to the report document file. See the scripting spec for additional information about this script. Applications should perform visual customization in the on-render script instead.
It is for a script startup phase. No data binding yet. The design of an element can be changed here.
It is for a script startup phase. No data binding yet. The design of an element can be changed here.
Script executed when the element is prepared for rendering in the Presentation engine.
Executed when the element is prepared for rendering in the Presentation engine. Changes made to the element are written to the target output format, but not saved to the report document file. This is the preferred place for visual customizations.