mlreportgen.dom.ImageArea class

Package: mlreportgen.dom

Define image area as hyperlink

Description

Define an area in an image to hyperlink to. When you click an image area, an HTML browser displays the target page, based on the URL or link target you specify. If the target is in the same document, clicking the link moves you to that location in the document. You can provide alternative text for screen readers that support alternative text. Create image areas in reports with PDF or HTML output. Create the image map using mlreportgen.dom.ImageMap and append areas to the map.

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

Creation

Description

imageAreaObj = ImageArea() creates an empty image area.

imageAreaObj = ImageArea(target,altText,x1,y1,x2,y2) creates a rectangular image area.

imageAreaObj = ImageArea(target,altText,x,y,radius) creates a circular image area.

imageAreaObj = ImageArea(target,altText,polygonCoordinates) creates a polygonal image area.

Input Arguments

target — Image area hyperlink target

character vector

Image area hyperlink target, specified as either:

• URL of the page to be loaded when this image area is clicked

• Name of a link target

altText — Text to display if image is not visible

character vector

Text to display if the image is not visible, specified as a character vector.

x1 — x coordinate of top-left corner of rectangular image area, in pixels

unsigned integer

Specify relative to the top-left corner of the image.

Data Types: uint16

y1 — y coordinate of top-left corner of rectangular image area

unsigned integer

Specify relative to the top-left corner of the image, in pixels.

Data Types: uint16

x2 — x coordinate of bottom-right corner of rectangular image area

unsigned integer

Specify relative to the top-left corner of the image, in pixels.

Data Types: uint16

y2 — y coordinate of bottom-right corner of rectangular image area

unsigned integer

Specify relative to the top-left corner of the image, in pixels.

Data Types: uint16

x — x coordinate of center of circular image area

unsigned integer

Specify relative to the top-left corner of the image, in pixels.

Data Types: uint16

y — y coordinate of center of circular image area

unsigned integer

Specify relative to the top-left corner of the image, in pixels.

Data Types: uint16

radius — Radius of circular image area

unsigned integer

The radius, in pixels.

Data Types: uint16

polygonCoordinates — Coordinates of polygonal image area

array

Specify an array of x and y coordinate pairs, with coordinates for each corner of the polygon, in the form [x1, y1, x2, y2, ... xN, yN]. Specify the coordinates to reflect the corners of the polygon, in sequence.

Specify each coordinate relative to the top-left corner of the image, in pixels.

Properties

Target — Image area target

character vector

Image area target, specified as either:

• URL of the page to be loaded when this image area is clicked

• Name of a link target

AlternateText — Text to display if image is not visible

character vector

Text to display if the image is not visible, specified as a character vector.

Shape — Shape of image area

'rect' | 'circle' | 'poly'

(Read-only) Possible values are:

• 'rect' — rectangular image area

• 'circle' — circular image area

• 'poly' — polygonal image area

Coords — Coordinates for image area

array

(Read-only) The coordinates represent different kinds of points, depending on the shape of the image area. Coordinates are relative to the top-left corner of the image.

• For a rectangle, the coordinates represent the top-left corner and the bottom-right corner.

• For a circle, the array represents the coordinates at the center of the circle and the radius.

• For a polygon, the coordinates represent the corners.

Id — ID for this document element

character vector | string scalar

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.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Tag — Tag for this document element

character vector | string scalar

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.

Attributes:

GetAccess	public
SetAccess	public
NonCopyable	true

Data Types: char | string

Examples

Add Image Area to Image of a MATLAB Plot

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);
plot(x,y);
annotation('textbox', [0.2,0.4,0.1,0.1],...
           'string', 'Help on plot function');
saveas(gcf,'plot_img.png');

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

% Define the area and link target using ImageArea
target = ['https://www.mathworks.com/help/matlab/ref/' ...
'plot.html?searchHighlight=plot'];
area1 = ImageArea( target, ...
'plot function help',160,340,383,392);

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

close(d);
rptview(d.OutputPath);

Version History

Introduced in R2014b