* bug #14558: square() is obsolete
[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  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <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">
17     <refnamediv>
18         <refname>square</refname>
19         <refpurpose>
20             set scales for isometric plot (change the size of the window) <emphasis role="bold">(function obsolete)</emphasis>
21         </refpurpose>
22     </refnamediv>
23     <refsynopsisdiv>
24         <title>Syntax</title>
25         <synopsis>square(xmin, ymin, xmax, ymax)</synopsis>
26     </refsynopsisdiv>
27     <refsection>
28         <title>Arguments</title>
29         <variablelist>
30             <varlistentry>
31                 <term>xmin, xmax, ymin, ymax</term>
32                 <listitem>
33                     <para>four real values.</para>
34                 </listitem>
35             </varlistentry>
36         </variablelist>
37     </refsection>
38     <refsection>
39         <title>Description</title>
40         <warning>
41             This function is obsolete. It will be removed in Scilab 6.1.
42         </warning>
43         <warning>
44             Please replace <literal>square(a,b,c,d)</literal> with
45             <literal>gcf().axes_size = [n n]; replot([a b c d])</literal>
46             where <literal>n</literal> is the size in pixels of the desired
47             graphic square window. This replacement can be extended to any
48             existing graphic window, not only the current one.
49         </warning>
50         <para>
51             <function>square</function> is used to have isometric scales on the x
52             and y axes. The requested values <literal>xmin</literal>,
53             <literal>xmax</literal>, <literal>ymin</literal>,
54             <literal>ymax</literal> are the boundaries of the graphics frame
55             and <function>square</function> changes the graphics window
56             dimensions in order to have an isometric plot.
57             <function>square</function> sets the current graphics scales
58             and can be used in conjunction with graphics routines which request
59             the current graphics scale (for instance <code>strf="x0z"</code> in
60             <function>plot2d</function>).
61         </para>
62     </refsection>
63     <refsection>
64         <title>Examples</title>
65         <programlisting role="example"><![CDATA[
66 t=[0:0.1:2*%pi]';
67 plot2d(sin(t),cos(t))
68 clf()
69 square(-1,-1,1,1)
70 plot2d(sin(t),cos(t))
71  ]]></programlisting>
72     </refsection>
73     <refsection role="see also">
74         <title>See also</title>
75         <simplelist type="inline">
76             <member>
77                 <link linkend="isoview">isoview</link>
78             </member>
79             <member>
80                 <link linkend="xsetech">xsetech</link>
81             </member>
82         </simplelist>
83     </refsection>
84     <refsection role="history">
85         <title>History</title>
86         <revhistory>
87             <revision>
88                 <revnumber>6.0</revnumber>
89                 <revdescription>
90                     square() is tagged as obsolete. It will be removed from Scilab 6.1
91                 </revdescription>
92             </revision>
93         </revhistory>
94     </refsection>
95 </refentry>