Clear or reset the current graphic figure (window) to default values (original) (raw)

Please note that the recommended version of Scilab is 2026.0.1. This page might be outdated.
See the recommended documentation of this function

Scilab help >> Graphics > figure_operations > clf

clf

clear or reset the current graphic figure (window) to default values

Calling Sequence

clf() clf(h,) clf(num,)

Arguments

h

a handle, the figure handle

num

a number, the figure_id

<opt_job_arg>

a string ( 'clear'or 'reset' ) specifying the job for clf.

Description

The clf command is used to reset a figure to its default values and/or to delete all its children.

If opt_job_arg string value is 'clear' then all children of the specified figure are deleted.

If opt_job_arg string value is 'reset' then not only all children of the specified figure are deleted but the figure properties are reset to their default values using the default figure model (see gdf). The only exception are the axes_size and figure_size properties which can not be reset if the figure is docked with other elements.

clf(num) clear or reset the figure withfigure_id==num.

clf(h) clear or reset the figure pointed to by the handle h.

clf() clear or reset the current figure.

clf function delete every children of specified windows including menus and uicontrols added by user. To prevent menus and uicontrols from being deleted, the delete(gca()) command might be used instead.

Examples

See Also

• set — set a property value of a graphic entity object or of a User Interface object.
• get — Retrieve a property value from a graphics entity or an User Interface object.
• gcf — Return handle of current graphic window.
• gdf — Return handle of default figure.
• scf — set the current graphic figure (window)
• graphics_entities — description of the graphics entities data structures

Authors

S. Steer & F.Leray INRIA