Fix help issues (warnings + wrong format in files)
[scilab.git] / scilab / modules / graphics / help / ja_JP / polygon / polyline_properties.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) INRIA - Djalel Abdemouche
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
11  *
12  -->
13 <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="polyline_properties">
14     <refnamediv>
15         <refname>polyline_properties</refname>
16         <refpurpose>Polylineエンティティプロパティの説明
17         </refpurpose>
18     </refnamediv>
19     <refsection>
20         <title>説明</title>
21         <para>Polylineエンティティはグラフィックエンティティ階層の葉です. このエンティティは
22             ポリラインのパラメータを定義します.
23         </para>
24         <variablelist>
25             <varlistentry>
26                 <term>parent: </term>
27                 <listitem>
28                     <para>このフィールドには親のハンドルが含まれます.
29                         polylineエンティティの親は<literal>"Axes"</literal> 型または
30                         <literal>"Compound"</literal>型です.
31                     </para>
32                 </listitem>
33             </varlistentry>
34             <varlistentry>
35                 <term>children: </term>
36                 <listitem>
37                     <para>
38                         このプロパティにはこのハンドルの<literal>children</literal>
39                         のベクトルが含まれます.
40                         しかし,現在,polylineには<literal>children</literal>がありません.
41                     </para>
42                 </listitem>
43             </varlistentry>
44             <varlistentry>
45                 <term>visible: </term>
46                 <listitem>
47                     <para>
48                         このフィールドはこのエンティティの<literal>visible</literal>
49                         プロパティの値を有します.
50                         値は<literal>"on" </literal> または <literal>"off"</literal>となります.
51                         デフォルトで polyline は可視であり,プロパティの値は 
52                         <literal>"on" </literal>となります. <literal>"off"</literal> の場合,
53                         このポリラインは画面に描画されません.
54                     </para>
55                 </listitem>
56             </varlistentry>
57             <varlistentry>
58                 <term>data: </term>
59                 <listitem>
60                     <para>このフィールドはxおよびy座標の値を有します.
61                         3次元軸の場合にはZ要素が追加されます.
62                         この値は,各点の座標を含む2(3)列の行列<literal>[x,y,[z]]</literal>です.
63                     </para>
64                 </listitem>
65             </varlistentry>
66             <varlistentry>
67                 <term>closed: </term>
68                 <listitem>
69                     <para>このフィールドはポリラインが閉じているかどうかを定義します:
70                         値は <literal>"on"</literal> または <literal>"off"</literal>となります
71                         (デフォルト値はなく,ポリラインを作成する際に使用されたプリミティブに
72                         依存します).
73                     </para>
74                 </listitem>
75             </varlistentry>
76             <varlistentry>
77                 <term>line_mode: </term>
78                 <listitem>
79                     <para>
80                         このフィールドはポリラインの<literal>line_mode</literal>プロパティの
81                         デフォルト値を有します. この値には <literal>"on" </literal>(線を描画
82                         ) または <literal>"off"</literal> (線を描画しない)を指定します.
83                     </para>
84                 </listitem>
85             </varlistentry>
86             <varlistentry>
87                 <term>fill_mode: </term>
88                 <listitem>
89                     <para>
90                         <literal>polyline_style</literal>フィールドが  5ではない場合, 曲線の
91                         背景が<literal>background</literal> プロパティで定義した色で塗られます.
92                     </para>
93                 </listitem>
94             </varlistentry>
95             <varlistentry>
96                 <term>line_style: </term>
97                 <listitem>
98                     <para>
99                         <literal>line_style</literal>プロパティの値は[0 8]の範囲の整数となります.
100                         0と1は実線を意味し,その他の値は破線を意味します
101                         (<link linkend="axes_properties">getlinestyle</link>参照).
102                     </para>
103                 </listitem>
104             </varlistentry>
105             <varlistentry>
106                 <term>thickness: </term>
107                 <listitem>
108                     <para>このプロパティはピクセル単位で線幅を指定する正の実数です.
109                         実際の表示幅は指定された幅を最も近い整数に丸めることで定義されます.
110                         唯一の例外はベクトル単位のエキスポートで,この場合は全体の
111                         <literal>thickness</literal>の値が考慮されます.
112                     </para>
113                 </listitem>
114             </varlistentry>
115             <varlistentry>
116                 <term>arrow_size_factor: </term>
117                 <listitem>
118                     <para>この整数によりポリラインに描かれる矢印の大きさを設定することができます.
119                         実際の矢印の大きさは<literal>thickness</literal>とこのsize factorの
120                         積となります.
121                     </para>
122                 </listitem>
123             </varlistentry>
124             <varlistentry>
125                 <term>polyline_style: </term>
126                 <listitem>
127                     <para>このプロパティは以下の各種のポリライン描画モードを設定します:</para>
128                     <itemizedlist>
129                         <listitem>
130                             <para>値が 0または1の場合,連続する2つの点の間に線が描画されます.</para>
131                         </listitem>
132                         <listitem>
133                             <para>値が2の場合,ポリラインは階段プロットとなります.
134                                 連続する2つの点は水平線の後に垂直線が続く線により結合されます.
135                             </para>
136                         </listitem>
137                         <listitem>
138                             <para>値が3の場合,ポリラインは棒グラフとなります.
139                                 指定された各(x,y)について, (x,y) から
140                                 (x,0)に垂直線が引かれます.
141                             </para>
142                         </listitem>
143                         <listitem>
144                             <para>値が 4の場合,連続する2つの点の間に矢印が描かれます.</para>
145                         </listitem>
146                         <listitem>
147                             <para>値が5の場合,ポリラインは塗りつぶされます (パッチ).</para>
148                         </listitem>
149                         <listitem>
150                             <para>値が 6の場合,ポリラインはMatlabに似たbarオブジェクトとなります.
151                                 プロパティ<literal>bar_shift</literal> および<literal>bar_width</literal>
152                                 がその外観を規定します.
153                             </para>
154                         </listitem>
155                     </itemizedlist>
156                     <para>
157                         <inlinemediaobject>
158                             <imageobject>
159                                 <imagedata fileref="../../images/polyline_style.svg"/>
160                             </imageobject>
161                         </inlinemediaobject>
162                     </para>
163                 </listitem>
164             </varlistentry>
165             <varlistentry>
166                 <term>foreground: </term>
167                 <listitem>
168                     <para>このフィールドにはポリラインを描画する際に使用される
169                         <literal>foreground</literal>プロパティのデフォルト値が含まれます.
170                         その値には(カレントのカラーマップに沿った)色インデックスを指定します.
171                     </para>
172                 </listitem>
173             </varlistentry>
174             <varlistentry>
175                 <term>background: </term>
176                 <listitem>
177                     <para>このフィールドはポリラインの背景を塗りつぶす際に使用される色を有します.
178                         その値には(カレントのカラーマップに沿った)色インデックスを指定します.
179                     </para>
180                 </listitem>
181             </varlistentry>
182             <varlistentry>
183                 <term>interp_color_vector: </term>
184                 <listitem>
185                     <para>このフィールドは,
186                         <literal>interp_color_mode</literal>プロパティが<literal>"on"</literal>に設定された
187                         際にポリラインを塗る際に使用される色インデックスの
188                         ベクトルを有します.
189                         これは,各セグメントを塗る際に使用される
190                         カラーマップインデックスの間隔を定義します.
191                         例えば,最初のセグメントは,
192                         インデックスがベクトルの最初の2つの要素の間にある各色により塗りつぶされます.
193                         これはポリラインが 3 または 4つの点で定義されている場合のみ適用可能です.
194                         このため,ベクトルの大きさはこの次元に一致している必要があります.
195                     </para>
196                 </listitem>
197             </varlistentry>
198             <varlistentry>
199                 <term>interp_color_mode: </term>
200                 <listitem>
201                     <para>このフィールドはポリラインを塗る際に補間影モードを
202                         使用するかどうかを定義します:
203                         この値は<literal>"on"</literal> または<literal>"off"</literal>となります.
204                         "on"に値を切り替える前に <literal>interp_color_vector</literal>を
205                         定義する必要があります (上記参照).
206                     </para>
207                 </listitem>
208             </varlistentry>
209             <varlistentry>
210                 <term>mark_mode: </term>
211                 <listitem>
212                     <para>
213                         このフィールドはポリラインの<literal>mark_mode</literal>
214                         プロパティのデフォルト値を有します.
215                         この値は<literal>"on"</literal> (マーカを描画
216                         drawn) または <literal>"off"</literal> (マーカを描画しない)となります.
217                     </para>
218                 </listitem>
219             </varlistentry>
220             <varlistentry>
221                 <term>mark_style: </term>
222                 <listitem>
223                     <para>
224                         <literal>mark_style</literal>プロパティの値は
225                         <literal>mark_mode</literal>プロパティが<literal>"on"</literal>の場合に,
226                         使用するマーカの種類を選択するために使用されます.
227                         この値は[0 14]の範囲の整数で,それぞれ以下の意味があります :
228                         ドット,プラス,十字,星,塗りつぶした菱形,
229                         上向き三角形, 下向き三角形, 菱形プラス,円,アスタリスク,
230                         正方形,右向き三角形,左向き三角形およびペンタグラム.
231                         以下の図は,マーカのアスペクトが<literal>mark_style</literal>,
232                         <literal>mark_foreground</literal> および
233                         <literal>mark_background</literal>プロパティに依存する
234                         ことを示します.
235                     </para>
236                     <para>
237                         <inlinemediaobject>
238                             <imageobject>
239                                 <imagedata fileref="../../images/marks.svg"/>
240                             </imageobject>
241                         </inlinemediaobject>
242                     </para>
243                 </listitem>
244             </varlistentry>
245             <varlistentry>
246                 <term>mark_size_unit: </term>
247                 <listitem>
248                     <para>
249                         このフィールは<literal>mark_size_unit</literal>プロパティのデフォルト値
250                         を有します.<literal>mark_size_unit</literal>が<literal>"point"</literal>
251                         に設定された場合,<literal>mark_size</literal>の値はポイント単位で直接
252                         指定されます.
253                         <literal>mark_size_unit</literal> に<literal>"tabulated"</literal>が
254                         指定された場合,<literal>mark_size</literal>はfont size配列に相対的に
255                         計算されます: この場合,この値は,
256                         8pt, 10pt, 12pt, 14pt, 18pt および 24pt を意味する
257                         [0 5]の範囲の整数とします.
258                         <link linkend="xrect">xrect</link>および Scilabのネーティブ関数は
259                         <literal>tabulated</literal>モードをデフォルトとします;
260                         <link linkend="plot">plot</link>関数を使用する場合,
261                         <literal>point</literal> モードが自動的に有効となります.
262                     </para>
263                 </listitem>
264             </varlistentry>
265             <varlistentry>
266                 <term>mark_size: </term>
267                 <listitem>
268                     <para>
269                         <literal>mark_size</literal>プロパティは,
270                         <literal>mark_mode</literal>プロパティが<literal>"on"</literal>の時,
271                         マーカの大きさを選択するために使用されます.
272                         この値は, 8pt, 10pt, 12pt, 14pt, 18pt および 24pt を意味する
273                         [0 5]の範囲の整数です.
274                     </para>
275                 </listitem>
276             </varlistentry>
277             <varlistentry>
278                 <term>mark_foreground: </term>
279                 <listitem>
280                     <para>
281                         このフィールドは,マーカの縁の色である<literal>mark_foreground</literal>
282                         プロパティの値を有します.この値は(カレントのcolor_mapに関連する)色インデックス
283                         または透過エッジを意味する 0 とします.
284                     </para>
285                 </listitem>
286             </varlistentry>
287             <varlistentry>
288                 <term>mark_background: </term>
289                 <listitem>
290                     <para>このフィールドは,マーカの前景色である
291                         <literal>mark_background</literal>プロパティの値を有します.
292                         この値は(カレントのcolor_mapに関連する)色インデックス
293                         または透過エッジを意味する 0 とします.
294                     </para>
295                 </listitem>
296             </varlistentry>
297             <varlistentry>
298                 <term>x_shift: </term>
299                 <listitem>
300                     <para>
301                         このフィールドは関数<link linkend="bar">bar</link>をコールする
302                         ことにより計算される
303                         (または<link linkend="barhomogenize">barhomogenize</link>を
304                         コールすることにより再計算される)オフセットを有し,
305                         見栄えの良い垂直棒グラフを作成するために使用されます.
306                         このオフセットは他の<literal>polyline_style</literal>にも
307                         適用されることに注意してください.
308                         単位はユーザ座標で表されます.
309                     </para>
310                 </listitem>
311             </varlistentry>
312             <varlistentry>
313                 <term>y_shift: </term>
314                 <listitem>
315                     <para>
316                         このフィールドは関数<link linkend="bar">bar</link>をコールする
317                         ことにより計算される
318                         (または<link linkend="barhomogenize">barhomogenize</link>を
319                         コールすることにより再計算される)オフセットを有し,
320                         見栄えの良い水平棒グラフを作成するために使用されます.
321                         このオフセットは他の<literal>polyline_style</literal>にも
322                         適用されることに注意してください.
323                         単位はユーザ座標で表されます.
324                     </para>
325                 </listitem>
326             </varlistentry>
327             <varlistentry>
328                 <term>z_shift: </term>
329                 <listitem>
330                     <para>このフィールドはユーザが指定する
331                         オフセットを有します
332                         このオフセットは他の<literal>polyline_style</literal>にも
333                         適用されることに注意してください.
334                         このユニットはユーザ座標で表されています.
335                     </para>
336                 </listitem>
337             </varlistentry>
338             <varlistentry>
339                 <term>bar_width: </term>
340                 <listitem>
341                     <para>このフィールドは,
342                         <literal>polyline_style</literal> が棒グラフモード (ケース 6)に
343                         せていされている場合に,
344                         選択されたポリラインの幅を定義します:
345                         単位はユーザ座標で表されます.
346                     </para>
347                 </listitem>
348             </varlistentry>
349             <varlistentry>
350                 <term>clip_state: </term>
351                 <listitem>
352                     <para>
353                         このフィールドはポリラインの<literal>clip_state</literal>プロパティの
354                         値を有します. 値は以下となります: 
355                     </para>
356                     <itemizedlist>
357                         <listitem>
358                             <para>
359                                 <literal>"off"</literal> ポリラインはクリップされません.
360                             </para>
361                         </listitem>
362                         <listitem>
363                             <para>
364                                 <literal>"clipgrf"</literal> ポリラインはAxesボックスの外側でクリップ
365                                 されます.
366                             </para>
367                         </listitem>
368                         <listitem>
369                             <para>
370                                 <literal>"on"</literal>ポリラインはclip_boxプロパティで
371                                 指定された矩形の外側でクリップされます.
372                             </para>
373                         </listitem>
374                     </itemizedlist>
375                 </listitem>
376             </varlistentry>
377             <varlistentry>
378                 <term>clip_box: </term>
379                 <listitem>
380                     <para>
381                         このフィールドは<literal>clip_box</literal>プロパティを定義します.
382                         clip_state が "off" の場合, デフォルトで,この値は空の行列です.
383                         その他の場合, ベクトル <literal>[x,y,w,h]</literal> (左上の点 幅 高さ) 
384                         は表示するポリラインの部分を定義しますが,
385                         <literal>clip_state</literal>プロパティの値が変更されます.
386                     </para>
387                 </listitem>
388             </varlistentry>
389             <varlistentry>
390                 <term>user_data: </term>
391                 <listitem>
392                     <para>このフィールドはpolylineデータ構造体に任意のScilab変数を
393                         保存し,再度取得する際に使用できます.
394                     </para>
395                 </listitem>
396             </varlistentry>
397         </variablelist>
398     </refsection>
399     <refsection>
400         <title>例</title>
401         <scilab:image>
402             a=get("current_axes")
403             a.data_bounds=[-2,-2;2,2];
404             
405             xpoly(sin(2*%pi*(0:5)/5),cos(2*%pi*(0:5)/5),"lines",0)
406             p=get("hdl");
407             p.foreground=2;
408             p.thickness=3;
409             p.mark_style=9;
410             d=p.data;d(1,:)=[0 0];p.data=d;
411             a.rotation_angles=[0 45];
412         </scilab:image>
413     </refsection>
414     <refsection>
415         <title>例</title>
416         <programlisting role="example"><![CDATA[ 
417 a=get("current_axes")//新規に作成された軸のハンドルを取得
418 a.data_bounds=[-2,-2;2,2];
419
420 xpoly(sin(2*%pi*(0:5)/5),cos(2*%pi*(0:5)/5),"lines",0)
421 p=get("hdl"); //カレントのエンティティ(ここではpolylineエンティティ)のハンドルを取得
422 p.foreground=2;
423 p.thickness=3;
424 p.mark_style=9;
425 d=p.data;d(1,:)=[0 0];p.data=d;
426 a.rotation_angles=[0 45];
427    
428 p.data=[(-2:0.1:2)' sin((-2:0.1:2)*%pi)']
429 p.mark_mode="off";
430 p.polyline_style=3;
431 p.line_style=4;
432  ]]></programlisting>
433     </refsection>
434     <refsection role="see also">
435         <title>参照</title>
436         <simplelist type="inline">
437             <member>
438                 <link linkend="set">set</link>
439             </member>
440             <member>
441                 <link linkend="get">get</link>
442             </member>
443             <member>
444                 <link linkend="delete">delete</link>
445             </member>
446             <member>
447                 <link linkend="xpoly">xpoly</link>
448             </member>
449             <member>
450                 <link linkend="xfpoly">xfpoly</link>
451             </member>
452             <member>
453                 <link linkend="xpolys">xpolys</link>
454             </member>
455             <member>
456                 <link linkend="xfpolys">xfpolys</link>
457             </member>
458             <member>
459                 <link linkend="graphics_entities">graphics_entities</link>
460             </member>
461         </simplelist>
462     </refsection>
463     <refsection>
464         <title>履歴</title>
465         <revhistory>
466             <revision>
467                 <revnumber>5.4.0</revnumber>
468                 <revremark>line_style = 0 は廃止予定です.代わりに 1 を使用してください
469                     (両者は等価で,共に実線を意味します). Scilab 5.4.1以降,値0を使用すると
470                     エラーを発生します.
471                 </revremark>
472             </revision>
473         </revhistory>
474     </refsection>
475 </refentry>