mlreportgen.report.Axes 类

命名空间: mlreportgen.report
超类: mlreportgen.report.Reporter

坐标区报告器

自 R2021b 起

全页展开

描述

使用 mlreportgen.report.Axes 类的对象来报告在 MATLAB^® 图中找到的坐标区。

mlreportgen.report.Axes 类是一个 handle 类。

类属性

HandleCompatible true

有关类属性的信息，请参阅类属性。

创建对象

描述

axes = mlreportgen.report.Axes 创建一个具有默认属性值的 Axes 对象。您必须通过设置 Source 属性来指定要报告的坐标区句柄。使用其他属性来指定报告选项。

注意

在将坐标区报告器添加到报告中之前，包含坐标区的图窗必须保持打开。

axes = mlreportgen.report.Axes(source) 创建一个报告器，添加 source 指定的坐标区，并将 Source 属性设置为 source。

示例

axes = mlreportgen.report.Axes(Name=Value) 使用名称-值参量设置属性。以任意顺序指定多个名称-值参量。

属性

全部展开

`Source` — 坐标区图像来源
坐标区句柄

坐标区图像源，指定为坐标区手柄。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

`Snapshot` — 快照报告器
`mlreportgen.report.FormalImage` 对象

快照报告器，指定为 mlreportgen.report.FormalImage 对象。使用 FormalImage 对象的属性指定快照图像的标题或进一步自定义图像的大小。

注意

报告器初始化 Snapshot 属性。请勿重置此属性。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

`SnapshotFormat` — 快照图像格式
`"svg"` (默认) | `"emf"` | `"gif"` | `"jpg"` | ...

快照图像格式，指定为以下格式之一：

导入图像格式	支持 HTML	支持 Word	支持 PDF	支持 PDF/A 格式 (自 R2025a 起)
Windows^® 元文件 (`.emf`)	否	是	否	否
图形交换格式 (`.gif`)	是	是	是	是
JPEG 图片 (`.jpg`)	是	是	是	否
PDF (`.pdf`)	否	否	是	否
PDF/A (`.pdf`)	否	否	是	否
便携式网络图 (`.png`)	是	是	是	是
可缩放矢量图 (`.svg`)	是	是	是	是
TIFF 图片 (`.tif`)	否	是	是	是

注意

与 PDF 报告输出格式不同，PDF/A 格式不支持包含 PDF 或 PDF/A 图像。使用表中列出的图像格式之一将图像插入 PDF/A 报告。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

数据类型: char | string

`Scaling` — 快照图像的缩放选项
`"auto"` (默认) | `"custom"` | `"none"`

快照图像的缩放选项，指定为 "auto"、"custom" 或 "none"。此属性控制图像文件中快照图像的大小。支持的缩放选项包括：

"auto" - 对于 PDF 或 Word (DOCX) 输出，使用此选项可缩放快照图像以适合当前页面布局，同时保持其纵横比。首先，报告器将快照图像缩放至页面宽度。如果图像高度超出了页面高度，报告器会再次缩小图像。这种额外的缩放可确保图像适合当前页面，并有额外的一英寸间距。缩放不适用于 HTML 输出。
"custom" - 使用此选项根据 Height 和 Width 属性的值缩放快照图像。
"none" - 不执行缩放

注意

"auto" 和 "custom" 选项使用 MATLAB print 命令来调整图窗大小。如果图形太大，无法放入指定的空间，print 命令会裁剪快照图像。为了避免裁剪，请将 Scaling 属性设置为“none”，并使用 Snapshot 属性指定的报告器来调整图像大小。由于报告器将文本与图像的其他部分一起缩小，因此，除非放大图像，否则细节可能无法辨认。请参阅调整图片快照大小。

注意

当以下属性设置组合出现时，可能会发生 java.lang.OutOfMemoryError：

Scaling 设置为 "zoom"，Zoom、MaxHeight 和 MaxWidth 属性设置为较大值
Scaling 设置为 "custom"，Height 和 Width 属性设置为较大值

要避免此错误，对于缩放 Scaling，请使用较小的 Zoom、MaxHeight 和 MaxWidth 属性值。对于 Scaling 设置为 "custom"，请使用较小的 Height 和 Width 属性值。

数据类型: char | string

`Height` — 快照图像的高度
`"6in"` (默认) | 字符向量 | 字符串标量

快照图像的高度，指定为字符向量或字符串标量，其中包含一个数字，后跟一个测量单位的缩写。例如，"2in" 指定两英寸。默认快照为 6 英寸。有效的缩写是：

"px" - 像素
"cm" - 厘米
"in" - 英寸
"mm" - 毫米
"pc" - 派卡
"pt" - 磅

注意

对于 PDF 图像，宽度和高度的尺寸限制为 10000px。对于所有其他图像类型，尺寸限制是屏幕尺寸。

示例: "2in"

