matlab.unittest.measurement.chart.ComparisonPlot Class

R2026b

Namespace: matlab.unittest.measurement.chart
Superclasses: matlab.graphics.chartcontainer.ChartContainer, matlab.graphics.chartcontainer.mixin.Legend

Visually compare two sets of time experiment results

Description

Objects of the matlab.unittest.measurement.chart.ComparisonPlot class provide a visualization to compare the time measurement results of two equal-sized sets of performance tests. ComparisonPlot objects map baseline and measurement TimeResult instances to the x- and y-axes of 2-D scatter plots, respectively.

The matlab.unittest.measurement.chart.ComparisonPlot class is a handle class.

Class Attributes

Sealed

true

For information on class attributes, see Class Attributes.

Creation

To create ComparisonPlot instances, use the comparisonPlot method.

Properties

In addition to these properties, ComparisonPlot inherits properties from its superclasses.

Scale — Scale of x- and y-axes

"log" (default) | "linear"

Scale of the x- and y-axes of the ComparisonPlot object, specified as "log" or "linear".

SimilarityTolerance — Allowable deviation of statistics ratio from 1

0.1 (default) | numeric scalar in range [0, 1)

Allowable deviation of the statistics ratio from 1, for a pair of similar performance tests, specified as a numeric scalar in the range [0, 1).

SimilarityTolerance specifies the borders of a shaded region in the ComparisonPlot object. Data points that fall inside this region represent similar baseline and measurement entries.

Title — Title of comparison plot

character vector | categorical array | cell array | numeric array | string array

Title of the comparison plot, specified as a character vector, categorical array, cell array, numeric array, or string array. By default, the title includes the statistic used in the comparison and a performance comparison percentage.

ToolbarVisible — Display axes toolbar

"on" (default) | on/off logical value

Display the axes toolbar, specified as "on" or "off", or as numeric or logical 1 (true) or 0 (false). A value of "on" is equivalent to true, and "off" is equivalent to false. Thus, you can use the value of this property as a logical value. The value is stored as an on/off logical value of type matlab.lang.OnOffSwitchState.

• "on" — Display the toolbar.

• "off" — Do not display the toolbar.

For more information about the axes toolbar, see Control Chart Interactivity.

Version History

Introduced in R2019b

R2026b: Display or hide axes toolbar using ToolbarVisible property

Display or hide the axes toolbar by setting the ToolbarVisible property. The axes toolbar is visible by default, but you can hide it by setting the property to "off".