Main Content

ishold

Current hold state

Syntax

tf = ishold
tf = ishold(ax)

Description

tf = ishold returns the hold state of the current axes. The return value is true if the hold state is on, and it is false if the hold state is off. When the hold state is on, the current plot and most axes properties are held so that subsequent graphing commands add to the existing graph. If there is no figure, ishold returns false and MATLAB® creates a new figure.

tf = ishold(ax) returns the hold state of the specified axes object, which can be any type of axes object. You can also specify ax as an array of multiple axes objects that belong to the same class (use the class function to determine the class).

When the hold state is on, the NextPlot property of the figure and the axes object is set to "add".

Version History

Introduced before R2006a