summaryrefslogtreecommitdiff
path: root/modules/graphics/help/en_US/xgrid.xml
blob: 3c45e3b30f8c8da9efbf5c6373af4b8d3db5c1da (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) ENPC - Jean-Philippe Chancelier
 * Copyright (C) 2014 - Scilab Enterprises - Calixte DENIZET
 * 
 * This file must be used under the terms of the CeCILL.
 * This source file is licensed as described in the file COPYING, which
 * you should have received as part of this distribution.  The terms
 * are also available at    
 * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
 *
 -->
<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="xgrid">
    <refnamediv>
        <refname>xgrid</refname>
        <refpurpose>add a grid on a 2D or 3D plot</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>xgrid([color] [, thickness] [, style])</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>color</term>
                <listitem>
                    <para>an integer or a row matrix.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>thickness</term>
                <listitem>
                    <para>a real or a row matrix.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>style</term>
                <listitem>
                    <para>an integer or a row matrix.</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            <function>xgrid</function> adds a grid on a 2D or 3D plot.
            d for each axis).
        </para>
        <para>
            <literal>color</literal> is the colors id to use for the grid plotting (if <literal>color</literal> is a scalar then the same color is used for each axis).
        </para>
        <para>
            <literal>thickness</literal> is the thickness to use for the grid plotting (if <literal>thickness</literal> is a scalar then the same thickness is used for each axis).
        </para>
        <para>
            <literal>style</literal> is the style to use for the grid plotting (if <literal>style</literal> is a scalar then the same style is used for each axis). Available styles are the same as for <literal>line_style</literal> property (see <link linkend="axes_properties">axes_properties</link>).
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[ 
x=[0:0.1:2*%pi]';
plot2d(sin(x))
xgrid(5, 1, 7)
 ]]></programlisting>
        <scilab:image>
            x=[0:0.1:2*%pi]';
            plot2d(sin(x))
            xgrid(5, 1, 7)
        </scilab:image>
    </refsection>
    <refsection role="see also">
        <title>See Also</title>
        <simplelist type="inline">
            <member>
                <link linkend="axes_properties">axes_properties</link>
            </member>
            <member>
                <link linkend="plot2d">plot2d</link>
            </member>
        </simplelist>
    </refsection>
    <refsection>
        <title>History</title>
        <revhistory>
            <revision>
                <revnumber>5.5.0</revnumber>
                <revremark>
                    Arguments <literal>thickness</literal> and <literal>style</literal> introduced.
                </revremark>
            </revision>
        </revhistory>
    </refsection>
</refentry>