* Bug #13066 fixed - Graphics doc: fix for data_bounds 30/13130/3
Paul BIGNIER [Tue, 12 Nov 2013 10:22:57 +0000 (11:22 +0100)]
Change-Id: Iea6fe96cdc28df7715dce27804ab35a8382d4dba

scilab/CHANGES_5.5.X
scilab/modules/graphics/help/en_US/axes_operations/axes_properties.xml
scilab/modules/graphics/help/pt_BR/axes_operations/axes_properties.xml

index a5d76d2..d993d0e 100644 (file)
@@ -163,6 +163,8 @@ Scilab Bug Fixes
 
 * Bug #13069 fixed - Documentation for %MODELICA_USER_LIBS updated.
 
+* Bug #13066 fixed - data_bounds was not fully documented in axes_properties.
+
 
 Xcos Bug Fixes
 ==============
index b63e776..46b67ad 100644 (file)
                         <varlistentry>
                             <term>data_bounds: </term>
                             <listitem>
-                                <para>This field contains the boundary values for the x,y and z
-                                    coordinates. It is the matrix
-                                    <literal>[xmin,ymin,zmin;xmax,ymax,zmax]</literal> or
-                                    <literal>[xmin,ymin;xmax,ymax]</literal>. Note that, to stricly have the
+                                <para>This field contains the boundary values for the x, y and z
+                                    coordinates. It is either the matrix or the vector
+                                    <literal>[xmin,ymin; xmax,ymax]</literal>,
+                                    <literal>[xmin,ymin,zmin; xmax,ymax,zmax]</literal>,
+                                    <literal>[xmin,xmax,ymin,ymax]</literal>,
+                                    <literal>[xmin,xmax,ymin,ymax,zmin,zmax]</literal>,
+                                    <literal>[xmin;xmax;ymin;ymax]</literal> or
+                                    <literal>[xmin;xmax;ymin;ymax;zmin;zmax]</literal>. Note that, to stricly have the
                                     specified data bounds, <literal>tight_limits</literal> must be set to
                                     <literal>"on"</literal> value (see above).
                                     To manually set data_bounds set <literal>auto_scale="off"</literal>
index e03bd94..7b4b935 100644 (file)
@@ -2,11 +2,11 @@
 <!--
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
  * Copyright (C) INRIA - Djalel Abdemouche
- * 
+ *
  * This file must be used under the terms of the CeCILL.
  * This source file is licensed as described in the file COPYING, which
  * you should have received as part of this distribution.  The terms
- * are also available at    
+ * are also available at
  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
  *
  -->
@@ -63,7 +63,7 @@
                                     <literal>"off"</literal> . (desligado). Por padrão, os eixos
                                     são visíveis, <literal>"on"</literal> , caso todos os galhos
                                     visíveis sejam exibidos na tela. Se <literal>"off"</literal> ,
-                                    os eixos e seus galhos não são esboçados. 
+                                    os eixos e seus galhos não são esboçados.
                                 </para>
                             </listitem>
                         </varlistentry>
                                     <literal>"on"</literal>, a direção é invertida. Também é
                                     possível utilizar apenas um string, <literal>"on"</literal> ou
                                     <literal>"off"</literal>, para ajustar simultaneamente os três
-                                    dados. 
+                                    dados.
                                 </para>
                             </listitem>
                         </varlistentry>
                                     <literal>y-grid, z-grid</literal> respectivamente para os
                                     eixos y e z. O valor padrão é <literal>-1</literal>, os grides
                                     não são desenhados, caso contrário, os grides são desenhados
-                                    utilizando a cor dada indexada pelo valor do grid. 
+                                    utilizando a cor dada indexada pelo valor do grid.
                                 </para>
                             </listitem>
                         </varlistentry>
                                     <listitem>
                                         <para>
                                             <literal>"bottom"</literal>. Neste caso, o eixo y é
-                                            desenhado na parte direita do retângulo de eixos. 
+                                            desenhado na parte direita do retângulo de eixos.
                                         </para>
                                     </listitem>
                                     <listitem>
                                         <para>
                                             <literal>"top"</literal>. Neste caso, o eixo y é
-                                            desenhado na parte esquerda do retângulo de eixos. 
+                                            desenhado na parte esquerda do retângulo de eixos.
                                         </para>
                                     </listitem>
                                     <listitem>
                                         <para>
                                             <literal>"middle"</literal> . Neste caso, o eixo y é
                                             desenhado na posição mais próxima da coordenada 0 do eixo
-                                            x. 
+                                            x.
                                         </para>
                                     </listitem>
                                 </itemizedlist>
                                         <para>
                                             <literal>"middle"</literal>. Neste caso, o eixo y é
                                             desenhado na posição mais próxima da coordenada 0 do eixo
