mlreportgen.dom.ImageArea Class

Namespace: mlreportgen.dom

Define image area as hyperlink

expand all in page

Description

Use an object of the mlreportgen.dom.ImageArea class to 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.

To see what DOM objects you can append an mlreportgen.dom.ImageArea object to, see Append mlreportgen.dom.ImageArea object to DOM class object.

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.

example

Input Arguments

expand all

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

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

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

Data Types: uint16

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

Data Types: uint16

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

Data Types: uint16

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

Data Types: uint16

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

Data Types: uint16

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

Data Types: uint16

The radius, in pixels.

Data Types: uint16

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

expand all

Image area target, specified as either:

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

  • Name of a link target

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

The window in which the target will be opened, specified as a character vector or string scalar.

Possible values are:

  • "samewindow" - (default) opens a target in the same window

  • "newwindow" - opens a target in a new window

Note

This property applies only to HTML output-type reports.

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

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

Data Types: char | string

(Read-only) Possible values are:

  • "rect" — rectangular image area

  • "circle" — circular image area

  • "poly" — polygonal image area

Data Types: char | string

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.

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

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, see Templates for DOM API Report Programs.

Attributes:

GetAccess
public
SetAccess
public
NonCopyable
true

Data Types: char | string

Format specification for this document element object, specified as a cell 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

Data Types: cell

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 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 of this object, specified as an array of document element objects. This property contains the document element objects appended using the append method.

Attributes:

GetAccess
public
SetAccess
private
NonCopyable
true

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

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

Examples

collapse all

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);

More About

expand all

Version History

Introduced in R2014b

See Also

| |

Topics