<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) INRIA - Farid Belahcene
 *
 * 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="fr" xml:id="barhomogenize">
    <refnamediv>
        <refname>barhomogenize</refname>
        <refpurpose>uniformise le style des barres dessinées dans un repère graphique</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Séquence d'appel</title>
        <synopsis>
            barhomogenize()
            barhomogenize(h)
            barhomogenize([h,] style)
            barhomogenize([h,] width)
            barhomogenize([h,] style, width)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Paramètres</title>
        <variablelist>
            <varlistentry>
                <term>h</term>
                <listitem>
                    <para>identifiant d'un repère graphique (gca() par défaut).</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>style</term>
                <listitem>
                    <para>une chaine, <literal>'grouped'</literal> (par défaut), ou
                        <literal>'stacked'</literal>.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>width</term>
                <listitem>
                    <para>nombre décimal <literal>0 &lt; width &lt;= 1</literal> : définit la
                        largeur des barres, = fraction de la largeur maximale autorisée.
                        Par défaut: width=0.8.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>S'il y a plusieurs appels à la fonction bar(), la fonction
            <literal>barhomogenize</literal> permet d'homogénéiser l'epaisseur et le style
            de toutes les barres (i.e de type <literal>polyline_style</literal> 6) contenues
            dans le repère graphique actif. Ces barres doivent avoir les meme abscisses (x
            data).
        </para>
        <para>
            <literal>barhomogenize( )</literal> prends les valeurs suivantes par
            défaut: <literal>h=gca(), width=0.8, style='grouped'</literal>.
        </para>
        <para>
            <literal>barhomogenize(h,...)</literal> définit le repère graphique dans
            lequel la fonction doit être appliquée.
        </para>
        <para>
            <literal>barhomogenize(...,style,...)</literal> définit la façon dont les
            barres sont positionnées les unes par rapport aux autres. L'option style
            fixée à 'grouped' permet de centrer les polylines par rapport à leurs
            abscisses, et l'option style fixée à 'stacked' permet de les empiler.
        </para>
        <para>
            <literal>barhomogenize(...,width)</literal> définit l'épaisseur des
            barres, en pourcentage (généralement : 0&lt;width&lt;=1).
        </para>
    </refsection>
    <refsection>
        <title>Exemples</title>
        <para>
        <emphasis role="bold">Exemple n°1 :</emphasis> creation d'une barre jaune (i.e une polyline
        de type polyline_style=6), et de 3 barres(i.e 3 polylines de type polyline_style=6)
        </para>
        <programlisting role="example"><![CDATA[
            subplot(2,3,1)
            xtitle('ex1: creation of 1 yellow bar and 3 bars')
            x=1:3;
            y1=1:3;
            y2=[4 3 5;6 7 8;9 10 11];
            bar(x,y1,'yellow');bar(x,y2);

            // homogeneisation des 4 barres avec l'option style fixée à 'grouped' (par défaut)
            subplot(2,3,2)
            xtitle('grouped homogenization')
            x=1:3;
            y1=1:3;
            y2=[4 3 5;6 7 8;9 10 11];
            bar(x,y1,'yellow');bar(x,y2);
            barhomogenize();

            // homogeneisation des 4 barres avec l'option style fixée à 'stacked'
            subplot(2,3,3)
            xtitle('stacked homogenization')
            x=1:3; y1=1:3; y2=[4 3 5;6 7 8;9 10 11];
            bar(x,y1,'yellow');bar(x,y2);
            barhomogenize('stacked',1);
]]></programlisting>
        <scilab:image>
            gcf().axes_size = [800 270];
            subplot(1,3,1)
            xtitle('ex1: creation of 1 yellow bar and 3 bars')
            x=1:3;
            y1=1:3;
            y2=[4 3 5;6 7 8;9 10 11];
            bar(x,y1,'yellow');bar(x,y2);

            subplot(1,3,2)
            xtitle('grouped homogenization')
            x=1:3;
            y1=1:3;
            y2=[4 3 5;6 7 8;9 10 11];
            bar(x,y1,'yellow');bar(x,y2);
            barhomogenize();

            subplot(1,3,3)
            xtitle('stacked homogenization')
            x=1:3; y1=1:3; y2=[4 3 5;6 7 8;9 10 11];
            bar(x,y1,'yellow');bar(x,y2);
            barhomogenize('stacked',1);
        </scilab:image>
        <para>
            <emphasis role="bold">Exemple n°2 :</emphasis> creation d'une barre (polyline de type
            polyline_style=6, avec un appel à la fonction bar), et deux polylines (2 polylines de
            type polyline_style=1, avec un appel à la fonction plot).
        </para>
        <programlisting role="example"><![CDATA[
            subplot(2,3,4)
            xtitle('ex2: creation of 1 bar and 2 polylines')
            x=1:10;
            y=sin(x)/2;
            bar(x,y,'red')
            x1=1:10;
            y1=[sin(x);cos(x)]
            plot(x1',y1')

            // Modification du type polyline_style à 6 de la deuxième polyline construite
            //  par plot (cette polyline devient une barre)
            subplot(2,3,5)
            xtitle('transformation of the second polyline to bar')
            x=1:10;
            y=sin(x)/2;
            bar(x,y,'red')
            x1=1:10;
            y1=[sin(x);cos(x)]
            plot(x1',y1')
            e=gce();
            e2=e.children(2);
            e2.polyline_style=6;

            // Homogénéisation de la première barre (construite par appel à la fonction bar)
            //  et de la deuxième barre (issue de la modification).
            subplot(2,3,6)
            xtitle('grouped homogenization')
            x=1:10;
            y=sin(x)/2;
            bar(x,y,'red')
            x1=1:10;
            y1=[sin(x);cos(x)]
            plot(x1',y1')
            e=gce();
            e2=e.children(2);
            e2.polyline_style=6;
            barhomogenize();
            // change the style and the width
            //barhomogenize('stacked',0.5);
            //barhomogenize('stacked',1);
 ]]></programlisting>
        <scilab:image>
            gcf().axes_size = [800 270];
            // Second example : creation of 1 red bar (i.e 1 polyline with polyline_style=6)
            //  and 2 polylines with type=1 (calling plot function)
            subplot(1,3,1)
            xtitle('ex2: creation of 1 bar and 2 polylines')
            x=1:10;
            y=sin(x)/2;
            bar(x,y,'red')
            x1=1:10;
            y1=[sin(x);cos(x)]
            plot(x1',y1')

            // modify the polyline_style type of the second polyline from plot (this polyline becomes a bar)
            subplot(1,3,2)
            xtitle('transformation of the second polyline to bar')
            x=1:10;
            y=sin(x)/2;
            bar(x,y,'red')
            x1=1:10;
            y1=[sin(x);cos(x)]
            plot(x1',y1')
            e=gce();
            e2=e.children(2);
            e2.polyline_style=6;

            // homogenization of the first bar (from bar function) and second bar (from the modification).
            subplot(1,3,3)
            xtitle('grouped homogenization')
            x=1:10;
            y=sin(x)/2;
            bar(x,y,'red')
            x1=1:10;
            y1=[sin(x);cos(x)]
            plot(x1',y1')
            e=gce();
            e2=e.children(2);
            e2.polyline_style=6;
            barhomogenize();
            // change the style and the width
            //barhomogenize('stacked',0.5);
            //barhomogenize('stacked',1);
        </scilab:image>
    </refsection>
    <refsection role="see also">
        <title>Voir aussi</title>
        <simplelist type="inline">
            <member>
                <link linkend="bar">bar</link>
            </member>
            <member>
                <link linkend="histplot">histplot</link>
            </member>
            <member>
                <link linkend="polyline_properties">polyline_properties</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