-                                            x. 
+                                            x.
                                         </para>
                                     </listitem>
                                 </itemizedlist>
                             <listitem>
                                 <para>um objeto anexado à entidade de eixos que retorna um
                                     manipulador gráfico de uma estrutura label (rótulo) (ver <link linkend="label_properties">label_properties</link>). Este
-                                    campo define um título com opções sobre este label. 
+                                    campo define um título com opções sobre este label.
                                 </para>
                             </listitem>
                         </varlistentry>
                                 <para> um objeto anexado à entidade de eixos que retorna um
                                     manipulador gráfico de uma estrutura label (ver <link linkend="label_properties">label_properties</link>). Este
                                     campo define um label sobre o eixo x com opções sobre este
-                                    label. 
+                                    label.
                                 </para>
                             </listitem>
                         </varlistentry>
                                 <para> um objeto anexado à entidade de eixos que retorna um
                                     manipulador gráfico de uma estrutura label (ver <link linkend="label_properties">label_properties</link>). Este
                                     campo define um label sobre o eixo y com opções sobre este
-                                    label. 
+                                    label.
                                 </para>
                             </listitem>
                         </varlistentry>
                                 <para>um objeto anexado à entidade de eixos que retorna um
                                     manipulador gráfico de uma estrutura label (ver <link linkend="label_properties">label_properties</link>). Este
                                     campo define um label sobre o eixo z com opções sobre este
-                                    label. 
+                                    label.
                                 </para>
                             </listitem>
                         </varlistentry>
                                     <literal>x_ticks, y_ticks</literal> ou
                                     <literal>z_ticks</literal> ajusta automaticamente
                                     <literal>auto_ticks</literal> para <literal>"off"</literal>
-                                    para os eixos correspondentes. 
+                                    para os eixos correspondentes.
                                 </para>
                             </listitem>
                         </varlistentry>
                                     outras. Os valores podem ser <literal>"on" </literal> ou
                                     <literal>"off"</literal> (que é o valor padrão). Na maior
                                     parte dos casos, ajuda a gerar uma visualização 3d semelhante
-                                    a do Matlab. 
+                                    a do Matlab.
                                 </para>
                             </listitem>
                         </varlistentry>
                                 <para>
                                     este campo é o vetor <literal>[alpha,theta]</literal>.
                                     Estes dois valores fornecem as coordenadas esféricas de
-                                    obsevação (em graus). 
+                                    obsevação (em graus).
                                 </para>
                             </listitem>
                         </varlistentry>
                                     logarítmica) o longo dos eixos. Cada caractere especifica a
                                     escala para os eixos x, y e z respectivamente. Os valores
                                     podem ser <literal>'n'</literal> para escala linear ou
-                                    <literal>'l'</literal> para escala logarítmica. 
+                                    <literal>'l'</literal> para escala logarítmica.
                                 </para>
                             </listitem>
                         </varlistentry>
                                     se adaptam para se encaixarem dentro dos valores máximos e
                                     mínimos de <literal>data_bounds</literal>. Se o campo for
                                     <literal>"off"</literal>, os eixos podem aumentar os limites
-                                    de modo a produzir rótulos de tiques convenientes. 
+                                    de modo a produzir rótulos de tiques convenientes.
                                 </para>
                             </listitem>
                         </varlistentry>
                             <term>data_bounds:</term>
                             <listitem>
                                 <para> este campo contém os valores de limite para as
-                                    coordenadas x,y e z. É a matriz
-                                    <literal>[xmin,ymin,zmin;xmax,ymax,zmax]</literal> ou
-                                    <literal>[xmin,ymin;xmax,ymax]</literal>. Note que, para ter
+                                    coordenadas x,y e z. É a matriz ou vector
+                                    <literal>[xmin,ymin; xmax,ymax]</literal>,
+                                    <literal>[xmin,ymin,zmin; xmax,ymax,zmax]</literal>,
+                                    <literal>[xmin,xmax,ymin,ymax]</literal>,
+                                    <literal>[xmin,xmax,ymin,ymax,zmin,zmax]</literal>,
+                                    <literal>[xmin;xmax;ymin;ymax]</literal> ou
+                                    <literal>[xmin;xmax;ymin;ymax;zmin;zmax]</literal>. Note que, para ter
                                     estritamente os limites de dados especificados,
                                     <literal>tight_limits</literal> deve ser ajustado para
-                                    <literal>"on"</literal> (ver acima). 
+                                    <literal>"on"</literal> (ver acima).
                                 </para>
                             </listitem>
                         </varlistentry>
                                 <para>esta propriedade controla as cores das partes
                                     escondidas. Toma como valor um índice relativo ao mapa de
                                     cores corrente. Em outro caso, se for um valor negativo, as
