ba5745ebc40e9366580b24dd066b398f235288c7
[scilab.git] / scilab / modules / graphics / help / pt_BR / bar_histogram / bar.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) INRIA - Farid Belahcene
5  *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <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="bar" xml:lang="pt">
17     <refnamediv>
18         <refname>bar</refname>
19         <refpurpose>Histograma de barras</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Seqüência de Chamamento</title>
23         <synopsis>bar(y)
24             bar(x,y)
25             bar([h],x,y [,width [,color [,style]]])
26         </synopsis>
27     </refsynopsisdiv>
28     <refsection>
29         <title>Parâmetros </title>
30         <variablelist>
31             <varlistentry>
32                 <term>h</term>
33                 <listitem>
34                     <para>manipulador de eixos, (padrão: h=gca() ). </para>
35                 </listitem>
36             </varlistentry>
37             <varlistentry>
38                 <term>y</term>
39                 <listitem>
40                     <para>escalar real, vetor de tamanho N ou uma matriz NxM.</para>
41                 </listitem>
42             </varlistentry>
43             <varlistentry>
44                 <term>x</term>
45                 <listitem>
46                     <para>escalar real ou um vetor de tamanho N, (padrão: se y é um
47                         vetor, então x is é um vetor e o comprimento de x é igual ao
48                         comprimento de y. Se y é uma matriz, então x é um vetor e o
49                         comprimento de x é igual ao número de linhas de y)
50                     </para>
51                 </listitem>
52             </varlistentry>
53             <varlistentry>
54                 <term>width</term>
55                 <listitem>
56                     <para>(opcional), escalar real, define a largura (uma porcentagem do
57                         espaço disponível) para a barra (padrão: 0.8, i.e 80%).
58                     </para>
59                 </listitem>
60             </varlistentry>
61             <varlistentry>
62                 <term>color</term>
63                 <listitem>
64                     <para>(opcional), um string (padrão: 'blue'), especificando a cor da
65                         barra.
66                     </para>
67                 </listitem>
68             </varlistentry>
69             <varlistentry>
70                 <term>style:</term>
71                 <listitem>
72                     <para>string, 'grouped' ou 'stacked' (padrão: 'grouped').</para>
73                 </listitem>
74             </varlistentry>
75         </variablelist>
76     </refsection>
77     <refsection>
78         <title>Descrição</title>
79         <para>
80             <literal>bar(y,...) :</literal> se y é um vetor então a função bar
81             desenha uma poligonal que tem <literal>polyline_style</literal> tipo 6. Se
82             y for um vetor, desenha o vetor y versus o vetor 1:size(y,'*') . Se y for
83             uma matriz N*M, bar desenha M poligonais (tipo 6), cada poligonal
84             corresponde a uma coluna de y versus o vetor x=1:size(y,1).
85         </para>
86         <para>
87             <literal>bar(x,y,...) :</literal> se y for um vetor, então a função
88             bar desenha uma poligonal que tem <literal>polyline_style</literal> tipo
89             6, onde comprimento de x = comprimento de y. Se y é uma matriz NxM então a
90             função bar desenha M poligonais que possuem tipo 6. Cada poligonal
91             corresponde a uma coluna de y versus o vetor x.
92         </para>
93         <para>
94             <literal>bar(h,...) :</literal> define os eixos correntes onde o
95             desenho é feito.
96         </para>
97         <para>
98             <literal>bar(...,width,...) :</literal> define a largura da(s)
99             barra(s) em porcentagem (geralmente: 0&lt;width&lt;=1).
100         </para>
101         <para>
102             <literal>bar(...,style,...) :</literal> define como as barras serão
103             desenhadas. Se y é uma matriz NxM (então temos M poligonais de tipo 6),
104             então há dois modos de se desenhar as M barras. A opção style= 'grouped'
105             permite centrar as M poligonais versus cada componente de x, e a opção
106             style = 'stacked' permite empilhá-las.
107         </para>
108         <para>
109             <literal>bar(...,color,...) : </literal>define a cor da barra.
110             Funções de barra utilizam o mesmo mapa de cores que na função
111         </para>
112         <para>Se há várias chamadas a bar, a função
113             <literal>barhomogenize</literal> permite homogeneizar a largura e estilo
114             de todas as barras (i.e poligonais do tipo 6) inclusas nos eixos
115             correntes.
116         </para>
117     </refsection>
118     <refsection>
119         <title>Exemplos</title>
120         <programlisting role="example"><![CDATA[
121 // primeiro exemplo: desenhando uma barra (i.e uma poligonal com polyline_style =6) com
122 // width=0.5 e color='yellow' e style='grouped', x=1:length(y).
123 scf(0);
124 y=[1 -3 5];
125 bar(y,0.5,'yellow');
126
127 // segundo exemplo: desenhando 3 barras (i.e três poligonais com polyline_style =6), style='grouped'
128 scf(1);
129 x=[1 2 5]; y=[1  -5 6;3 -2 7;4  -3 8];
130 bar(x,y);
131
132 // terceiro exemplo: style='stacked'.
133 scf(2);
134 x=[1 2 5]; y=[1 4 7;2 5 8;3 6  9];
135 bar(x,y,'stacked');
136
137 // quarto exemplo: width=0.2;color='green', style='grouped'
138 scf(3);
139 x=[1 2 5]; y=[1 4 7;2 5 8;3 6 9];
140 bar(x,y,0.2,'green');
141  ]]></programlisting>
142     </refsection>
143     <refsection role="see also">
144         <title>Ver Também</title>
145         <simplelist type="inline">
146             <member>
147                 <link linkend="barh">barh</link>
148             </member>
149             <member>
150                 <link linkend="barhomogenize">barhomogenize</link>
151             </member>
152             <member>
153                 <link linkend="plot">plot</link>
154             </member>
155             <member>
156                 <link linkend="histplot">histplot</link>
157             </member>
158             <member>
159                 <link linkend="polyline_properties">polyline_properties</link>
160             </member>
161         </simplelist>
162     </refsection>
163 </refentry>