mlreportgen.dom.ImageArea Class
Namespace: 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
creates an
empty image area.imageAreaObj
= ImageArea
creates a polygonal image area.imageAreaObj
= ImageArea(target
,altText
,polygonCoordinates
)
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 or string scalar.
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
''
(default) | character vector | string scalar
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:
NonCopyable | true |
Data Types: char
| string
TargetSite
— Specifies the window in which the target will be opened
"samewindow"
(default) | "newwindow"
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:
NonCopyable | true |
Data Types: char
| string
AlternateText
— Text to display if image is not visible
''
(default) | character vector | string scalar
Text to display if the image is not visible, specified as a character vector or string scalar.
Data Types: char
| string
Shape
— Shape of image area
''
(default) | 'rect'
| 'circle'
| 'poly'
(Read-only) Possible values are:
'rect'
— rectangular image area'circle'
— circular image area'poly'
— polygonal image area
Data Types: char
| string
Coords
— Coordinates for image area
[]
(default) | array
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:
NonCopyable | true |
Data Types: single
| double
| int8
| int16
| int32
| int64
| uint8
| uint16
| uint32
| uint64
StyleName
— Name of stylesheet-defined style
[]
(default) | character vector | string scalar
Style name, 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 overridden by the formats specified by the
Style
property of this element. To learn more about using style
sheets, see Use Style Sheet Styles.
Note
Microsoft® Word output ignores the style name.
Attributes:
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:
NonCopyable | true |
CustomAttributes
— Custom attributes of document element
[]
(default) | array of mlreportgen.dom.CustomAttribute
objects
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 of the document element to which this object is
appended.
Attributes:
NonCopyable | true |
Parent
— Parent of mlreportgen.dom.ImageArea
object
document element object
Parent of mlreportgen.dom.ImageArea
object, specified as a document element
object. A document element must have only one parent.
Attributes:
SetAccess | private |
NonCopyable | true |
Children
— Children of mlreportgen.dom.ImageArea
object
array of document element objects
Children of mlreportgen.dom.ImageArea
object, specified as an array of document
element objects. This property contains the document element objects appended using the
append
method.
Attributes:
SetAccess | private |
NonCopyable | true |
Tag
— Tag for mlreportgen.dom.ImageArea
object
character vector | string scalar
Tag for the mlreportgen.dom.ImageArea
object, 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. Specify your own tag value to help
you identify where to look when an issue occurs during document generation.
Attributes:
NonCopyable | true |
Data Types: char
| string
Id
— Object identifier for mlreportgen.dom.ImageArea
object
character vector | string scalar
Object identifier for the mlreportgen.dom.ImageArea
object, specified as a
character vector or string scalar. The DOM API generates a session-unique identifier
when it creates the document element object. You can specify your own value for
Id
.
Attributes:
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
MATLAB コマンド
次の MATLAB コマンドに対応するリンクがクリックされました。
コマンドを MATLAB コマンド ウィンドウに入力して実行してください。Web ブラウザーは MATLAB コマンドをサポートしていません。
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)