属性：

`GetAccess`	`public`
`SetAccess`	`public`

数据类型: char | string

`Width` — 快照图像的宽度
`"6.5in"` (默认) | 字符向量 | 字符串标量

快照图像的宽度，指定为字符向量或字符串标量，其中包含一个数字，后跟一个测量单位的缩写。例如，"2in" 指定两英寸。默认快照宽度为 6.5 英寸。有效的缩写是：

"px" - 像素
"cm" - 厘米
"in" - 英寸
"mm" - 毫米
"pc" - 派卡
"pt" - 磅

注意

对于 PDF 图像，宽度和高度的尺寸限制为 10000px。对于所有其他图像类型，尺寸限制是屏幕尺寸。

示例: "2in"

属性：

`GetAccess`	`public`
`SetAccess`	`public`

数据类型: char | string

`PreserveBackgroundColor` — 是否保留背景颜色
`false` 或 `0` (默认) | `true` 或 `1`

是否在快照中保留背景颜色，指定为数值或逻辑值 1 (true) 或 0 (false)。

true - 快照的背景颜色与快照源的背景颜色相同，并且忽略 Theme 属性。
false - 快照的背景颜色遵循 Theme 属性的设置。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

数据类型: logical

`Theme` — 打印快照时使用的图形主题
`"light"` (默认) | `"dark"`

自 R2025a 起

打印快照时使用的图形主题，指定为：

"light" - 以白色背景和深色图线及文字打印图窗。
"dark" - 以深色背景、浅色图线和文字打印图窗。

如果您手动设置了任何图形颜色，则快照会保留这些颜色（但图窗和坐标区的背景颜色除外），无论主题设置如何，都是如此。当 PreserveBackgroundColor 为 true 时，此属性将被忽略。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

数据类型: char | string

`TemplateSrc` — 此报告器的模板来源
字符向量 | 字符串标量 | 报告器或报告 | DOM 文档或文档部件

该报告器的模板来源，以下列方式之一指定：

字符向量或字符串标量，指定包含此报告器模板的文件的路径
此报告器使用的模板或其模板库中包含此报告器模板的报告器或报告
文档对象模型 (DOM) 文档或文档部分，该报告器使用其模板或其模板库包含该报告器的模板

指定的模板必须与您附加此报告器的报告类型相同。例如，对于 Microsoft^® Word 报告，TemplateSrc 必须是 Word 报告模板。如果 TemplateSrc 属性为空，则此报告器将使用默认报告器模板作为报告的输出类型。

属性：

`GetAccess`	`public`
`SetAccess`	`public`
`NonCopyable`	`true`

`TemplateName` — 此报告器的模板名称
字符向量 | 字符串标量

此报告器的模板名称，指定为字符向量或字符串标量。该报告器的模板必须位于该报告器的 TemplateSrc 属性指定的模板的模板库中。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

数据类型: char | string

`LinkTarget` — 此报告器的超链接目标
`[]` (默认) | 字符向量 | 字符串标量 | `mlreportgen.dom.LinkTarget` 对象

此报告器的超链接目标，指定为指定链接目标 ID 的字符向量或字符串标量，或 mlreportgen.dom.LinkTarget 对象。字符向量或字符串标量值转换为 LinkTarget 对象。链接目标在输出报告中紧接着此报告器的内容。

属性：

`GetAccess`	`public`
`SetAccess`	`public`

方法

全部展开

公共方法

方法	用途
`getSnapshotImage`	获取坐标区图像路径
`mlreportgen.report.Axes.createTemplate`	`template = mlreportgen.report.Axes.createTemplate(path,type)` 创建报告器模板输入参量 `path`，模板文件的目标路径和文件名 `type`，模板类型，指定为 `"html"`、`"docx"` 或 `"pdf"`。返回值 `template` - 模板副本的路径和文件名，以字符串标量形式返回。有关更多信息，请参阅 `Reporter` 类的等效方法 `mlreportgen.report.Reporter.createTemplate`。
`mlreportgen.report.Axes.customizeReporter`	`reporter` `= mlreportgen.report.Axes.customizeReporter(classpath)` 创建源自 `mlreportgen.report.Axes` 类的报告器返回值 `reporter` - 新报告器类的路径和文件名，以字符串标量形式返回。有关更多信息，请参阅 `Reporter` 类的等效方法 `mlreportgen.report.Reporter.customizeReporter`。
`mlreportgen.report.Axes.getClassFolder`	`path = mlreportgen.report.Axes.getClassFolder` 获取包含 `mlreportgen.report.Axes` 类定义文件的文件夹位置返回值 `path` - 类定义文件的位置，以字符向量形式返回。有关更多信息，请参阅 `Reporter` 类的等效方法 `mlreportgen.report.Reporter.getClassFolder`。
`copy`	创建报告器对象的副本，并对某些属性值进行深度复制
`getImpl`	获取报告器的实现

