<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) ENPC - Jean-Philippe Chancelier
 * Copyright (C) 2014 - Scilab Enterprises - Calixte DENIZET
 *
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 *
 * This file is hereby licensed under the terms of the GNU GPL v2.0,
 * pursuant to article 5.3.4 of the CeCILL v.2.1.
 * This file was originally licensed under the terms of the CeCILL v2.1,
 * and continues to be available under such terms.
 * For more information, see the COPYING file which you should have received
 * along with this program.
 *
 -->
<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>Syntax</title>
        <synopsis>
          xgrid
          xgrid(color)
          xgrid(color, thickness)
          xgrid(color, thickness, style)
         </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>color</term>
                <listitem>
                    <para>an integer or a row vector</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>thickness</term>
                <listitem>
                    <para>a real or a row vector</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>style</term>
                <listitem>
                    <para>an integer or a row vector</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>
