mlreportgen.dom.ImageMap class

Package: mlreportgen.dom

Map of hyperlink areas in image


Map of image areas, which are areas in an image that you can click to open content in a browser or to navigate to another location in the same page. You can create image maps in reports with PDF or HTML output. Define areas using mlreportgen.dom.ImageArea and append them to the map.


map = ImageMap() creates an empty image map. Use the ImageMap.append method to add image areas to the map.

Output Arguments

expand all

Map of hyperlink areas in image, returned as an mlreportgen.dom.ImageMap object.


expand all

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

Tag for document element, specified as a character vector.

A session-unique ID is generated as part of document element creation. The generated tag has the form CLASS:ID, where CLASS is the class of the element and ID is the value of the Id property of the object. You can specify a tag to replace the generated tag.

For example, to make it easier to identify where an issue occurred during document generation, you can specify your own tag value.





Append an image area to this image map.


Use ImageMap.clone in a similar way you how you use Paragraph.clone.

Clone this image map.


collapse all

Define an ImageArea object that specifies the size and location of the area and the action that occurs when you click the area. Then append the area to an ImageMap object.

import mlreportgen.dom.*
d = Document('imageArea','pdf');

% Create a plot and save it as an image file
x = 0:pi/100:2*pi;
y = sin(x);
annotation('textbox', [0.2,0.4,0.1,0.1],...
           'string', 'Help on plot function');

% Create the DOM image object and append it to your document
plot1 = Image('plot_img.png');

% Define the area and link target using ImageArea
target = ['' ...
area1 = ImageArea( target, ...
'plot function help',160,340,383,392);

% Create the image map object and append the area to it
map = ImageMap();
plot1.Map = map;