766074915a7552e7575faa00ae0cad74e787ab2e
[scilab.git] / scilab / modules / graphics / help / pt_BR / axis / drawaxis.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) ENPC - Jean-Philippe Chancelier
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:ns3="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="drawaxis" xml:lang="pt">
17     <refnamediv>
18         <refname>drawaxis</refname>
19         <refpurpose>Desenha um eixo</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Seqüência de Chamamento</title>
23         <synopsis>drawaxis([options])
24             // opções:  x,y,dir,sub_int,fontsize,format_n,seg,textcolor,ticscolor,tics
25         </synopsis>
26     </refsynopsisdiv>
27     <refsection>
28         <title>Parâmetros</title>
29         <variablelist>
30             <varlistentry>
31                 <term>dir=string</term>
32                 <listitem>
33                     <para>é utilizado para se especificar a direção dos tiques.
34                         <literal>string</literal> can pode ser escolhido entre
35                         'u','r','d','l' e 'l' é o valor padrão. Os valores 'u','r','d','l'
36                         correspondem respectivamente a "para cima", "para direita", "para
37                         baixo" e "para esquerda".
38                     </para>
39                 </listitem>
40             </varlistentry>
41             <varlistentry>
42                 <term>tics=string</term>
43                 <listitem>
44                     <para>um flag definindo como os tiques são fornecidos.
45                         <literal>string</literal> pode ser escolhido entre 'v','r' e 'i', e
46                         , 'v' é o valor padrão.
47                     </para>
48                 </listitem>
49             </varlistentry>
50             <varlistentry>
51                 <term>x,y</term>
52                 <listitem>
53                     <para>dois vetores que fornecem as posições dos tiques.</para>
54                 </listitem>
55             </varlistentry>
56             <varlistentry>
57                 <term>val= string matrix</term>
58                 <listitem>
59                     <para>uma matriz de strings que, quando dada, fornece os strings a
60                         serem impressos ao longo dos eixos nas posições dos tiques.
61                     </para>
62                 </listitem>
63             </varlistentry>
64             <varlistentry>
65                 <term>fontsize=int</term>
66                 <listitem>
67                     <para>especifica o tamanho de fonte a ser utilizado para se exibir
68                         os valores ao longo dos eixos. O valor padrão é
69                         <literal>-1</literal> que corresponde ao tamanho de fonte
70                         atual
71                     </para>
72                 </listitem>
73             </varlistentry>
74             <varlistentry>
75                 <term>format_n=string</term>
76                 <listitem>
77                     <para>formato a ser utilizado para se exibir os números ao longo dos
78                         eixos
79                     </para>
80                 </listitem>
81             </varlistentry>
82             <varlistentry>
83                 <term>seg= 1 ou 0</term>
84                 <listitem>
85                     <para>um flag que controla a exibição do segmento base do eixo (o
86                         valor padrão é 1).
87                     </para>
88                 </listitem>
89             </varlistentry>
90             <varlistentry>
91                 <term>sub_int=integer</term>
92                 <listitem>
93                     <para>um inteiro que fornece o número de subintervalos entre dois
94                         tiques maiores.
95                     </para>
96                 </listitem>
97             </varlistentry>
98             <varlistentry>
99                 <term>textcolor=integer</term>
100                 <listitem>
101                     <para>especifica a cor a ser utilizada para a exibição de valores ao
102                         longo dos eixos. O valor padrão é <literal>-1</literal>, que
103                         corresponde a cor corrente.
104                     </para>
105                 </listitem>
106             </varlistentry>
107             <varlistentry>
108                 <term>ticscolor=integer</term>
109                 <listitem>
110                     <para>especifica a cor a ser utilizada para o desenho dos tiques. O
111                         valor padrão é <literal>-1</literal>, que corresponde à cor
112                         corrente.
113                     </para>
114                 </listitem>
115             </varlistentry>
116         </variablelist>
117     </refsection>
118     <refsection>
119         <title>Descrição</title>
120         <para>
121             <literal>drawaxis</literal> é utilizado para desenhar um eixo na
122             direção horizontal ou vertical. A direção do eixo é dada por dir.
123             <literal>dir = 'u'</literal> ou <literal>'d'</literal> fornece a direção
124             com os tiques indo para cima (<literal>'u'</literal>) ou para baixo
125             (<literal>'d'</literal>). <literal>dir = 'r'</literal> ou
126             <literal>'l'</literal> fornece um eixo vertical com os tiques indo para a
127             direita (<literal>'r'</literal>) ou esquerda
128             (<literal>'l'</literal>).
129         </para>
130         <para>
131             <literal>x</literal> e <literal>y</literal> fornecem as posições dos
132             tiques dos eixos. Se o eixo é horizontal, então <literal>y</literal> deve
133             ser um escalar, ou pode ser omitido, e <literal>x</literal> é um vetor
134             Scilab. O significado de <literal>x</literal> é controlado por
135             <literal>tics</literal>.
136         </para>
137         <para>
138             Se <literal>tics='v'</literal> então <literal>x</literal> fornece as
139             posições dos tiques ao longo do eixo x.
140         </para>
141         <para>
142             Se <literal>tics='r'</literal> então <literal>x</literal> deve ter
143             tamanho 3. <literal>x=[xmin,xmax,n]</literal> e <literal>n</literal>
144             fornece o número de intervalos.
145         </para>
146         <para>
147             Se <literal>tics='i'</literal> então <literal>x</literal> deve ser
148             de tamanho 4, <literal>x=[k1,k2,a,n]</literal>. Então
149             <literal>xmin=k1*10^a</literal>, <literal>xmax=k2*10^a</literal> e
150             <literal>n</literal> fornece o número de intervalos.
151         </para>
152         <para>
153             Se <literal>y</literal> for omitido, então o eixo será posicionado
154             ao topo da moldura se <literal>dir='u'</literal> ou ao fundo se
155             <literal>dir='d'</literal>
156         </para>
157         <para>Por padrão, os números são impressos ao longo do eixo. Eles são
158             impressos utilizando-se um formato padrão que pode ser alterado através de
159             <literal>format_n</literal>. ITambém é possível exibir strings dados, e
160             não números, isto é feito se <literal>val</literal> é fornecido. O tamanho
161             de <literal>val</literal> deve corresponder ao número de tiques.
162         </para>
163     </refsection>
164     <refsection>
165         <title>Exemplos</title>
166         <programlisting role="example"><![CDATA[
167 plot2d(1:10,1:10,1,"020")
168 // eixo horizontal
169 drawaxis(x=2:7,y=4,dir='u',tics='v')
170 // eixo horizontal na parte superior da moldura
171 drawaxis(x=2:7,dir='u',tics='v')
172 // eixo horizontal na parte inferior da moldura
173 drawaxis(x=2:7,dir='d',tics='v')
174
175 // eixo horizontal dado por um intervalo
176 drawaxis(x=[2,7,3],y=4,dir='d',tics='r')
177
178 // eixo vertical
179 drawaxis(x=4,y=2:7,dir='r',tics='v')
180 drawaxis(x=2,y=[2,7,3],dir='l',tics='r')
181 drawaxis(y=2:7,dir='r',tics='v')
182 drawaxis(y=2:7,dir='l',tics='v')
183
184 // eixo horizontal com strings exibidos nas posições dos tiques
185 drawaxis(x=2:7,y=8,dir='u',tics='v',val='A'+string(1:6));
186 // eixo vertical com strings exibidos nas posições dos tiques
187 drawaxis(x=8,y=2:7,dir='r',tics='v',val='B'+string(1:6));
188
189 // eixo horizontal dado com um intervalo 'i'.
190 drawaxis(x=[2,5,0,3],y=9,dir='u',tics='i');
191 drawaxis(x=9,y=[2,5,0,3],dir='r',tics='i',sub_int=5);
192
193 // eixo horizontal de novo
194 drawaxis(x=2:7,y=4,dir='u',tics='v',fontsize=10,textcolor=9,ticscolor=7,seg=0,sub_int=20)
195  ]]></programlisting>
196     </refsection>
197 </refentry>