Main Content

mlreportgen.dom.Image class

Package: 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

example

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

expand all

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

Image FormatFile ExtensionSupported Document Type
HTMLWordPDF
Windows® bitmap.bmp
Windows metafile.emf  
Graphics Interchange Format .gif
JPEG image.jpg
PDF.pdf  
Portable Network Graphics .png
Scalable Vector Graphics.svg
TIFF image.tif 

Properties

expand all

Path of the image file, specified as a character vector. This property is read-only.

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

  • px — pixels (default)

  • cm — centimeters

  • in — inches

  • mm — millimeters

  • pc — picas

  • pt — points

  • % — percent

When the Image object is created, the Height property is set to a value based on the image file specified by the Path property.

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

  • px — pixels (default)

  • cm — centimeters

  • in — inches

  • mm — millimeters

  • pc — picas

  • pt — points

  • % — percent

When the Image object is created, the Width property is set to a value based on the image file specified by the Path property.

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.

Name of image style, specified as a character vector or string scalar. The StyleName value must be a style in the style sheet of the document or document part to which this image is appended. Format objects in the Style property of this Image object override the style in the style sheet.

Note

The StyleName property is ignored for Word output.

Formats that define the style of this image, specified as a cell array of DOM format objects. The formats override the corresponding formats defined by the style specified by the StyleName property. See Create and Format Images.

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

Parent of this image, specified as a document element object. This property is read-only.

This property is ignored.

Tag for this document element, specified as a character vector or string scalar.

The DOM 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. Specifying your own tag value can help you to identify where an issue occurred during document generation.

ID for this document element, specified as a character vector or string scalar. The DOM generates a session-unique ID when it creates the document element. You can specify your own ID.

Methods

expand all

Examples

collapse all

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 package 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:

Compatibility Considerations

expand all

Behavior changed in R2019b

Introduced in R2013b