hover

Class: matlab.uitest.TestCase
Namespace: matlab.uitest

Perform hover gesture on UI component

Syntax

hover(testCase,comp)

hover(testCase,comp,location)

Description

hover(testCase,comp) performs a hover gesture on the UI component comp that supports this gesture.

hover(testCase,comp,location) specifies the location to hover at within the component. If you do not specify the location, MATLAB^® hovers at the center of comp.

Input Arguments

testCase — Test case

matlab.uitest.TestCase object

Test case, specified as a matlab.uitest.TestCase object.

comp — Component to hover

UI component object

Component to hover on during test, specified as a UI component object that supports a hover gesture. Components that support hover gestures include Axes, UIAxes, PolarAxes, Panel, and Figure objects.

Supported Component	Typical Creation Function
Axes	axes
Panel	uipanel
Polar Axes	polaraxes
UI Axes	uiaxes
UI Figure	uifigure

location — Location to hover at

1-by-2 or 1-by-3 numeric array

Location to hover at, specified as the coordinates of the hover point:

• Axes and UI Axes — A 1-by-2 or 1-by-3 numeric array containing x-, y-, and optionally z-coordinates.

• Polar Axes — A 1-by-2 numeric array containing θ- and r-coordinates.

• Panel — A 1-by-2 numeric array containing x- and y-coordinates. Specify the coordinates of the point measured in pixels from the lower-left corner of the component.

• UI Figure — A 1-by-2 numeric array containing x- and y-coordinates. Specify the coordinates of the point from the lower-left corner of the component.

Example: [32.5 13 0.25] (UI axes)

Example: [pi/2 0.5] (Polar axes)

Example: [100 200] (UI figure)

Attributes

Sealed

true

To learn about attributes of methods, see Method Attributes.

Examples

Hover on UI Axes Object

Create a UI axes and an interactive test case instance.

uiAx = uiaxes;
testCase = matlab.uitest.TestCase.forInteractiveUse;

Hover over the point defined by the axes coordinates (0.2, 0.4).

testCase.hover(uiAx,[0.2 0.4])

Hover on UI Figure Object

Create a UI figure and an interactive test case instance.

uiFig = uifigure;
testCase = matlab.uitest.TestCase.forInteractiveUse;

Hover over the point defined by the pixel coordinates (100, 200).

testCase.hover(uiFig,[100 200])

Version History

Introduced in R2019a

R2024b: Specify location of gesture on figures that use nonpixel units

You can specify the location of the gesture on a UI figure that uses any unit of measurement. In previous releases, the method lets you specify coordinates only for figures whose Units property is set to "pixels".

R2024b: Specifying location of gesture on axes or UI axes with active right y-axis is not supported

Specifying the location of the gesture on axes or UI axes with an active right y-axis is no longer supported. If your chart has two y-axes, activate the side associated with the left y-axis before performing the gesture. In previous releases, when you specify the location on axes or UI axes with an active right side, the app testing framework interprets that location with respect to the left y-axis, which can cause the gesture to occur at an unexpected location or fail.

R2021a: Perform gestures on panels

You can perform hover gestures in tests on panels.

R2019b: Perform gestures on polar axes

You can perform hover gestures in tests on polar axes.