| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 transitional//EN"> |
| <html> |
| <head> |
| <title>Embedded Image Element (Eclipse BIRT ROM Documentation)</title> |
| <link rel="stylesheet" href="../style/style.css" type="text/css"/> |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| </head> |
| <body> |
| <p class="title">Eclipse BIRT Report Object Model (ROM)</p> |
| <p class="subtitle">EmbeddedImage Structure</p> |
| <h1>Structure Overview</h1> |
| <div class="section-text"> |
| Holds an reusable image embedded within the design file.</div> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Display Name:</td> |
| <td>Embedded Image</td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| </table> |
| |
| <h3>Property Summary</h3> |
| |
| <dl class="section-text"> |
| <dt><a href="#Property-data">data</a></dt> |
| <dd>The binary data for the image.</dd> |
| <dt><a href="#Property-libReference">libReference</a></dt> |
| <dd>Property that holds a reference to an embbeded image in a target library.</dd> |
| <dt><a href="#Property-name">name</a></dt> |
| <dd>Name of the embbed image.</dd> |
| <dt><a href="#Property-type">type</a></dt> |
| <dd>Format type of the image.</dd> |
| </dl> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>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.</p></div> |
| <h1>Property Detail</h1> |
| |
| <h2><a name="Property-data">data Property</a></h2> |
| |
| <p class="section-text">The binary data for the image.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#literalString">literalString</a></td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Data</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>No</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>This property contains the image itself as an array of bytes. Data is store in the XML design file using |
| base-64 encoding.</p></div> |
| |
| <hr> |
| <h2><a name="Property-libReference">libReference Property</a></h2> |
| |
| <p class="section-text">Property that holds a reference to an embbeded image in a target library.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#structRef">structRef</a></td></tr> |
| <tr><td>Since:</td> |
| <td>2.0</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Library Reference</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>No</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>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</p></div> |
| |
| <hr> |
| <h2><a name="Property-name">name Property</a></h2> |
| |
| <p class="section-text">Name of the embbed image.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#memberKey">memberKey</a></td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>Required:</td> |
| <td>Yes</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Name</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>No</td></tr> |
| </table> |
| |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>Name is required for an embedded image, and it should be unique within all the embedded images.</p></div> |
| |
| <hr> |
| <h2><a name="Property-type">type Property</a></h2> |
| |
| <p class="section-text">Format type of the image.</p> |
| <h3>Details</h3> |
| |
| <table class="detail-table"> |
| <tr><td>Type:</td> |
| <td><a href="../types.html#choice">choice</a> (imageType)</td></tr> |
| <tr><td>Since:</td> |
| <td>1.0</td></tr> |
| <tr><td>Required:</td> |
| <td>No</td></tr> |
| <tr><td>Display Name:</td> |
| <td>Type</td></tr> |
| <tr><td>JavaScript Type:</td> |
| <td></td></tr> |
| <tr><td>Default Value:</td> |
| <td>None</td></tr> |
| <tr><td>Runtime Settable:</td> |
| <td>No</td></tr> |
| </table> |
| |
| <h3>Choices</h3> |
| |
| <table class="section-table"> |
| <thead><tr><td>Name</td><td>Display Name</td> |
| <td>Value</td><td>Description</td></tr></thead> |
| <tbody> |
| <tr><td>image/bmp</td> |
| <td>image/bmp</td> |
| <td>image/bmp</td> |
| <td></td></tr> |
| <tr><td>image/gif</td> |
| <td>image/gif</td> |
| <td>image/gif</td> |
| <td></td></tr> |
| <tr><td>image/png</td> |
| <td>image/png</td> |
| <td>image/png</td> |
| <td></td></tr> |
| <tr><td>image/x-png</td> |
| <td>image/x-png</td> |
| <td>image/x-png</td> |
| <td></td></tr> |
| <tr><td>image/jpeg</td> |
| <td>image/jpeg</td> |
| <td>image/jpeg</td> |
| <td></td></tr> |
| </tbody></table><br> |
| <h3>Description</h3> |
| |
| <div class="section-text"> |
| <p>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. |
| </p></div> |
| </body> |
| </html> |
