主要内容

本页采用了机器翻译。点击此处可查看最新英文版本。

mlreportgen.dom.ImageMap 类

命名空间: mlreportgen.dom

图像中超链接区域的地图

描述

图像区域地图,即图像中的区域,您可以点击这些区域在浏览器中打开内容或导航至同一页面中的另一个位置。您可以在具有 PDF 或 HTML 输出的报告中创建图像映射。使用 mlreportgen.dom.ImageArea 定义区域并将其追加到地图。

mlreportgen.dom.ImageMap 类是一个 handle 类。

创建对象

描述

map = ImageMap 创建一个空的图像映射。使用 ImageMap.append 方法将图像区域添加到地图。

示例

属性

全部展开

样式表中定义的样式名称,指定为字符向量或字符串标量。样式名称是此元素所追加到的文档或文档部件的样式表中指定的样式的名称。指定的样式定义了该元素在输出文档中的外观,除非该元素的 Style 属性指定的格式覆盖了该样式。要了解有关使用样式表的更多信息,请参阅 使用样式表样式

注意

Microsoft® Word 报告会忽略文档模板中未定义的样式名称。有关 Microsoft Word 模板的详细信息,请参阅DOM API 报告程序模板

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

此文档元素对象的格式规范,指定为 DOM 格式对象数组。此属性指定的格式将覆盖此元素的 StyleName 属性指定的相应格式。不适用于此文档元素对象的格式将被忽略。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

文档元素的自定义属性,指定为 mlreportgen.dom.CustomAttribute 对象数组。自定义属性必须被此对象所追加到的文档元素的输出格式支持。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

此对象的父对象,指定为文档元素对象。一个文档元素必须只有一个父元素。

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

此对象的子对象,指定为文档元素对象数组。此属性包含使用 append 方法追加的文档元素对象。

属性:

GetAccess
public
SetAccess
private
NonCopyable
true

标记,指定为字符向量或字符串标量。DOM API 在创建此对象的过程中生成一个会话唯一标记。生成的标记形式为 CLASS:ID,其中 CLASS 是对象类,ID 是对象的 Id 属性的值。使用此值来帮助确定在文档生成过程中出现的问题的位置。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

目标标识符,指定为字符向量或字符串标量。DOM API 在创建文档元素对象时会生成一个会话唯一标识符。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

方法

全部展开

示例

全部折叠

定义一个 ImageArea 对象,指定区域的大小和位置以及点击该区域时发生的操作。然后将该区域追加到 ImageMap 对象。

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

版本历史记录

在 R2014b 中推出