<?xml version="1.0" encoding="UTF-8"?>
<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="barh">
    <refnamediv>
        <refname>barh</refname>
        <refpurpose>histogramme horizontal de barres</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Séquence d'appel</title>
        <synopsis>barh(y)
            barh(x,y)
            barh([h],x,y [,width [,color [,style]]])
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Paramètres</title>
        <variablelist>
            <varlistentry>
                <term>h</term>
                <listitem>
                    <para>un pointeur sur les axes, (par défaut: h=gca() ).</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>y</term>
                <listitem>
                    <para>un scalaire, un vecteur de taille N, ou une matrice de taille N*M</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>x</term>
                <listitem>
                    <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>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>width</term>
                <listitem>
                    <para>(optionnel), un scalaire, définit l'épaisseur des barres (un
                        pourcentage de l'epaisseur maximum autorisé pour une barre), par
                        défaut: 0.8=80%.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>color</term>
                <listitem>
                    <para>(optionnel), une chaine (par défaut: 'blue'), specifiant la
                        couleur intérieur des barres.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>style:</term>
                <listitem>
                    <para>(optionnel), une chaine, 'grouped' or 'stacked' (par défaut:
                        'grouped').
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            <literal>barh(y,...) :</literal> si y est un vecteur alors la fonction barh
            dessine une polyline de type <literal>polyline_style</literal> égale à 6, dans
            ce cas x =1 : length(y). Si y est une matrice de taille N*M, alors la
            fonction bar dessine M polylines de (type 6), chaque polyline correspond à
            une colonne de y est au vecteur x=1:size(y,1).
        </para>
        <para>
            <literal>barh(x,y,...) :</literal> si y est un vecteur alors la fonction barh
            dessine une polyline de type <literal>polyline_style</literal> égale à 6,
            vérifiant: longeur de x length = longeur de y .Si y est une matrice de
            taille N*M, alors la fonction bar dessine M polylines de (type 6), chaque
            polyline correspond à une colonne de y est au vecteur x vérifiant longueur
            de x=size(y,1) (i.e nombre de ligne de y).
        </para>
        <para>
            <literal>barh(h,...) :</literal> definit les axes courants ou le dessin est
            réalisé.
        </para>
        <para>
            <literal>barh(...,width,...) :</literal> definit l'épaisseur des barres en
            pourcentage (générallement: 0&lt;width&lt;=1).
        </para>
        <para>
            <literal>barh(...,style,...) :</literal> dans le cas ou y est une matrice
            l'option style definit la façon dont les barres sont dessinées les unes
            par rapport aux autres. Si y est une matice N*M (donc M polylines de type
            6) alors il y a 2 façons de dessiner ces M barres. l'option 'grouped'
            permet de centrer les M polylines par rapport aux abscisses (i.e par
            rapport à chaque composantes de x), et l'option 'stacked' permet de les
            empiler.
        </para>
        <para>
            <literal>barh(...,color,...) : </literal>definit la couleur des barres. La
            fonction bar utilise la meme colormap que la fonction
            <literal>plot</literal>.
        </para>
        <para>S'il y a plusieurs appels à la fonction barh, la fonction
            <literal>barhomogenize</literal> permet d'homogénéiser l'épaisseur et le style
            de toutes les barres (i.e les polylines de type 6) inclus dans les axes
            courrants.
        </para>
    </refsection>
    <refsection>
        <title>Exemples</title>
        <programlisting role="example"><![CDATA[
// Premier exemple : dessine juste une barre, width=0.5, color='yellow', par défaut x=1:length(y)
scf(0);
y=[1 -3 5];
barh(y,0.5,'yellow');
 ]]></programlisting>

        <scilab:image>
            y=[1 -3 5];
            barh(y,0.5,'yellow');
        </scilab:image>
        <programlisting role="example"><![CDATA[
// Deuxième exemple : par défaut style='grouped'
scf(1);
x=[1 2 5];
y=[1  -5 6;3 -2 7;4  -3 8];
barh(x,y);
 ]]></programlisting>

        <scilab:image>
            x=[1 2 5];
            y=[1  -5 6;3 -2 7;4  -3 8];
            barh(x,y);
        </scilab:image>
        <programlisting role="example"><![CDATA[
// Troisième exemple : dessine 3 barres (nombre de colonnes de y) style='stacked'.
scf(2);
x=[1 2 5];
y=[1 4 7;2 5 8;3 6  9];
barh(x,y,'stacked');
 ]]></programlisting>

        <scilab:image>
            x=[1 2 5];
            y=[1 4 7;2 5 8;3 6  9];
            barh(x,y,'stacked');
        </scilab:image>
        <programlisting role="example"><![CDATA[
// Quatrième exemple; width=0.2;color='green'; par défaut style='grouped'
scf(3);
x=[1 2 5];
y=[1 4 7;2 5 8;3 6 9];
barh(x,y,0.2,'green');
 ]]></programlisting>
        <scilab:image>
            x=[1 2 5];
            y=[1 4 7;2 5 8;3 6 9];
            barh(x,y,0.2,'green');
        </scilab:image>
    </refsection>
    <refsection role="see also">
        <title>Voir aussi</title>
        <simplelist type="inline">
            <member>
                <link linkend="bar">bar</link>
            </member>
            <member>
                <link linkend="barhomogenize">barhomogenize</link>
            </member>
            <member>
                <link linkend="plot">plot</link>
            </member>
            <member>
                <link linkend="polyline_properties">polyline_properties</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