-                                    partes escondidas tomam a mesma cor que a superfície. 
+                                    partes escondidas tomam a mesma cor que a superfície.
                                 </para>
                             </listitem>
                         </varlistentry>
                                     exibida. Seu valor deve ser um inteiro no intervalo [0 9] que
                                     significa: ponto, sinal de mais, cruz, estrela, diamante
                                     preenchido, diamante, triângulo para cima, triângulo para
-                                    baixo, trevo ou círculo. 
+                                    baixo, trevo ou círculo.
                                 </para>
                             </listitem>
                         </varlistentry>
                                     corrente. Note que o valor padrão é <literal>-2</literal>
                                     (branco padrão) e, mesmo que você mude o
                                     <literal>color_map</literal>, este valor <literal>-2</literal>
-                                    sempre apontará para a cor branca padrão. 
+                                    sempre apontará para a cor branca padrão.
                                 </para>
                             </listitem>
                         </varlistentry>
                                     relativo ao mapa de cores corrente. Note que o valor padrão é
                                     <literal>-2</literal> branco padrão) e mesmo que você mude o
                                     <literal>color_map</literal>, este valor <literal>-2</literal>
-                                    sempre apontará para a cor branca padrão. 
+                                    sempre apontará para a cor branca padrão.
                                 </para>
                             </listitem>
                         </varlistentry>
                                         <para>
                                             <literal>"off"</literal> isto indica todos os
                                             objetos criados depois que não estão recortados (valor
-                                            padrão). 
+                                            padrão).
                                         </para>
                                     </listitem>
                                     <listitem>
                                         <para>
                                             <literal>"clipgrf"</literal> isto indica todos os
                                             objetos criados depois que estão recortados fora das
-                                            fronteiras dos eixos. 
+                                            fronteiras dos eixos.
                                         </para>
                                     </listitem>
                                     <listitem>
                                     uma matriz vazia se clip_state for <literal>"off"</literal>.
                                     Em outro caso, o recorte é dado por
                                     <literal>[x,y,w,h]</literal> (ponto superior esquerdo,
-                                    largura, altura). 
+                                    largura, altura).
                                 </para>
                             </listitem>
                         </varlistentry>
     </refsection>
     <refsection>
         <title>Exemplos</title>
-        <programlisting role="example"><![CDATA[ 
+        <programlisting role="example"><![CDATA[
 lines(0) // desabilitando o paginamento vertical
 a=get("current_axes")//obtendo o manipulador dos novos eixos criados
 a.axes_visible="on"; // tornando os eixos visíveis
@@ -855,7 +859,7 @@ a.sub_tics=[5,0];
 a.labels_font_color=5;
 a.grid=[2,2];
 a.box="off";
-   
+
 // exemplo com eixos 3d
 clf(); //limpando a janela de gráficos
 x=0.1:0.1:2*%pi;plot2d(x-.3,sin(x)*7+.2);
@@ -864,7 +868,7 @@ a.grid=[1 -1 -1]; //make x-grid
 a.rotation_angles=[70 250]; //girando eixos com ângulos dados
 a.grid=[1 6 -1]; //criando y-grid
 a.view="2d"; //retornando a vista 2d
-a.box="back_half"; 
+a.box="back_half";
 a.labels_font_color=5;
 a.children.children.thickness=4;
 a.children.children.polyline_style=3;
@@ -886,7 +890,7 @@ a.labels_font_size=4;
 a.parent.background=8;
 a.parent.figure_size= [400,200];
 a.rotation_angles=[0 260];
-delete(a.children(2)); 
+delete(a.children(2));
 delete(); // deletando objeto corrente
 
 a = gca();
@@ -898,7 +902,7 @@ a.data_bounds(:,1) = [1;15] ; // ajustando limites positivos para o eixo x
 a.log_flags = "lnn" ; // ajustando o eixo X para escala logarítmica
 a.log_flags = "nnn" ; // voltando para escala linear
 
-a=gca(); 
+a=gca();
 a.rotation_angles=[45 45];
 a.data_bounds=[-20,-3,-2;20 3 ,2];
 xrect([-4 0.5 8 1]);
@@ -915,10 +919,10 @@ xsegs(10*xv,yv,1:8)
 s=a.children(1);
 s.arrow_size=1;
 s.segs_color=5;
-a.data_bounds //os valores limites para as coordenadas x,y e z 
+a.data_bounds //os valores limites para as coordenadas x,y e z
 a.view="2d";
 a.data_bounds=[-10,-1; 10,1]; // ajustando os valores limites para vistas bidimensionais
-   
+
 // exemplo com eixos modelos
 da=gda() // obtendo manipulador dos eixo modelos para ver e editar campos
 // título padrão