scatter with extended polyline properties mark_size, mark_foreground, mark_background
[scilab.git] / scilab / modules / graphics / help / en_US / xnumb.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) ENPC - Jean-Philippe Chancelier
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
11  *
12  -->
13 <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">
14     <refnamediv>
15         <refname>xnumb</refname>
16         <refpurpose>draw numbers</refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>Calling Sequence</title>
20         <synopsis>xnumb(x, y, nums, [box, angle])</synopsis>
21     </refsynopsisdiv>
22     <refsection>
23         <title>Arguments</title>
24         <variablelist>
25             <varlistentry>
26                 <term>x, y, nums</term>
27                 <listitem>
28                     <para>vectors of same size.</para>
29                 </listitem>
30             </varlistentry>
31             <varlistentry>
32                 <term>box</term>
33                 <listitem>
34                     <para>an integer value.</para>
35                 </listitem>
36             </varlistentry>
37             <varlistentry>
38                 <term>angle</term>
39                 <listitem>
40                     <para>
41                         an optional vector of same size as <varname>x</varname>
42                     </para>
43                 </listitem>
44             </varlistentry>
45         </variablelist>
46     </refsection>
47     <refsection>
48         <title>Description</title>
49         <para>
50             <function>xnumb</function> draws the value of <literal>nums(i)</literal>
51             at position <literal>x(i), y(i)</literal> in the current scale.
52             If <varname>box</varname> is 1, a box is drawn around the numbers.
53             If <varname>angle</varname> is given, it gives the direction for string drawing.
54         </para>
55         <para>
56             <note>
57                 Note that a maximum of 4 significant digits of each element of <varname>nums</varname>
58                 will be displayed.
59             </note>
60         </para>
61     </refsection>
62     <refsection>
63         <title>Examples</title>
64         <programlisting role="example"><![CDATA[ 
65 plot2d([-100,500],[-100,600],[-1,-1],"022")
66 x=0:100:200;
67 xnumb(x,500*ones(x),[10,20,35],1)
68  ]]></programlisting>
69         <scilab:image>
70             plot2d([-100,500],[-100,600],[-1,-1],"022")
71             x=0:100:200;
72             xnumb(x,500*ones(x),[10,20,35],1)
73         </scilab:image>
74     </refsection>
75     <refsection role="see also">
76         <title>See Also</title>
77         <simplelist type="inline">
78             <member>
79                 <link linkend="xstring">xstring</link>
80             </member>
81         </simplelist>
82     </refsection>
83 </refentry>