1bf9d44ad7bf8f6af4323a3917003544edab425b
[scilab.git] / scilab / modules / graphics / help / en_US / axes_operations / subplot.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
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="subplot">
17     <refnamediv>
18         <refname>subplot</refname>
19         <refpurpose>virtually grids the figure and sets the plotting area to a chosen cell</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>subplot(m,n,p)
24             subplot(mnp)
25         </synopsis>
26     </refsynopsisdiv>
27     <refsection>
28         <title>Arguments</title>
29         <variablelist>
30             <varlistentry>
31                 <term>m,n,p</term>
32                 <listitem>
33                     <para>positive integers</para>
34                 </listitem>
35             </varlistentry>
36             <varlistentry>
37                 <term>mnp</term>
38                 <listitem>
39                     <para>
40                         an integer with decimal notation <literal>mnp</literal>
41                     </para>
42                 </listitem>
43             </varlistentry>
44         </variablelist>
45     </refsection>
46     <refsection>
47         <title>Description</title>
48         <para>
49             subplot(m,n,p) or subplot(mnp) breaks the graphics window
50             into an m-by-n matrix of sub-windows and selects the p-th sub-window
51             for drawing  the current plot.  The number of a sub-window into the
52             matrices is counted row by row ie the sub-window corresponding to element
53             (i,j) of the matrix has number (i-1)*n + j.
54         </para>
55     </refsection>
56     <refsection>
57         <title>Examples</title>
58         <programlisting role="example"><![CDATA[
59 subplot(221)
60 plot2d()
61 subplot(222)
62 plot3d()
63 subplot(2,2,3)
64 param3d()
65 subplot(2,2,4)
66 hist3d()
67  ]]></programlisting>
68         <scilab:image>
69             subplot(221)
70             plot2d()
71             subplot(222)
72             plot3d()
73             subplot(2,2,3)
74             param3d()
75             subplot(2,2,4)
76             hist3d()
77         </scilab:image>
78     </refsection>
79     <refsection role="see also">
80         <title>See also</title>
81         <simplelist type="inline">
82             <member>
83                 <link linkend="plot2d">plot2d</link>
84             </member>
85             <member>
86                 <link linkend="plot3d">plot3d</link>
87             </member>
88             <member>
89                 <link linkend="xstring">xstring</link>
90             </member>
91             <member>
92                 <link linkend="xtitle">xtitle</link>
93             </member>
94         </simplelist>
95     </refsection>
96 </refentry>