Add unitary tests for cacsd
[scilab.git] / scilab / modules / graphics / help / en_US / axes_operations / square.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  * 
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="square">
14     <refnamediv>
15         <refname>square</refname>
16         <refpurpose>
17             set scales for isometric plot (change the size of the window)
18         </refpurpose>
19     </refnamediv>
20     <refsynopsisdiv>
21         <title>Calling Sequence</title>
22         <synopsis>square(xmin, ymin, xmax, ymax)</synopsis>
23     </refsynopsisdiv>
24     <refsection>
25         <title>Arguments</title>
26         <variablelist>
27             <varlistentry>
28                 <term>xmin, xmax, ymin, ymax</term>
29                 <listitem>
30                     <para>four real values.</para>
31                 </listitem>
32             </varlistentry>
33         </variablelist>
34     </refsection>
35     <refsection>
36         <title>Description</title>
37         <para>
38             <function>square</function> is used to have isometric scales on the x
39             and y axes. The requested values <literal>xmin</literal>,
40             <literal>xmax</literal>, <literal>ymin</literal>,
41             <literal>ymax</literal> are the boundaries of the graphics frame
42             and <function>square</function> changes the graphics window
43             dimensions in order to have an isometric plot.
44             <function>square</function> sets the current graphics scales
45             and can be used in conjunction with graphics routines which request
46             the current graphics scale (for instance <code>strf="x0z"</code> in
47             <function>plot2d</function>).
48         </para>
49     </refsection>
50     <refsection>
51         <title>Examples</title>
52         <programlisting role="example"><![CDATA[ 
53 t=[0:0.1:2*%pi]';
54 plot2d(sin(t),cos(t))
55 clf()
56 square(-1,-1,1,1)
57 plot2d(sin(t),cos(t))
58  ]]></programlisting>
59     </refsection>
60     <refsection role="see also">
61         <title>See Also</title>
62         <simplelist type="inline">
63             <member>
64                 <link linkend="isoview">isoview</link>
65             </member>
66             <member>
67                 <link linkend="xsetech">xsetech</link>
68             </member>
69         </simplelist>
70     </refsection>
71 </refentry>