Graphics tests: fix histrogram references
[scilab.git] / scilab / modules / graphics / help / fr_FR / bar_histogram / bar.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <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="fr" xml:id="bar">
3     <refnamediv>
4         <refname>bar</refname>
5         <refpurpose>histogramme de barres</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Séquence d'appel</title>
9         <synopsis>bar(y)
10             bar(x,y)
11             bar([h],x,y [,width [,color [,style]]])
12         </synopsis>
13     </refsynopsisdiv>
14     <refsection>
15         <title>Paramètres</title>
16         <variablelist>
17             <varlistentry>
18                 <term>h</term>
19                 <listitem>
20                     <para>un pointeur sur les axes, (par défaut: h=gca() ).</para>
21                 </listitem>
22             </varlistentry>
23             <varlistentry>
24                 <term>y</term>
25                 <listitem>
26                     <para>un scalaire, un vecteur de taille N, ou une matrice de taille N*M</para>
27                 </listitem>
28             </varlistentry>
29             <varlistentry>
30                 <term>x</term>
31                 <listitem>
32                     <para>un scalaire ou un vecteur de taille N, (si y est un vecteur alors x doit etre de meme longeur que y. Si y est une matrice alors x doit etre un vecteur de longeur egale au nombre de lignes de y).</para>
33                 </listitem>
34             </varlistentry>
35             <varlistentry>
36                 <term>width</term>
37                 <listitem>
38                     <para>(optionnel), un scalaire, définit l'épaisseur des barres (un pourcentage de l'epaisseur maximum autorisé pour une barre), par défaut: width=0.8, i.e 80%.</para>
39                 </listitem>
40             </varlistentry>
41             <varlistentry>
42                 <term>color</term>
43                 <listitem>
44                     <para>(optionnel), une chaine (par défaut: 'blue'), specifiant la couleur de l'intérieur des barres.</para>
45                 </listitem>
46             </varlistentry>
47             <varlistentry>
48                 <term>style:</term>
49                 <listitem>
50                     <para>(optionel), une chaine, 'grouped' or 'stacked' (par défaut: 'grouped').</para>
51                 </listitem>
52             </varlistentry>
53         </variablelist>
54     </refsection>
55     <refsection>
56         <title>Description</title>
57         <para>
58             <literal>bar(y,...) :</literal> si y est un vecteur alors la fonction bar
59             dessine une polyline de type <literal>polyline_style</literal> égale à 6, dans
60             ce cas x =1 : length(y). Si y est une matrice de taille N*M, alors la
61             fonction bar dessine M polylines de (type 6), chaque polyline correspond à
62             une colonne de y est au vecteur x=1:size(y,1).
63         </para>
64         <para>
65             <literal>bar(x,y,...) :</literal> si y est un vecteur alors la fonction bar
66             dessine une polyline de type <literal>polyline_style</literal> égale à 6,
67             vérifiant: longeur de x = longeur de y .Si y est une matrice de taille
68             N*M, alors la fonction bar dessine M polylines de (type 6), chaque
69             polyline correspond à une colonne de y est au vecteur x vérifiant longueur
70             de x=size(y,1) (i.e longueur de x = nombre de ligne de y).
71         </para>
72         <para>
73             <literal>bar(h,...) :</literal> definit les axes courants ou le dessin est
74             réalisé.
75         </para>
76         <para>
77             <literal>bar(...,width,...) :</literal> definit l'épaisseur des barres en
78             pourcentage (générallement: 0&lt;width&lt;=1).
79         </para>
80         <para>
81             <literal>bar(...,style,...) :</literal> dans le cas ou y est une matrice
82             l'option style definit la façon dont les barres sont positionnées les unes
83             par rapport aux autres. Si y est une matice N*M (donc M polylines de type
84             6) alors il y a 2 façons de dessiner ces M barres. l'option style fixée à
85             grouped' permet de centrer les M polylines par rapport aux abscisses (i.e
86             par rapport à chaque composantes de x), et l'option style fixée à
87             'stacked' permet de les empiler.
88         </para>
89         <para>
90             <literal>bar(...,color,...) : </literal>definit la couleur des barres. La
91             fonction bar utilise la meme colormap que la fonction
92             <literal>plot</literal>.
93         </para>
94         <para>S'il y a plusieurs appels à la fonction bar, la fonction
95             <literal>barhomogenize</literal> permet d'homogénéiser l'épaisseur et le style
96             de toutes les barres (i.e les polylines de type 6) inclus dans les axes
97             courrants.
98         </para>
99     </refsection>
100     <refsection>
101         <title>Exemples</title>
102         <programlisting role="example"><![CDATA[
103 // Premier exemple : dessine une barre, avec les paramètres width=0.5
104 // et color='yellow' et par défaut x=1:length(y), style = 'grouped'.
105 scf(0);
106 y=[1 -3 5];
107 bar(y,0.5,'yellow');
108  ]]></programlisting>
109
110         <scilab:image>
111             y=[1 -3 5];
112             bar(y,0.5,'yellow');
113         </scilab:image>
114         <programlisting role="example"><![CDATA[
115 // Deuxième exemple : par défaut style='grouped'
116 scf(1);
117 x=[1 2 5]; y=[1  -5 6;3 -2 7;4  -3 8];
118 bar(x,y);
119  ]]></programlisting>
120         <scilab:image>
121             x=[1 2 5];
122             y=[1  -5 6;3 -2 7;4  -3 8];
123             bar(x,y);
124         </scilab:image>
125
126         <programlisting role="example"><![CDATA[
127 // Troisième exemple : dessine 3 bars (nombre de colonnes de y) style='stacked'.
128 scf(2);
129 x=[1 2 5]; y=[1 4 7;2 5 8;3 6  9];
130 bar(x,y,'stacked');
131  ]]></programlisting>
132
133
134         <scilab:image>
135             x=[1 2 5];
136             y=[1 4 7;2 5 8;3 6  9];
137             bar(x,y,'stacked');
138         </scilab:image>
139         <programlisting role="example"><![CDATA[
140 // Quatrième exemple; width=0.2;color='green'; par défaut style='grouped'
141 scf(3);
142 x=[1 2 5]; y=[1 4 7;2 5 8;3 6 9];
143 bar(x,y,0.2,'green');
144  ]]></programlisting>
145         <scilab:image>
146             x=[1 2 5];
147             y=[1 4 7;2 5 8;3 6 9];
148             bar(x,y,0.2,'green');
149         </scilab:image>
150     </refsection>
151     <refsection role="see also">
152         <title>Voir aussi</title>
153         <simplelist type="inline">
154             <member>
155                 <link linkend="barh">barh</link>
156             </member>
157             <member>
158                 <link linkend="barhomogenize">barhomogenize</link>
159             </member>
160             <member>
161                 <link linkend="plot">plot</link>
162             </member>
163             <member>
164                 <link linkend="histplot">histplot</link>
165             </member>
166             <member>
167                 <link linkend="polyline_properties">polyline_properties</link>
168             </member>
169         </simplelist>
170     </refsection>
171 </refentry>