Revision of help pages for some obsolete functions from module "graphics" (en_US).
[scilab.git] / scilab / modules / graphics / help / en_US / xclear.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) ENPC - Jean-Philippe Chancelier
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"  xml:lang="en" xml:id="xclear">
14     <refnamediv>
15         <refname>xclear</refname>
16         <refpurpose>clears a graphics window. <emphasis role="bold">This function is obsolete.</emphasis></refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>Calling Sequence</title>
20         <synopsis>xclear([window-id])</synopsis>
21     </refsynopsisdiv>
22     <refsection>
23         <title>Arguments</title>
24         <variablelist>
25             <varlistentry>
26                 <term>window-id</term>
27                 <listitem>
28                     <para>an integer scalar or vector.</para>
29                 </listitem>
30             </varlistentry>
31         </variablelist>
32     </refsection>
33     <refsection>
34         <title>Description</title>
35         <para>
36             Without any argument, this function clears the current graphic figure
37             by turning its visibility to <literal>'off'</literal>. Otherwise it
38             clears the graphics figures whose numbers are included in the vector
39             <varname>window-id</varname>. For example <code>xclear(1:3)</code>
40             clears windows 1, 2 and 3. If one of the windows does not
41             exist, then it is automatically created.
42         </para>
43         <para>
44             <warning>
45                 Function <function>xclear</function> is obsolete.
46             </warning>
47             To clear a figure, please use instead the <function>clf</function> function or the <literal>visible</literal> property.
48         </para>
49     </refsection>
50     <refsection>
51         <title>Examples</title>
52         <programlisting role="example"><![CDATA[ 
53 plot2d();
54 scf();
55 plot3d();
56 xclear(0); // clear the first graphic
57 xclear(); // clear the current figure
58  ]]></programlisting>
59     </refsection>
60     <refsection role="see also">
61         <title>See Also</title>
62         <simplelist type="inline">
63             <member>
64                 <link linkend="clf">clf</link>
65             </member>
66         </simplelist>
67     </refsection>
68 </refentry>