<?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:ns5="http://www.w3.org/1999/xhtml"
        xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
        xmlns:scilab="http://www.scilab.org" xml:id="barhomogenize" xml:lang="pt">
    <refnamediv>
        <refname>barhomogenize</refname>
        <refpurpose>
            Homogeniza todas as barras inclusas nos eixos correntes
        </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Seqüência de Chamamento</title>
        <synopsis>
            barhomogenize()
            barhomogenize(h)
            barhomogenize([h,] style)
            barhomogenize([h,] width)
            barhomogenize([h,] style, width)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Parâmetros</title>
        <variablelist>
            <varlistentry>
                <term>h</term>
                <listitem>
                    <para>manipulador de eixos, (padrão: h=gca() ). </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>style</term>
                <listitem>
                    <para>
                        string, <literal>'grouped'</literal> (padrão), ou <literal>'stacked'</literal>
                        .
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>width</term>
                <listitem>
                    <para>escalar real, define a largura (uma porcentagem do
                        espaço disponível) para a barra (padrão: 0.8).
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Descrição</title>
        <para>Se há várias chamadas a bar, a função
            <literal>barhomogenize</literal> permite homogeneizar a largura e estilo
            de todas as barras (i.e que têm <literal>polyline_style</literal> tipo 6)
            inclusas nos eixos correntes. Estas barras devem ter os mesmos dados
            x.
        </para>
        <para>
            <literal>barhomogenize( )</literal> : toma os valores padrões,
            <literal>h=gca(), width=0.8, style='grouped'</literal>.
        </para>
        <para>
            <literal>barhomogenize(h,...)</literal> : define os eixos correntes
            onde o desenho é realizado.
        </para>
        <para>
            <literal>barhomogenize(...,style,...)</literal> : define como as
            barras são desenhadas. A opção <literal>"grouped"</literal> permite centrar as M poligonais
            versus cada componente de x, e a opção <literal>"stacked"</literal> permite
            empilhá-las.
        </para>
        <para>
            <literal>barhomogenize(...,width)</literal> : define a largura
            da(s) barra(s) em porcentagem(geralmente: 0&lt;width&lt;=1).
        </para>
    </refsection>
    <refsection>
        <title>Exemplos</title>
        <para>
            <emphasis role="bold">Primeiro exemplo: </emphasis> criação de uma barra amarela
            (i.e uma poligonal com polyline_style=6) e  três barras (i.e três poligonais com
            polyline_style=6) do esboço).
        </para>
        <programlisting role="example"><![CDATA[
            subplot(2,3,1)
            xtitle('ex1: criação de uma barra amarela e três barras')
            x=1:3; y1=1:3; y2=[4 3 5;6 7 8;9 10 11];
            bar(x,y1,'yellow');bar(x,y2);

            // homogeneização dessas quatro barras
            subplot(2,3,2)
            xtitle('homogenização agrupada')
            x=1:3; y1=1:3; y2=[4 3 5;6 7 8;9 10 11];
            bar(x,y1,'yellow');bar(x,y2);
            barhomogenize();

            // homogenização empilhada dessas quatro barras
            subplot(2,3,3)
            xtitle('homogenização empilhada')
            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">Segundo exemplo: </emphasis>criação de uma barra vermelha (i.e
            uma poligonal com polyline_style=6) e duas poligonais com type=1 (função de chamamento
            do esboço).
        </para>
        <programlisting role="example"><![CDATA[
            subplot(2,3,4)
            xtitle('ex2: criação de uma barra e duas poligonais')
            x=1:10; y=sin(x)/2;
            bar(x,y,'red')
            x1=1:10;y1=[sin(x);cos(x)]
            plot(x1,y1)

            // modificando o polyline_style da segunda poligonal do esboço (esta poligonal se torna em uma barra)
            subplot(2,3,5)
            xtitle('transformação da segunda poligonal em uma barra')
            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;
            // homogenização da primeira barra (da função bar) e da segunda barra (da modificação).
            subplot(2,3,6)
            xtitle('homogeneização em grupo')

            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();
            // mudança de estilo e largura
            //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>
        <title>Ver Também </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>
