13d16a83e06fecaea10d8ae5a2c0d38f8aa2d82b
[scilab.git] / scilab / modules / graphics / help / fr_FR / axis / drawaxis.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="fr" xml:id="drawaxis">
3     <refnamediv>
4         <refname>drawaxis</refname>
5         <refpurpose>dessine un axe  </refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Séquence d'appel</title>
9         <synopsis>
10             drawaxis([options]) // options : x,y,dir,sub_int,fontsize,format_n,seg,textcolor,ticscolor,tics
11             e = drawaxis([options])
12         </synopsis>
13     </refsynopsisdiv>
14     <refsection>
15         <title>Paramètres</title>
16         <variablelist>
17             <varlistentry>
18                 <term>dir=chaîne  </term>
19                 <listitem>
20                     <para>
21                         utilisé pour spécifier la direction des graduations. <literal>chaîne</literal> peut être choisi parmi  'u','r','d','l' ('l' est la valeur par défaut). Les valeurs 'u','r','d','l' signifient up (en haut), right (à droite) , down (en bas) , left (à gauche).
22                     </para>
23                 </listitem>
24             </varlistentry>
25             <varlistentry>
26                 <term>tics=chaîne  </term>
27                 <listitem>
28                     <para>
29                         valeur décrivant comment sont données les graduations.   <literal>chaîne</literal> peut être choisi parmi 'v','r', et 'i' ('v' est la valeur par défaut).
30                     </para>
31                 </listitem>
32             </varlistentry>
33             <varlistentry>
34                 <term>x,y  </term>
35                 <listitem>
36                     <para>deux vecteurs donnant les positions des graduations.
37                     </para>
38                 </listitem>
39             </varlistentry>
40             <varlistentry>
41                 <term>val=chaîne  </term>
42                 <listitem>
43                     <para>une matrice de chaînes de caractères donnant les labels à dessiner en face des graduations.
44                     </para>
45                 </listitem>
46             </varlistentry>
47             <varlistentry>
48                 <term>fontsize=int  </term>
49                 <listitem>
50                     <para>
51                         spécifie la taille de la police utilisée pour dessiner les labels des graduations. La valeur par défaut est  <literal>-1</literal> (taille courante de police).
52                     </para>
53                 </listitem>
54             </varlistentry>
55             <varlistentry>
56                 <term>format_n=chaîne  </term>
57                 <listitem>
58                     <para>
59                         format utilisé pour afficher les nombres au dessus des graduations, <literal>chaîne</literal> spécifiant
60                         le format comme dans la fonction printf du langage C (par exemple <literal>chaîne="%.3f"</literal>).
61                     </para>
62                 </listitem>
63             </varlistentry>
64             <varlistentry>
65                 <term>seg= 1 ou 0  </term>
66                 <listitem>
67                     <para>valeur contrôlant l'affichage du segment de base de l'axe (1 par défaut).
68                     </para>
69                 </listitem>
70             </varlistentry>
71             <varlistentry>
72                 <term>sub_int=entier  </term>
73                 <listitem>
74                     <para>un entier donnant le nombre de sous-graduations
75                     </para>
76                 </listitem>
77             </varlistentry>
78             <varlistentry>
79                 <term>textcolor=entier  </term>
80                 <listitem>
81                     <para>
82                         spécifie la couleur à utiliser pour afficher les valeurs sur l'axe. La valeur par défaut est <literal>-1</literal> (couleur courante).
83                     </para>
84                 </listitem>
85             </varlistentry>
86             <varlistentry>
87                 <term>ticscolor=entier  </term>
88                 <listitem>
89                     <para>
90                         spécifie la couleur à utiliser pour dessiner les graduations. La valeur par défaut est <literal>-1</literal> (couleur courante).
91                     </para>
92                 </listitem>
93             </varlistentry>
94             <varlistentry>
95                 <term>e</term>
96                 <listitem>
97                     <para>
98                         handle, le handle de l'axe créé.
99                     </para>
100                 </listitem>
101             </varlistentry>
102         </variablelist>
103     </refsection>
104     <refsection>
105         <title>Description</title>
106         <para>
107             <literal>drawaxis</literal> est utilisée pour dessiner un axe vertical ou horizontal. Cette fonction renvoie le handle de l'axe créé.
108             La direction de l'axe est donnée par dir <literal>dir = 'u'</literal> ou <literal>'d'</literal> donne un axe horizontal avec des graduations
109             dirigées vers le haut (<literal>'u'</literal>) ou le bas (<literal>'d'</literal>).
110             <literal>dir = 'r'</literal> ou <literal>'l'</literal> donne un axe vertical avec des graduations allant vers la droite (<literal>'r'</literal>) ou vers la gauche (<literal>'l'</literal>).
111         </para>
112         <para>
113             <literal>x</literal> et <literal>y</literal> donnent les positions des graduations.
114             Si l'axe est horizontal alors <literal>y</literal>
115             doit être un scalaire ou peut être omis et <literal>x</literal>
116             est un vecteur. La signification de <literal>x</literal>
117             est contrôlée par <literal>tics</literal>.
118         </para>
119         <para>
120             Si <literal>tics='v'</literal> alors <literal>x</literal> donne les positions des graduations sur l'axe des x.
121         </para>
122         <para>
123             Si <literal>tics='r'</literal> alors <literal>x</literal> doit être de taille 3. <literal>x=[xmin,xmax,n]</literal> et
124             <literal>n</literal> donne le nombre d'intervalles.
125         </para>
126         <para>
127             Si <literal>tics='i'</literal> alors <literal>x</literal> doit être de taille 4, <literal>x=[k1,k2,a,n]</literal>.
128             Dans ce cas <literal>xmin=k1*10^a</literal>, <literal>xmax=k2*10^a</literal> et <literal>n</literal> donne le nombre d'intervalles.
129         </para>
130         <para>
131             Si <literal>y</literal> est omis alors l'axe est positionné en haut du cadre si <literal>dir='u'</literal> ou en bas si <literal>dir='d'</literal>
132         </para>
133         <para>
134             Par défaut, les nombres sont dessinés sur l'axe. Ils sont dessinés en utilisant un format par défaut qui peut être changé avec <literal>format_n</literal>.
135             Il est aussi possible d'afficher des chaînes de caractères données au lieu des nombres,
136             si <literal>val</literal> est fourni en argument. La taille de <literal>val</literal> doit alors
137             être égale au nombre de graduations.
138         </para>
139     </refsection>
140     <refsection>
141         <title>Exemples</title>
142         <programlisting role="example"><![CDATA[
143 plot2d(1:10,1:10,1,"020")
144 // axe horizontal
145 e = drawaxis(x=2:7,y=4,dir='u',tics='v')
146 // axe horizontal en haut du cadre
147 drawaxis(x=2:7,dir='u',tics='v')
148 // axe horizontal en bas du cadre
149 e = drawaxis(x=2:7,dir='d',tics='v')
150
151 // axe horizontal donné par une plage de variation
152 drawaxis(x=[2,7,3],y=4,dir='d',tics='r')
153
154 // axe vertical
155 e = drawaxis(x=4,y=2:7,dir='r',tics='v')
156 e = drawaxis(x=2,y=[2,7,3],dir='l',tics='r')
157 e = drawaxis(y=2:7,dir='r',tics='v')
158 e = drawaxis(y=2:7,dir='l',tics='v')
159
160 // axe horizontal avec chaînes de caractères au dessus des graduations
161 drawaxis(x=2:7,y=8,dir='u',tics='v',val='A'+string(1:6));
162 // axe vertical avec chaînes de caractères au dessus des graduations
163 drawaxis(x=8,y=2:7,dir='r',tics='v',val='B'+string(1:6));
164
165 // axe horizontal avec 'i'
166 e = drawaxis(x=[2,5,0,3],y=9,dir='u',tics='i');
167 e = drawaxis(x=9,y=[2,5,0,3],dir='r',tics='i',sub_int=5);
168
169 // encore un axe horizontal
170 drawaxis(x=2:7,y=4,dir='u',tics='v',fontsize=10,textcolor=9,ticscolor=7,seg=0,sub_int=20)
171  ]]></programlisting>
172         <scilab:image>
173             plot2d(1:10,1:10,1,"020")
174             drawaxis(x=2:7,y=4,dir='u',tics='v')
175             drawaxis(x=2:7,dir='u',tics='v')
176             drawaxis(x=2:7,dir='d',tics='v')
177
178             drawaxis(x=[2,7,3],y=4,dir='d',tics='r')
179
180             drawaxis(x=4,y=2:7,dir='r',tics='v')
181             drawaxis(x=2,y=[2,7,3],dir='l',tics='r')
182             drawaxis(y=2:7,dir='r',tics='v')
183             drawaxis(y=2:7,dir='l',tics='v')
184
185             drawaxis(x=2:7,y=8,dir='u',tics='v',val='A'+string(1:6));
186             drawaxis(x=8,y=2:7,dir='r',tics='v',val='B'+string(1:6));
187
188             drawaxis(x=[2,5,0,3],y=9,dir='u',tics='i');
189             drawaxis(x=9,y=[2,5,0,3],dir='r',tics='i',sub_int=5);
190
191             drawaxis(x=2:7,y=4,dir='u',tics='v',fontsize=10,textcolor=9,ticscolor=7,seg=0,sub_int=20)
192         </scilab:image>
193     </refsection>
194     <refsection role="see also">
195         <title>Voir aussi</title>
196         <simplelist type="inline">
197             <member>
198                 <link linkend="axis_properties">axis_properties</link>
199             </member>
200         </simplelist>
201     </refsection>
202 </refentry>