mlreportgen.finder.AxesFinder Class

Namespace: mlreportgen.finder

Find axes in MATLAB figure window

Since R2021b

Description

Use an object of the mlreportgen.finder.AxesFinder class to find all axes in a MATLAB^® figure window.

The mlreportgen.finder.AxesFinder class is a handle class.

Class Attributes

HandleCompatible

true

For information on class attributes, see Class Attributes.

Creation

Description

finder = mlreportgen.finder.AxesFinder(container) creates an mlreportgen.finder.AxesFinder object and sets the Container property to a figure handle or path to a figure handle.

finder = mlreportgen.finder.AxesFinder(Name,Value) sets properties by using name-value arguments. Specify multiple name-value arguments in any order.

Properties

Container — Figure container

figure handle | string scalar | character vector

Figure container, specified as a:

• Character vector or string scalar that contains the path to a valid figure file

• Valid figure handle

Properties — Properties of axes to find

{} | cell array

Properties of the axes to find, specified as a cell array of name-value arguments. The finder returns only axes that have the specified properties with the specified values.

Methods

Public Methods

find	results = find(AxesFinderObject) finds axes in the figure specified by the finder. This method returns all axes as mlreportgen.finder.AxesResult objects. These result objects can be added directly to reports of type mlreportgen.report.Report or slreportgen.report.Report.
hasNext	tf = hasNext(AxesFinderObject) determines if the figure that the finder searches contains at least one of the specified axes to find. If the figure contains at least ones axis, the hasNext method queues that axis as the next item that the next method will return. The hasNext method then returns true. Use the next method to obtain that axes. On subsequent calls, the hasNext method determines if the figure contains an axes that the next method has not yet retrieved. It queues the axes for the next method to retrieve and returns true. If there are no more axes to be retrieved, this method returns false. To search a container progressively for axes, use the hasNext method with the next method in a while loop.
next	result = next(AxesFinderObject) returns the next search result in the result queue created by the hasNext method as this method returns the axes that it finds, wrapped in an mlreportgen.finder.AxesResult object.

Examples

Find and Include Multiple Axes in a Report

This example shows how to use an mlreportgen.finder.AxesFinder object to find and include the axes in a given figure window.

Create a report.

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

Create a figure handle and plots to include in the report.

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

Use the find method from mlreportgen.finder.AxesFinder to search for all axes currently open in the given figure window.

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

Add the results to your report. Close and view the report.

append(rpt, results);

close(rpt);
rptview(rpt);

Version History

Introduced in R2021b