mlreportgen.finder.AxesFinder 类

R2026b

命名空间: mlreportgen.finder

在 MATLAB 图窗窗口中查找坐标区

全页展开

描述

使用 mlreportgen.finder.AxesFinder 类的对象来查找 MATLAB^® 图窗窗口中的所有坐标区。

mlreportgen.finder.AxesFinder 类是一个 handle 类。

类属性

HandleCompatible true

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

创建对象

描述

finder = mlreportgen.finder.AxesFinder(container) 创建一个 mlreportgen.finder.AxesFinder 对象并将 Container 属性设置为图窗句柄或图窗句柄的路径。

示例

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

属性

全部展开

`Container` — 图窗容器
图窗句柄 | 字符串标量 | 字符向量

图窗容器，指定为：

包含有效图窗文件路径的字符向量或字符串标量
有效图窗句柄

`Properties` — 要查找的坐标区的属性
{} | 元胞数组

要查找的坐标区的属性，指定为名称-值参量元胞数组。查找器仅返回具有指定属性和指定值的坐标区。

方法

全部展开

公共方法

`find`	`results = find(AxesFinderObject)` 在查找器指定的图窗中查找坐标区。该方法将所有坐标区作为 `mlreportgen.finder.AxesResult` 对象返回。这些结果对象可以直接添加到 `mlreportgen.report.Report` 或 `slreportgen.report.Report` 类型的报告中。
`hasNext`	`tf = hasNext(AxesFinderObject)` 确定查找器搜索的图窗是否至少包含一个要查找的指定坐标区。如果图窗至少包含一个轴，则 `hasNext` 方法将该轴排队为 `next` 方法将返回的下一个项目。然后 `hasNext` 方法返回 true。使用 `next` 方法获取该坐标区。在后续调用中，`hasNext` 方法确定图窗是否包含 `next` 方法尚未检索的坐标区。它将坐标区排队以供 `next` 方法检索并返回 true。如果没有更多坐标区可检索，则此方法返回 false。要逐步搜索容器中的坐标区，请在 `hasNext` 循环中将 `next` 方法与 `while` 方法结合使用。
`next`	`result = next(AxesFinderObject)` 返回由 `hasNext` 方法创建的结果队列中的下一个搜索结果，因为此方法返回它找到的坐标区，包装在 `mlreportgen.finder.AxesResult` 对象中。

示例

全部折叠

在报告中查找并包含多个坐标区

此示例显示如何使用 mlreportgen.finder.AxesFinder 对象在给定的图窗窗口中查找并包含坐标区。

创建报告。

import mlreportgen.report.*
import mlreportgen.finder.*
rpt = Report("AxesFinder Example","pdf");

创建图窗句柄和图窗以包含在报告中。

f = figure;
 
axes1 = subplot(2,1,1);
x = linspace(0,10);
y1 = sin(x);
plot(x,y1);
 
axes2 = subplot(2,1,2);
y2 = sin(5*x);
plot(x,y2);

使用 find 中的 mlreportgen.finder.AxesFinder 方法搜索给定图窗窗口中当前打开的所有坐标区。

customFinder = mlreportgen.finder.AxesFinder(f);
results = customFinder.find;

将结果添加到您的报告中。关闭并查看报告。

append(rpt, results);
close(rpt);
rptview(rpt);

版本历史记录

在 R2021b 中推出

另请参阅

mlreportgen.finder.AxesResult | mlreportgen.report.Axes | mlreportgen.report.Figure