mlreportgen.dom.Image Class

Namespace: mlreportgen.dom

Image to include in report

Description

Use an object of the mlreportgen.dom.Image class to include an image in a report.

The mlreportgen.dom.Image class is a handle class.

Class Attributes

ConstructOnLoad	true
HandleCompatible	true

For information on class attributes, see Class Attributes.

Creation

Description

imageObj = mlreportgen.dom.Image(imagePath) creates an mlreportgen.dom.Image object with the Path property set to the path of an image.

Note

The contents of the specified image file are copied into the output document when the document is closed. Do not delete or overwrite the image file before closing the document. If you create an image file and the corresponding mlreportgen.dom.Image object in a loop, for each loop iteration, use a unique file name for the image file.

Input Arguments

imagePath — Path of image file

character vector | string scalar

Path of an image file to include in a report, specified as a character vector or string scalar. You can use these image formats.

Import Image Format	Supported in HTML	Supported in Word	Supported in PDF	Supported in PDF/A (since R2025a)
Windows® metafile (.emf)	No	Yes	No	No
Graphics Interchange Format (.gif)	Yes	Yes	Yes	Yes
JPEG image (.jpg)	Yes	Yes	Yes	No
PDF (.pdf)	No	No	Yes	No
PDF/A (.pdf)	No	No	Yes	No
Portable Network Graphics (.png)	Yes	Yes	Yes	Yes
Scalable Vector Graphics (.svg)	Yes	Yes	Yes	Yes
TIFF image (.tif)	No	Yes	Yes	Yes

Note

Unlike the PDF report output format, the PDF/A format does not support including PDF or PDF/A images. Use one of the image formats listed in the table to include an image in a PDF/A report.

Properties

Path — Path of image file

character vector | string scalar

Path of image file, specified as a character vector or string scalar.

Attributes:

GetAccess	public
SetAccess	private
NonCopyable	true
Transient	true

Data Types: char | string

Height — Image height

character vector | string scalar

Image height, specified as a character vector or string scalar that contains a number followed by an abbreviation for a unit of measurement. For example, "2in" specifies two inches. Valid abbreviations are:

• px — Pixels

• cm — Centimeters

• in — Inches

• mm — Millimeters

• pc — Picas

• pt — Points

• % — Percent

When you create the mlreportgen.dom.Image object , this property is initially set to a value based on the image file specified by the Path property.

If you set the Style property of a mlreportgen.dom.Image object, the style height overrides this property value.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Width — Image width

character vector | string scalar

Image width, specified as a character vector or string scalar that contains a number followed by an abbreviation for a unit of measurement. For example, "2in" specifies two inches. Valid abbreviations are:

• px — Pixels

• cm — Centimeters

• in — Inches

• mm — Millimeters

• pc — Picas

• pt — Points

• % — Percent

When you create the mlreportgen.dom.Image object , this property is initially set to a value based on the image file specified by the Path property.

If you set the Style property of a mlreportgen.dom.Image object, the style width overrides this property value.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Map — Map of hyperlink areas in image

[] (default) | mlreportgen.dom.ImageMap object

Map of hyperlink areas in this image, specified as an mlreportgen.dom.ImageMap object. The Map property applies to only HTML and PDF reports.

See Create Image Maps.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

EmbedSVG — Whether to embed an SVG file

false (default) | true

Whether to embed an SVG file, specified as true or false. When this property is false, the report renders SVG images using CSS. When this property is set to false, you cannot search for images. If true, the generated HTML report file includes the generated HTML report file includes a copy of the SVG file. When this property is true, you can search for images, but SVG images that rely on CSS formatting may render incorrectly.

Note

The EmbedSVG property applies only to HTML reports.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

StyleName — Name of stylesheet-defined style

[] (default) | character vector | string scalar

Name of stylesheet-defined style, specified as a character vector or string scalar. The style name is the name of a style specified in the style sheet of the document or document part to which this element is appended. The specified style defines the appearance of this element in the output document unless the formats specified by the Style property of this element override it. To learn more about using style sheets, see Use Style Sheet Styles.

Note

Microsoft^® Word reports ignore style names that are not defined in the document template. For more information on Microsoft Word templates, seeTemplates for DOM API Report Programs.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Style — Format specification

{} (default) | array of DOM format objects

Format specification for this document element object, specified as an array of DOM format objects. The formats specified by this property override corresponding formats specified by the StyleName property of this element. Formats that do not apply to this document element object are ignored.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

CustomAttributes — Custom attributes of document element

[] (default) | array of mlreportgen.dom.CustomAttribute objects

Custom attributes of the document element, specified as an array of mlreportgen.dom.CustomAttribute objects. The custom attributes must be supported by the output format of the document element to which this object is appended.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Parent — Parent of this object

document element object

Parent of this object, specified as a document element object. A document element must have only one parent.

Attributes:

GetAccess	public
SetAccess	private
NonCopyable	true

Children — This property is ignored

not applicable

The class ignores this property.

Attributes:

GetAccess	public
SetAccess	private
NonCopyable	true

Tag — Tag

character vector | string scalar

Tag, specified as a character vector or string scalar. The DOM API generates a session-unique tag as part of the creation of this object. The generated tag has the form CLASS:ID, where CLASS is the object class and ID is the value of the Id property of the object. Use this value to help identify where an issue occurs during document generation.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Id — Object identifier

character vector | string scalar

Object identifier, specified as a character vector or string scalar. The DOM API generates a session-unique identifier when it creates the document element object.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Methods

Public Methods

Method	Purpose
append	Do not use this method. Appending content to an mlreportgen.dom.Image object has no effect in the generated output.
clone	clone = clone(imageObj)creates a copy of the specified mlreportgen.dom.Image object. To append the same image to different parts of a document, use the clone method. Do not add the same mlreportgen.dom.Image object to a document more than one time.

Examples

Include Image in a Report

Use an mlreportgen.dom.Image object to specify an image that you want to include in a report. Include the image in the report by appending the Image object to the report.

Import the DOM namespace so that you do not have to use long, fully qualified class names.

import mlreportgen.dom.*

Create a report and add a title for the image using an mlreportgen.dom.Paragraph object.

d = Document("myImageReport","docx");

p = Paragraph("Plot 1");
p.Bold = true;
append(d,p);

Save a plot as an image file.

x = 0:pi/100:2*pi;
y = sin(x);
plot(x,y);

saveas(gcf,"myPlot_img.png");

Create an mlreportgen.dom.Image object that specifies the path of the image file. Specify that the width and height are 4 inches. Append the Image object to the report.

plot1 = Image("myPlot_img.png");
plot1.Width = "4in";
plot1.Height = "4in";
append(d,plot1);

Close and view the report.

close(d);
rptview(d);

Here is the image in the generated report:

Version History

Introduced in R2014b

R2024b: Removal of BMP for image output

Report Generator no longer supports BMP (bitmap) as an output image format. This affects snapshots, images from files, and watermarks in both the Report Explorer and the Report, DOM, and PPT APIs. See print for more information.

R2019b: SVG image support for Word reports

Starting in R2019b, you can include Scalable Vector Graphics (SVG) images in Word reports. Word reports that contain SVG images require Microsoft Word 2016 or a later version. To generate reports with images that are compatible with earlier versions of Word, create mlreportgen.dom.Image objects from images that have a format other than SVG.