<?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) 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="xnumb">
    <refnamediv>
        <refname>xnumb</refname>
        <refpurpose>draw numbers</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Syntax</title>
        <synopsis>xnumb(x, y, nums, [box, angle])</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>x, y, nums</term>
                <listitem>
                    <para>vectors of same size.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>box</term>
                <listitem>
                    <para>an integer value.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>angle</term>
                <listitem>
                    <para>
                        an optional vector of same size as <varname>x</varname>
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            <function>xnumb</function> draws the value of <literal>nums(i)</literal>
            at position <literal>x(i), y(i)</literal> in the current scale.
            If <varname>box</varname> is 1, a box is drawn around the numbers.
            If <varname>angle</varname> is given, it gives the direction for string drawing.
        </para>
        <para>
            <note>
                Note that a maximum of 4 significant digits of each element of <varname>nums</varname>
                will be displayed.
            </note>
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
plot2d([-100,500],[-100,600],[-1,-1],"022")
x=0:100:200;
xnumb(x,500*ones(x),[10,20,35],1)
 ]]></programlisting>
        <scilab:image>
            plot2d([-100,500],[-100,600],[-1,-1],"022")
            x=0:100:200;
            xnumb(x,500*ones(x),[10,20,35],1)
        </scilab:image>
    </refsection>
    <refsection role="see also">
        <title>See also</title>
        <simplelist type="inline">
            <member>
                <link linkend="xstring">xstring</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
