4b6627e49a6e96297e016be975d66c9568c207aa
[scilab.git] / scilab / modules / graphics / help / ja_JP / axis / drawaxis.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2
3 <!--
4
5  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
6
7  * Copyright (C) ENPC - Jean-Philippe Chancelier
8
9  *
10
11
12  * Copyright (C) 2012 - 2016 - Scilab Enterprises
13  *
14  * This file is hereby licensed under the terms of the GNU GPL v2.0,
15  * pursuant to article 5.3.4 of the CeCILL v.2.1.
16  * This file was originally licensed under the terms of the CeCILL v2.1,
17  * and continues to be available under such terms.
18  * For more information, see the COPYING file which you should have received
19  * along with this program.
20
21  *
22
23  -->
24
25 <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="ja" xml:id="drawaxis">
26
27     <refnamediv>
28
29         <refname>drawaxis</refname>
30
31         <refpurpose>軸を描画</refpurpose>
32
33     </refnamediv>
34
35     <refsynopsisdiv>
36
37         <title>呼び出し手順</title>
38
39         <synopsis>drawaxis([options])
40
41             // options: x,y,dir,sub_int,fontsize,format_n,seg,textcolor,ticscolor,tics
42
43         </synopsis>
44
45     </refsynopsisdiv>
46
47     <refsection>
48
49         <title>引数</title>
50
51         <variablelist>
52
53             <varlistentry>
54
55                 <term>dir=文字列</term>
56
57                 <listitem>
58
59                     <para>メモリの方向を指定するために使用されます.
60
61                         <literal>string</literal> には'u','r','d','l'のどれかを指定し,
62
63                         'l'がデフォルト値です.
64
65                         値  'u','r','d','l' はそれぞれ up, right, down, leftを意味します.
66
67                     </para>
68
69                 </listitem>
70
71             </varlistentry>
72
73             <varlistentry>
74
75                 <term>tics=文字列</term>
76
77                 <listitem>
78
79                     <para>
80
81                         目盛の指定方法を記述するフラグ.
82
83                         <literal>string</literal> には'v','r', および 'i'のどれかを指定し,
84
85                         'v'がデフォルト値です
86
87                     </para>
88
89                 </listitem>
90
91             </varlistentry>
92
93             <varlistentry>
94
95                 <term>x,y</term>
96
97                 <listitem>
98
99                     <para>目盛の位置を指定するベクトル.</para>
100
101                 </listitem>
102
103             </varlistentry>
104
105             <varlistentry>
106
107                 <term>val= 文字列行列</term>
108
109                 <listitem>
110
111                     <para>文字列行列で, 指定された場合,
112
113                         目盛の位置で軸に沿って描画される文字列を指定します.
114
115                     </para>
116
117                 </listitem>
118
119             </varlistentry>
120
121             <varlistentry>
122
123                 <term>fontsize=整数</term>
124
125                 <listitem>
126
127                     <para>
128
129                         軸に沿って表示される数値で使用されるフォントの大きさを指定します.
130
131                         デフォルト値はカレントのフォントサイズを意味する <literal>-1</literal> です
132
133                     </para>
134
135                 </listitem>
136
137             </varlistentry>
138
139             <varlistentry>
140
141                 <term>format_n=文字列</term>
142
143                 <listitem>
144
145                     <para>
146
147                         軸に沿って表示される数値のフォーマットで,<literal>string</literal>には
148
149                         C言語のprintf関数の構文形式に基づくフォーマット(例えば<literal>string="%.3f"</literal>)を指定します.
150
151                     </para>
152
153                 </listitem>
154
155             </varlistentry>
156
157             <varlistentry>
158
159                 <term>seg= 1 または 0</term>
160
161                 <listitem>
162
163                     <para>
164
165                         軸のベースセグメントの表示を制御するフラグ (デフォルト値は 1です).
166
167                     </para>
168
169                 </listitem>
170
171             </varlistentry>
172
173
174             <varlistentry>
175
176                 <term>sub_int=整数</term>
177
178                 <listitem>
179
180                     <para>
181
182                         大きな目盛の間に描画されるサブ間隔(目盛)の数を指定する整数.
183
184                     </para>
185
186                 </listitem>
187
188             </varlistentry>
189
190             <varlistentry>
191
192                 <term>textcolor=整数</term>
193
194                 <listitem>
195
196                     <para>
197
198                         軸に沿って表示される値で使用される色を指定します.
199
200                         デフォルト値はカレントの色を意味する <literal>-1</literal> です.
201
202                     </para>
203
204                 </listitem>
205
206             </varlistentry>
207
208             <varlistentry>
209
210                 <term>ticscolor=整数</term>
211
212                 <listitem>
213
214                     <para>目盛の描画で使用される色を指定します. デフォルト値はカレントの色を意味する
215
216                         <literal>-1</literal> です.
217
218                     </para>
219
220                 </listitem>
221
222             </varlistentry>
223
224         </variablelist>
225
226     </refsection>
227
228     <refsection>
229
230         <title>説明</title>
231
232         <para>
233
234             <literal>drawaxis</literal> は垂直または水平方向の
235
236             軸を描画する際に使用されます.
237
238             軸の方向は dir で指定され,
239
240             <literal>dir = 'u'</literal> または <literal>'d'</literal>は
241
242             目盛が増加 (<literal>'u'</literal>)または減少(<literal>'d'</literal>)
243
244             する水平軸を指定します.
245
246
247
248             <literal>dir = 'r'</literal> または <literal>'l'</literal>は
249
250             右方向(<literal>'r'</literal>) または左方向 (<literal>'l'</literal>)の
251
252             目盛を有する垂直軸を指定します.
253
254         </para>
255
256         <para>
257
258             <literal>x</literal> および <literal>y</literal> は軸の目盛の位置を指定します.
259
260             軸が水平軸の場合,<literal>y</literal> はスカラーまたは省略する必要があり,
261
262             <literal>x</literal> はScilabベクトルとします.
263
264             <literal>x</literal>の意味は<literal>tics</literal>で制御されます.
265
266         </para>
267
268         <para>
269
270             <literal>tics='v'</literal>の場合, <literal>x</literal> は x軸方向の目盛の
271
272             位置を指定します.
273
274         </para>
275
276         <para>
277
278             <literal>tics='r'</literal>の場合, <literal>x</literal> の大きさは3である必要があります.
279
280             <literal>x=[xmin,xmax,n]</literal>で,
281
282             <literal>n</literal> は間隔の数を指定します.
283
284         </para>
285
286         <para>
287
288             <literal>tics='i'</literal>の場合, <literal>x</literal> は大きさ4の
289
290             <literal>x=[k1,k2,a,n]</literal>とします.
291
292             <literal>xmin=k1*10^a</literal>, <literal>xmax=k2*10^a</literal>で,
293
294             <literal>n</literal> は間隔の数を指定します.
295
296         </para>
297
298         <para>
299
300             <literal>y</literal> が省略された場合,軸は,<literal>dir='u'</literal>の場合に
301
302             フレームの上部,<literal>dir='d'</literal>の場合にフレームの下部
303
304             に配置されます.
305
306         </para>
307
308         <para>
309
310             デフォルトで,軸に沿って数値が描画されます.
311
312             これらの数値はデフォルトのフォーマットで描画されますが,
313
314             このフォーマットは<literal>format_n</literal>で変更可能です.
315
316             数値ではなく文字列を表示することも可能で,
317
318             <literal>val</literal>を指定した場合に文字列が表示されます.
319
320             <literal>val</literal> の大きさは目盛の数に一致する必要があります.
321
322         </para>
323
324     </refsection>
325
326     <refsection>
327
328         <title>例</title>
329
330         <programlisting role="example"><![CDATA[
331
332 plot2d(1:10,1:10,1,"020")
333
334 // 水平軸
335
336 drawaxis(x=2:7,y=4,dir='u',tics='v')
337
338 // フレームの上部に水平軸
339
340 drawaxis(x=2:7,dir='u',tics='v')
341
342 // フレームの下部に水平軸
343
344 drawaxis(x=2:7,dir='d',tics='v')
345
346
347
348 // 範囲で指定した水平軸
349
350 drawaxis(x=[2,7,3],y=4,dir='d',tics='r')
351
352
353
354 // 垂直軸
355
356 drawaxis(x=4,y=2:7,dir='r',tics='v')
357
358 drawaxis(x=2,y=[2,7,3],dir='l',tics='r')
359
360 drawaxis(y=2:7,dir='r',tics='v')
361
362 drawaxis(y=2:7,dir='l',tics='v')
363
364
365
366 // 目盛位置に表示する文字列を指定した水平軸
367
368 drawaxis(x=2:7,y=8,dir='u',tics='v',val='A'+string(1:6));
369
370 // vertical axis with strings displayed at tics positions
371
372 drawaxis(x=8,y=2:7,dir='r',tics='v',val='B'+string(1:6));
373
374
375
376 // 'i' 範囲で指定した水平軸.
377
378 drawaxis(x=[2,5,0,3],y=9,dir='u',tics='i');
379
380 drawaxis(x=9,y=[2,5,0,3],dir='r',tics='i',sub_int=5);
381
382
383
384 // 再び水平軸
385
386 drawaxis(x=2:7,y=4,dir='u',tics='v',fontsize=10,textcolor=9,ticscolor=7,seg=0,sub_int=20)
387
388  ]]></programlisting>
389
390         <scilab:image>
391
392             plot2d(1:10,1:10,1,"020")
393
394             drawaxis(x=2:7,y=4,dir='u',tics='v')
395
396             drawaxis(x=2:7,dir='u',tics='v')
397
398             drawaxis(x=2:7,dir='d',tics='v')
399
400
401
402             drawaxis(x=[2,7,3],y=4,dir='d',tics='r')
403
404
405
406             drawaxis(x=4,y=2:7,dir='r',tics='v')
407
408             drawaxis(x=2,y=[2,7,3],dir='l',tics='r')
409
410             drawaxis(y=2:7,dir='r',tics='v')
411
412             drawaxis(y=2:7,dir='l',tics='v')
413
414
415
416             drawaxis(x=2:7,y=8,dir='u',tics='v',val='A'+string(1:6));
417
418             drawaxis(x=8,y=2:7,dir='r',tics='v',val='B'+string(1:6));
419
420
421
422             drawaxis(x=[2,5,0,3],y=9,dir='u',tics='i');
423
424             drawaxis(x=9,y=[2,5,0,3],dir='r',tics='i',sub_int=5);
425
426
427
428             drawaxis(x=2:7,y=4,dir='u',tics='v',fontsize=10,textcolor=9,ticscolor=7,seg=0,sub_int=20)
429
430         </scilab:image>
431
432     </refsection>
433
434     <refsection role="see also">
435
436         <title>参照</title>
437
438         <simplelist type="inline">
439
440             <member>
441
442                 <link linkend="axis_properties">axis_properties</link>
443
444             </member>
445
446         </simplelist>
447
448     </refsection>
449
450 </refentry>
451
452
453