update japanese translation of core module.
[scilab.git] / scilab / modules / graphics / help / ja_JP / annotation / legend.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) INRIA
8
9  * 
10
11  * This file must be used under the terms of the CeCILL.
12
13  * This source file is licensed as described in the file COPYING, which
14
15  * you should have received as part of this distribution.  The terms
16
17  * are also available at    
18
19  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
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: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="legend" xml:lang="ja">
26     
27     <refnamediv>
28         
29         <refname>legend</refname>
30         
31         <refpurpose>グラフの凡例を描画する</refpurpose>
32         
33     </refnamediv>
34     
35     <refsynopsisdiv>
36         
37         <title>呼び出し手順</title>
38         
39         <synopsis>hl=legend([h,] string1,string2, ... [,pos] [,boxed])
40             
41             hl=legend([h,] strings [,pos] [,boxed])
42             
43         </synopsis>
44         
45     </refsynopsisdiv>
46     
47     <refsection>
48         
49         <title>引数</title>
50         
51         <variablelist>
52             
53             <varlistentry>
54                 
55                 <term>h</term>
56                 
57                 <listitem>
58                     
59                     <para>
60                         
61                         軸エンティティのグラフィックハンドルまたは
62                         
63                         ポリラインエンティティのハンドルを表すベクトル.
64                         
65                         デフォルト値は<literal>current_axes</literal>の
66                         
67                         ハンドルとなります.
68                         
69                     </para>
70                     
71                 </listitem>
72                 
73             </varlistentry>
74             
75             <varlistentry>
76                 
77                 <term>string1,string2, ...</term>
78                 
79                 <listitem>
80                     
81                     <para>文字列 stringsi は i番目の曲線の凡例となります.</para>
82                     
83                     <para>Scilab 5.2 以降, 
84                         
85                         <link linkend="math_rendering_features_in_graphic">LaTeX または
86                             
87                             MathML 式
88                             
89                         </link>
90                         
91                         を記述することが可能です.
92                         
93                     </para>
94                     
95                 </listitem>
96                 
97             </varlistentry>
98             
99             <varlistentry>
100                 
101                 <term>strings</term>
102                 
103                 <listitem>
104                     
105                     <para>文字列のベクトルで,strings(i)はi番目の曲線の凡例となります.</para>
106                     
107                     <para>Scilab 5.2 以降, 
108                         
109                         <link linkend="math_rendering_features_in_graphic">LaTeX または
110                             
111                             MathML 式
112                             
113                         </link>
114                         
115                         を記述することが可能です.
116                         
117                     </para>
118                     
119                 </listitem>
120                 
121             </varlistentry>
122             
123             <varlistentry>
124                 
125                 <term>pos</term>
126                 
127                 <listitem>
128                     
129                     <para>(オプション) 凡例を描画する場所を指定;
130                         
131                         このパラメータには文字列(または廃止予定ですが等価な整数)
132                         
133                         または
134                         
135                         凡例ボックスの左上隅の座標を指定するベクトル [x,y]のどちらかを指定します.
136                         
137                     </para>
138                     
139                     <para>
140                         
141                         最初のケースの場合,指定可能な値は次のようになります:
142                         
143                     </para>
144                     
145                     <itemizedlist>
146                         
147                         <listitem>
148                             
149                             <para>1 または "in_upper_right": 
150                                 
151                                 凡例は右上隅に描画されます(デフォルト).
152                                 
153                             </para>
154                             
155                         </listitem>
156                         
157                         <listitem>
158                             
159                             <para>2 または "in_upper_left":
160                                 
161                                 凡例は左上隅に描画されます.
162                                 
163                             </para>
164                             
165                         </listitem>
166                         
167                         <listitem>
168                             
169                             <para>3 または "in_lower_left": 
170                                 
171                                 凡例は左下隅に描画されます.
172                                 
173                             </para>
174                             
175                         </listitem>
176                         
177                         <listitem>
178                             
179                             <para>4 または "in_lower_right": 
180                                 
181                                 凡例は右下隅に描画されます.
182                                 
183                             </para>
184                             
185                         </listitem>
186                         
187                         <listitem>
188                             
189                             <para>5 または "by_coordinates": 
190                                 
191                                 マウスにより対話的に配置.
192                                 
193                             </para>
194                             
195                         </listitem>
196                         
197                         <listitem>
198                             
199                             <para>-1 または "out_upper_right": 
200                                 
201                                 凡例は右上隅の右に描画されます.
202                                 
203                             </para>
204                             
205                         </listitem>
206                         
207                         <listitem>
208                             
209                             <para>-2 または "out_upper_left": 
210                                 
211                                 凡例は左上隅の左に描画されます.
212                                 
213                             </para>
214                             
215                         </listitem>
216                         
217                         <listitem>
218                             
219                             <para>-3 または "out_lower_left": 
220                                 
221                                 凡例は左下隅の左に描画されます.
222                                 
223                             </para>
224                             
225                         </listitem>
226                         
227                         <listitem>
228                             
229                             <para>-4 または "out_lower_right": 
230                                 
231                                 凡例は右下隅の右に描画されます.
232                                 
233                             </para>
234                             
235                         </listitem>
236                         
237                         <listitem>
238                             
239                             <para>-5 または "upper_caption": 
240                                 
241                                 凡例は左上隅の上に描画されます.
242                                 
243                             </para>
244                             
245                         </listitem>
246                         
247                         <listitem>
248                             
249                             <para>-6 または "lower_caption": 
250                                 
251                                 凡例は左下隅の下に描画されます.
252                                 
253                             </para>
254                             
255                         </listitem>
256                         
257                     </itemizedlist>
258                     
259                 </listitem>
260                 
261             </varlistentry>
262             
263             <varlistentry>
264                 
265                 <term>boxed</term>
266                 
267                 <listitem>
268                     
269                     <para>論理値(デフォルト: %t)で,ボックスの描画の有無を指定します.</para>
270                     
271                 </listitem>
272                 
273             </varlistentry>
274             
275             <varlistentry>
276                 
277                 <term>hl</term>
278                 
279                 <listitem>
280                     
281                     <para>ハンドルで, 全ての凡例を含む複合要素(compound)を指定します.</para>
282                     
283                 </listitem>
284                 
285             </varlistentry>
286             
287         </variablelist>
288         
289     </refsection>
290     
291     <refsection>
292         
293         <title>説明</title>
294         
295         <para>
296             
297             ラベルとして指定された文字列を用いてカレントのプロットに凡例を出力します.
298             
299             凡例の前には対応する線またはパッチに付随する記号が付加されます.
300             
301             この記号の形状やプロパティは指定したハンドルから取得されます:
302             
303         </para>
304         
305         <para>ハンドル引数を指定せずにコールされた場合(もしくは軸エンティティの
306             
307             ハンドルが指定された場合),この関数はまず指定した軸の子であるポリラインの
308             
309             ハンドルからなるベクトルを構築します.
310             
311         </para>
312         
313         <para>対話的な配置モード (opt=5) においては, マウスで凡例ボックスを
314             
315             移動し, 離す際には左ボタンを押します.
316             
317         </para>
318         
319     </refsection>
320     
321     <refsection>
322         
323         <title>例</title>
324         
325         <programlisting role="example"><![CDATA[ 
326
327 t=linspace(0,%pi,20);
328
329 a=gca();
330
331 a.data_bounds=[t(1) -1.8;t($) 1.8];
332
333
334
335 plot2d(t,[cos(t'),cos(2*t'),cos(3*t')],[-5,2 3]);  
336
337 e=gce();
338
339 e1=e.children(1);
340
341 e1.thickness=2;
342
343 e1.polyline_style=4;
344
345 e1.arrow_size_factor = 1/2;
346
347 e.children(2).line_style=4;
348
349 e3=e.children(3);
350
351 e3.line_mode='on';
352
353 e3.mark_background=5;
354
355
356
357 hl=legend(['cos(t)';'cos(2*t)';'cos(3*t)']);
358
359  ]]></programlisting>
360         
361         <scilab:image>
362             
363             
364             
365             t=linspace(0,%pi,20);
366             
367             a=gca();
368             
369             a.data_bounds=[t(1) -1.8;t($) 1.8];
370             
371             
372             
373             plot2d(t,[cos(t'),cos(2*t'),cos(3*t')],[-5,2 3]);  
374             
375             e=gce();
376             
377             e1=e.children(1);
378             
379             e1.thickness=2;
380             
381             e1.polyline_style=4;
382             
383             e1.arrow_size_factor = 1/2;
384             
385             e.children(2).line_style=4;
386             
387             e3=e.children(3);
388             
389             e3.line_mode='on';
390             
391             e3.mark_background=5;
392             
393             
394             
395             hl=legend(['cos(t)';'cos(2*t)';'cos(3*t)']);
396             
397         </scilab:image>
398         
399     </refsection>
400     
401     <refsection role="see also">
402         
403         <title>参照</title>
404         
405         <simplelist type="inline">
406             
407             <member>
408                 
409                 <link linkend="xstring">xstring</link>
410                 
411             </member>
412             
413             <member>
414                 
415                 <link linkend="captions">captions</link>
416                 
417             </member>
418             
419             <member>
420                 
421                 <link linkend="polyline_properties">polyline_properties</link>
422                 
423             </member>
424             
425         </simplelist>
426         
427     </refsection>
428     
429 </refentry>
430