Help reformat: use docbook elements
[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"
17           xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml"
18           xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook"
19           xmlns:scilab="http://www.scilab.org" xml:id="bar" xml:lang="pt">
20     <refnamediv>
21         <refname>bar</refname>
22         <refpurpose>Histograma de barras</refpurpose>
23     </refnamediv>
24     <refsynopsisdiv>
25         <title>Seqüência de Chamamento</title>
26         <synopsis>
27             bar(x, y)
28             bar(x, y [,width [,color [,style]]])
29             bar(h, x, y ..)
30         </synopsis>
31     </refsynopsisdiv>
32     <refsection>
33         <title>Parâmetros </title>
34         <variablelist>
35             <varlistentry>
36                 <term>h</term>
37                 <listitem>
38                     <para>manipulador de eixos, (padrão: h=gca() ). </para>
39                 </listitem>
40             </varlistentry>
41             <varlistentry>
42                 <term>y</term>
43                 <listitem>
44                     <para>escalar real, vetor de tamanho N ou uma matriz NxM.</para>
45                 </listitem>
46             </varlistentry>
47             <varlistentry>
48                 <term>x</term>
49                 <listitem>
50                     <para>escalar real ou um vetor de tamanho N, (padrão: se y é um
51                         vetor, então x is é um vetor e o comprimento de x é igual ao
52                         comprimento de y. Se y é uma matriz, então x é um vetor e o
53                         comprimento de x é igual ao número de linhas de y)
54                     </para>
55                 </listitem>
56             </varlistentry>
57             <varlistentry>
58                 <term>width</term>
59                 <listitem>
60                     <para>(opcional), escalar real, define a largura (uma porcentagem do
61                         espaço disponível) para a barra (padrão: 0.8, i.e 80%).
62                     </para>
63                 </listitem>
64             </varlistentry>
65             <varlistentry>
66                 <term>color</term>
67                 <listitem>
68                     <para>(opcional) the color filling bars, specified by its literal name among
69                         predefined ones, or by its "#RRGGBB" hexadecimal code. Padrão: 'blue')
70                     </para>
71                 </listitem>
72             </varlistentry>
73             <varlistentry>
74                 <term>style:</term>
75                 <listitem>
76                     <para>string, 'grouped' ou 'stacked' (padrão: 'grouped').</para>
77                 </listitem>
78             </varlistentry>
79         </variablelist>
80     </refsection>
81     <refsection>
82         <title>Descrição</title>
83         <para>
84             <literal>bar(y,...) :</literal> se y é um vetor então a função bar
85             desenha uma poligonal que tem <literal>polyline_style</literal> tipo 6. Se
86             y for um vetor, desenha o vetor y versus o vetor 1:size(y,'*') . Se y for
87             uma matriz N*M, bar desenha M poligonais (tipo 6), cada poligonal
88             corresponde a uma coluna de y versus o vetor x=1:size(y,1).
89         </para>
90         <para>
91             <literal>bar(x,y,...) :</literal> se y for um vetor, então a função
92             bar desenha uma poligonal que tem <literal>polyline_style</literal> tipo
93             6, onde comprimento de x = comprimento de y. Se y é uma matriz NxM então a
94             função bar desenha M poligonais que possuem tipo 6. Cada poligonal
95             corresponde a uma coluna de y versus o vetor x.
96         </para>
97         <para>
98             <literal>bar(h,...) :</literal> define os eixos correntes onde o
99             desenho é feito.
100         </para>
101         <para>
102             <literal>bar(...,width,...) :</literal> define a largura da(s)
103             barra(s) em porcentagem (geralmente: 0&lt;width&lt;=1).
104         </para>
105         <para>
106             <literal>bar(...,style,...) :</literal> define como as barras serão
107             desenhadas. Se y é uma matriz NxM (então temos M poligonais de tipo 6),
108             então há dois modos de se desenhar as M barras. A opção style= 'grouped'
109             permite centrar as M poligonais versus cada componente de x, e a opção
110             style = 'stacked' permite empilhá-las.
111         </para>
112         <para>
113             <literal>bar(...,color,...) : </literal>define a cor da barra.
114         </para>
115         <para>Se há várias chamadas a bar(), a função
116             <literal>barhomogenize</literal> permite homogeneizar a largura e estilo
117             de todas as barras (i.e poligonais do tipo 6) inclusas nos eixos
118             correntes.
119         </para>
120     </refsection>
121     <refsection>
122         <title>Exemplos</title>
123         <programlisting role="example"><![CDATA[
124 // primeiro exemplo: desenhando uma barra (i.e uma poligonal com polyline_style =6) com
125 // width=0.5 e color='yellow' e style='grouped', x=1:length(y).
126 scf(0);
127 y=[1 -3 5];
128 bar(y,0.5,'yellow');
129
130 // segundo exemplo: desenhando 3 barras (i.e três poligonais com polyline_style =6), style='grouped'
131 scf(1);
132 x=[1 2 5]; y=[1  -5 6;3 -2 7;4  -3 8];
133 bar(x,y);
134
135 // terceiro exemplo: style='stacked'.
136 scf(2);
137 x=[1 2 5]; y=[1 4 7;2 5 8;3 6  9];
138 bar(x,y,'stacked');
139
140 // quarto exemplo: width=0.2;color='green', 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     </refsection>
146     <refsection role="see also">
147         <title>Ver Também</title>
148         <simplelist type="inline">
149             <member>
150                 <link linkend="barh">barh</link>
151             </member>
152             <member>
153                 <link linkend="barhomogenize">barhomogenize</link>
154             </member>
155             <member>
156                 <link linkend="histplot">histplot</link>
157             </member>
158             <member>
159                 <link linkend="plot">plot</link>
160             </member>
161             <member>
162                 <link linkend="color_list">named colors</link>
163             </member>
164             <member>
165                 <link linkend="polyline_properties">polyline_properties</link>
166             </member>
167         </simplelist>
168     </refsection>
169     <refsection role="history">
170         <title>Histórico</title>
171         <revhistory>
172             <revision>
173                 <revnumber>6.0.1</revnumber>
174                 <revdescription>
175                     color is no longer restricted to the 10 major colors: It can now be any of the
176                     numerous predefined Scilab color names. Moreover, it can now be specified by
177                     its "#RRGGBB" hexadecimal code.
178                 </revdescription>
179             </revision>
180         </revhistory>
181     </refsection>
182 </refentry>