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

mlreportgen.dom.ImageArea 类

命名空间: mlreportgen.dom

将图像区域定义为超链接

全页展开

描述

定义图像中要超链接的区域。当您点击图像区域时，HTML 浏览器会根据您指定的 URL 或链接目标显示目标页面。如果目标位于同一文档中，点击链接即可移动到文档中的该位置。您可以为支持替代文本的屏幕阅读器提供替代文本。使用 PDF 或 HTML 输出在报告中创建图像区域。使用 mlreportgen.dom.ImageMap 创建图像地图并将区域追加到地图。

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

创建对象

描述

imageAreaObj = ImageArea 创建一个空的图像区域。

imageAreaObj = ImageArea(target,altText,x1,y1,x2,y2) 创建一个矩形图像区域。

imageAreaObj = ImageArea(target,altText,x,y,radius) 创建一个圆形图像区域。

imageAreaObj = ImageArea(target,altText,polygonCoordinates) 创建一个多边形图像区域。

示例

输入参量

全部展开

图像区域超链接目标，指定为：

  • 点击此图片区域时要加载的页面的 URL

  • 链接目标的名称

图像不可见时显示的文本，指定为字符向量或字符串标量。

指定相对于图像的左上角。

数据类型: uint16

以像素为单位指定相对于图像左上角的距离。

数据类型: uint16

以像素为单位指定相对于图像左上角的距离。

数据类型: uint16

以像素为单位指定相对于图像左上角的距离。

数据类型: uint16

以像素为单位指定相对于图像左上角的距离。

数据类型: uint16

以像素为单位指定相对于图像左上角的距离。

数据类型: uint16

半径（以像素为单位）。

数据类型: uint16

指定 x 和 y 坐标对的数组，其中包含多边形每个角的坐标，形式为 [x1, y1, x2, y2, ... xN, yN]。按顺序指定反映多边形角的坐标。

指定相对于图像左上角的每个坐标（以像素为单位）。

属性

全部展开

图像区域目标，指定为：

  • 点击此图片区域时要加载的页面的 URL

  • 链接目标的名称

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

将打开目标的窗口，指定为字符向量或字符串标量。

可能的值包括：

  • "samewindow"-（默认）在同一窗口中打开目标

  • "newwindow"-在新窗口中打开目标

注意

此属性仅适用于 HTML 输出类型的报告。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: char | string

图像不可见时显示的文本，指定为字符向量或字符串标量。

数据类型: char | string

（只读）可能的值有：

  • "rect" - 矩形图像区域

  • "circle" - 圆形图像区域

  • "poly" - 多边形图像区域

数据类型: char | string

坐标代表不同类型的点，取决于图像区域的形状。坐标相对于图像的左上角。

  • 对于矩形，坐标代表左上角和右下角。

  • 对于圆来说，该数组表示圆心的坐标和半径。

  • 对于多边形，坐标代表角。

属性：

GetAccess
public
SetAccess
public
NonCopyable
true

数据类型: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64

样式表中定义的样式名称，指定为字符向量或字符串标量。样式名称是此元素所追加到的文档或文档部件的样式表中指定的样式的名称。指定的样式定义了该元素在输出文档中的外观，除非该元素的 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

示例

全部折叠

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 中推出

另请参阅

| |

主题