Update unzoom and zoom_rect help pages. Warning message appeared: Syntax vector ...
[scilab.git] / scilab / modules / graphics / help / en_US / axes_operations / unzoom.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) INRIA - Serge Steer
5  * Copyright (C) INRIA - 2008 - Jean-Baptiste Silvy
6  * 
7  * This file must be used under the terms of the CeCILL.
8  * This source file is licensed as described in the file COPYING, which
9  * you should have received as part of this distribution.  The terms
10  * are also available at    
11  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
12  *
13  -->
14 <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="unzoom">
15     <refnamediv>
16         <refname>unzoom</refname>
17         <refpurpose>unzoom graphics</refpurpose>
18     </refnamediv>
19     <refsynopsisdiv>
20         <title>Calling Sequence</title>
21         <synopsis>unzoom()
22             unzoom(H)
23         </synopsis>
24     </refsynopsisdiv>
25     <refsection>
26         <title>Arguments</title>
27         <variablelist>
28             <varlistentry>
29                 <term>H</term>
30                 <listitem>
31                     <para>A vector of Figure or Axes handle.</para>
32                 </listitem>
33             </varlistentry>
34         </variablelist>
35     </refsection>
36     <refsection>
37         <title>Description</title>
38         <para>
39             <literal>unzoom()</literal> is used to remove the zoom effect for all the axes of the
40             current graphic figure: 
41         </para>
42         <para>
43             <literal>unzoom(H)</literal> is used to remove the zoom effect for all the
44             Figures and Axes given by the vector of handles <literal>H</literal>.
45             Removing zoom effect for a Figure is the equivalent of removing zoom effect
46             on all its Axes children.
47         </para>
48     </refsection>
49     <refsection>
50         <title>Examples</title>
51         <programlisting role="example"><![CDATA[ 
52 clf()
53 x=0:0.01:6*%pi;
54 plot2d(x,sin(x.^2))
55 zoom_rect([16,-1,18,1])
56 unzoom()
57
58 //subplots accordingly
59 clf()
60 x=0:0.01:6*%pi;
61 subplot(211)
62 plot2d(x,cos(x))
63 a1=gca();
64 subplot(212)
65 plot2d(x,cos(2*x))
66 a2=gca();
67 rect=[3 -2 7 10]; // a rectangle specified in the current axes (last one) coordinates
68 zoom_rect(rect) 
69 unzoom(a1) // unzoom first plot only
70 unzoom(a2) // unzoom second plot only
71 zoom_rect(rect) // zoom again
72 unzoom(gcf()) // unzoom all the axes, equivalent to unzoom()
73  ]]></programlisting>
74     </refsection>
75     <refsection role="see also">
76         <title>See Also</title>
77         <simplelist type="inline">
78             <member>
79                 <link linkend="zoom_rect">zoom_rect</link>
80             </member>
81             <member>
82                 <link linkend="axes_properties">axes_properties</link>
83             </member>
84         </simplelist>
85     </refsection>
86 </refentry>