示例

全部折叠

将坐标区图像添加到报告

打开实时脚本

此示例显示如何向报告添加坐标区图像并设置坐标区图像题注和维度。

import mlreportgen.report.*

创建 PDF 报告和章节。

rpt = Report("Add Axis Figure", "pdf");
chapter = Chapter("Axes");

为绘图创建数据和一组坐标区。

ax = axes(Position=[0.1 0.1 0.7 0.7]);
x1 = linspace(0,10,100);
y1 = sin(x1);
plot(ax,x1,y1);

Figure contains an axes object. The axes object contains an object of type line.

使用 mlreportgen.report.Axes 创建一个坐标区报告器。

axesRpt = Axes(ax);

使用自定义缩放选项将图像的高度和宽度设置为四英寸。

axesRpt.Scaling = "custom";
axesRpt.Height = "4in";
axesRpt.Width = "4in";

将坐标区报告器添加到章节中，并将章节添加到报告中。

append(chapter,axesRpt);
add(rpt,chapter);

关闭报告并查看。

close(rpt);
rptview(rpt);

提示

报告生成器根据 Scaling 属性的值计算图窗快照的宽度和高度。图例是浮动元素，与坐标区或图窗内容没有紧密绑定。当使用 Scaling 值调整图窗的尺寸时，报告中的图例位置可能会与图窗中的位置发生偏移。

版本历史记录

在 R2021b 中推出

全部展开

R2025a: 在坐标区快照中包含图例

报告中的坐标区快照现在包括图例。

R2025a: 为快照指定图形主题

使用 Theme 属性设置打印快照时使用的图形主题，指定为 "light" 或 "dark"。如果 PreserveBackgroundColor 属性为 true，则忽略 Theme 属性。

R2024b: 删除 BMP 以进行图像输出

报告生成器不再支持 BMP（位图）作为输出图像格式。这会影响报表资源管理器和报表、DOM 和 PPT API 中的快照、文件中的图像和水印。有关详细信息，请参阅 print。

另请参阅

mlreportgen.finder.AxesFinder | mlreportgen.report.Figure | mlreportgen.finder.AxesResult

mlreportgen.report.Axes 类

描述

类属性

创建对象

描述

属性

Source — 坐标区图像来源 坐标区句柄

属性：

Snapshot — 快照报告器 mlreportgen.report.FormalImage 对象

属性：

SnapshotFormat — 快照图像格式 "svg" (默认) | "emf" | "gif" | "jpg" | ...

属性：

Scaling — 快照图像的缩放选项 "auto" (默认) | "custom" | "none"

Height — 快照图像的高度 "6in" (默认) | 字符向量 | 字符串标量

属性：

Width — 快照图像的宽度 "6.5in" (默认) | 字符向量 | 字符串标量

属性：

PreserveBackgroundColor — 是否保留背景颜色 false 或 0 (默认) | true 或 1

属性：

Theme — 打印快照时使用的图形主题 "light" (默认) | "dark"

属性：

TemplateSrc — 此报告器的模板来源 字符向量 | 字符串标量 | 报告器或报告 | DOM 文档或文档部件

属性：

TemplateName — 此报告器的模板名称 字符向量 | 字符串标量

属性：

LinkTarget — 此报告器的超链接目标 [] (默认) | 字符向量 | 字符串标量 | mlreportgen.dom.LinkTarget 对象

属性：

方法

公共方法

示例

将坐标区图像添加到报告

提示

版本历史记录

R2025a: 在坐标区快照中包含图例

R2025a: 为快照指定图形主题

R2024b: 删除 BMP 以进行图像输出

另请参阅

`Source` — 坐标区图像来源
坐标区句柄

`Snapshot` — 快照报告器
`mlreportgen.report.FormalImage` 对象

`SnapshotFormat` — 快照图像格式
`"svg"` (默认) | `"emf"` | `"gif"` | `"jpg"` | ...

`Scaling` — 快照图像的缩放选项
`"auto"` (默认) | `"custom"` | `"none"`

`Height` — 快照图像的高度
`"6in"` (默认) | 字符向量 | 字符串标量

`Width` — 快照图像的宽度
`"6.5in"` (默认) | 字符向量 | 字符串标量

`PreserveBackgroundColor` — 是否保留背景颜色
`false` 或 `0` (默认) | `true` 或 `1`

`Theme` — 打印快照时使用的图形主题
`"light"` (默认) | `"dark"`

`TemplateSrc` — 此报告器的模板来源
字符向量 | 字符串标量 | 报告器或报告 | DOM 文档或文档部件

`TemplateName` — 此报告器的模板名称
字符向量 | 字符串标量

`LinkTarget` — 此报告器的超链接目标
`[]` (默认) | 字符向量 | 字符串标量 | `mlreportgen.dom.LinkTarget` 对象