10
10
* http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
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" version="5.0-subset Scilab" xml:lang="ja" xml:id="polyline_properties">
15
<refname>polyline_properties</refname>
16
<refpurpose>Polylineエンティティプロパティの説明
21
<para>Polylineエンティティはグラフィックエンティティ階層の葉です. このエンティティは
28
<para>このフィールドには親のハンドルが含まれます.
29
polylineエンティティの親は<literal>"Axes"</literal> 型または
30
<literal>"Compound"</literal>型です.
35
<term>children: </term>
38
このプロパティにはこのハンドルの<literal>children</literal>
40
しかし,現在,polylineには<literal>children</literal>がありません.
45
<term>visible: </term>
48
このフィールドはこのエンティティの<literal>visible</literal>
50
値は<literal>"on" </literal> または <literal>"off"</literal>となります.
51
デフォルトで polyline は可視であり,プロパティの値は
52
<literal>"on" </literal>となります. <literal>"off"</literal> の場合,
60
<para>このフィールドはxおよびy座標の値を有します.
62
この値は,各点の座標を含む2(3)列の行列<literal>[x,y,[z]]</literal>です.
69
<para>このフィールドはポリラインが閉じているかどうかを定義します:
70
値は <literal>"on"</literal> または <literal>"off"</literal>となります
71
(デフォルト値はなく,ポリラインを作成する際に使用されたプリミティブに
77
<term>line_mode: </term>
80
このフィールドはポリラインの<literal>line_mode</literal>プロパティの
81
デフォルト値を有します. この値には <literal>"on" </literal>(線を描画
82
) または <literal>"off"</literal> (線を描画しない)を指定します.
87
<term>fill_mode: </term>
90
<literal>polyline_style</literal>フィールドが 5ではない場合, 曲線の
91
背景が<literal>background</literal> プロパティで定義した色で塗られます.
96
<term>line_style: </term>
99
<literal>line_style</literal>プロパティの値は[0 8]の範囲の整数となります.
100
0と1は実線を意味し,その他の値は破線を意味します
101
(<link linkend="axes_properties">getlinestyle</link>参照).
106
<term>thickness: </term>
108
<para>このプロパティはピクセル単位で線幅を指定する正の実数です.
109
実際の表示幅は指定された幅を最も近い整数に丸めることで定義されます.
110
唯一の例外はベクトル単位のエキスポートで,この場合は全体の
111
<literal>thickness</literal>の値が考慮されます.
116
<term>arrow_size_factor: </term>
118
<para>この整数によりポリラインに描かれる矢印の大きさを設定することができます.
119
実際の矢印の大きさは<literal>thickness</literal>とこのsize factorの
125
<term>polyline_style: </term>
127
<para>このプロパティは以下の各種のポリライン描画モードを設定します:</para>
130
<para>値が 0または1の場合,連続する2つの点の間に線が描画されます.</para>
133
<para>値が2の場合,ポリラインは階段プロットとなります.
134
連続する2つの点は水平線の後に垂直線が続く線により結合されます.
138
<para>値が3の場合,ポリラインは棒グラフとなります.
139
指定された各(x,y)について, (x,y) から
144
<para>値が 4の場合,連続する2つの点の間に矢印が描かれます.</para>
147
<para>値が5の場合,ポリラインは塗りつぶされます (パッチ).</para>
150
<para>値が 6の場合,ポリラインはMatlabに似たbarオブジェクトとなります.
151
プロパティ<literal>bar_shift</literal> および<literal>bar_width</literal>
159
<imagedata fileref="../../images/polyline_style.svg"/>
166
<term>foreground: </term>
168
<para>このフィールドにはポリラインを描画する際に使用される
169
<literal>foreground</literal>プロパティのデフォルト値が含まれます.
170
その値には(カレントのカラーマップに沿った)色インデックスを指定します.
175
<term>background: </term>
177
<para>このフィールドはポリラインの背景を塗りつぶす際に使用される色を有します.
178
その値には(カレントのカラーマップに沿った)色インデックスを指定します.
183
<term>interp_color_vector: </term>
186
<literal>interp_color_mode</literal>プロパティが<literal>"on"</literal>に設定された
187
際にポリラインを塗る際に使用される色インデックスの
190
カラーマップインデックスの間隔を定義します.
192
インデックスがベクトルの最初の2つの要素の間にある各色により塗りつぶされます.
193
これはポリラインが 3 または 4つの点で定義されている場合のみ適用可能です.
194
このため,ベクトルの大きさはこの次元に一致している必要があります.
199
<term>interp_color_mode: </term>
201
<para>このフィールドはポリラインを塗る際に補間影モードを
203
この値は<literal>"on"</literal> または<literal>"off"</literal>となります.
204
"on"に値を切り替える前に <literal>interp_color_vector</literal>を
210
<term>mark_mode: </term>
213
このフィールドはポリラインの<literal>mark_mode</literal>
215
この値は<literal>"on"</literal> (マーカを描画
216
drawn) または <literal>"off"</literal> (マーカを描画しない)となります.
221
<term>mark_style: </term>
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>プロパティに依存する
239
<imagedata fileref="../../images/marks.svg"/>
246
<term>mark_size_unit: </term>
249
このフィールは<literal>mark_size_unit</literal>プロパティのデフォルト値
250
を有します.<literal>mark_size_unit</literal>が<literal>"point"</literal>
251
に設定された場合,<literal>mark_size</literal>の値はポイント単位で直接
253
<literal>mark_size_unit</literal> に<literal>"tabulated"</literal>が
254
指定された場合,<literal>mark_size</literal>はfont size配列に相対的に
256
8pt, 10pt, 12pt, 14pt, 18pt および 24pt を意味する
258
<link linkend="xrect">xrect</link>および Scilabのネーティブ関数は
259
<literal>tabulated</literal>モードをデフォルトとします;
260
<link linkend="plot">plot</link>関数を使用する場合,
261
<literal>point</literal> モードが自動的に有効となります.
266
<term>mark_size: </term>
269
<literal>mark_size</literal>プロパティは,
270
<literal>mark_mode</literal>プロパティが<literal>"on"</literal>の時,
271
マーカの大きさを選択するために使用されます.
272
この値は, 8pt, 10pt, 12pt, 14pt, 18pt および 24pt を意味する
278
<term>mark_foreground: </term>
281
このフィールドは,マーカの縁の色である<literal>mark_foreground</literal>
282
プロパティの値を有します.この値は(カレントのcolor_mapに関連する)色インデックス
283
または透過エッジを意味する 0 とします.
288
<term>mark_background: </term>
290
<para>このフィールドは,マーカの前景色である
291
<literal>mark_background</literal>プロパティの値を有します.
292
この値は(カレントのcolor_mapに関連する)色インデックス
293
または透過エッジを意味する 0 とします.
298
<term>x_shift: </term>
301
このフィールドは関数<link linkend="bar">bar</link>をコールする
303
(または<link linkend="barhomogenize">barhomogenize</link>を
304
コールすることにより再計算される)オフセットを有し,
305
見栄えの良い垂直棒グラフを作成するために使用されます.
306
このオフセットは他の<literal>polyline_style</literal>にも
313
<term>y_shift: </term>
316
このフィールドは関数<link linkend="bar">bar</link>をコールする
318
(または<link linkend="barhomogenize">barhomogenize</link>を
319
コールすることにより再計算される)オフセットを有し,
320
見栄えの良い水平棒グラフを作成するために使用されます.
321
このオフセットは他の<literal>polyline_style</literal>にも
328
<term>z_shift: </term>
330
<para>このフィールドはユーザが指定する
332
このオフセットは他の<literal>polyline_style</literal>にも
334
このユニットはユーザ座標で表されています.
339
<term>bar_width: </term>
342
<literal>polyline_style</literal> が棒グラフモード (ケース 6)に
350
<term>clip_state: </term>
353
このフィールドはポリラインの<literal>clip_state</literal>プロパティの
359
<literal>"off"</literal> ポリラインはクリップされません.
364
<literal>"clipgrf"</literal> ポリラインはAxesボックスの外側でクリップ
370
<literal>"on"</literal>ポリラインはclip_boxプロパティで
378
<term>clip_box: </term>
381
このフィールドは<literal>clip_box</literal>プロパティを定義します.
382
clip_state が "off" の場合, デフォルトで,この値は空の行列です.
383
その他の場合, ベクトル <literal>[x,y,w,h]</literal> (左上の点 幅 高さ)
384
は表示するポリラインの部分を定義しますが,
385
<literal>clip_state</literal>プロパティの値が変更されます.
390
<term>user_data: </term>
392
<para>このフィールドはpolylineデータ構造体に任意のScilab変数を
401
<programlisting role="example"><![CDATA[
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" version="5.0-subset Scilab" xml:lang="ja" xml:id="polyline_properties">
15
<refname>polyline_properties</refname>
16
<refpurpose>Polylineエンティティプロパティの説明
21
<para>Polylineエンティティはグラフィックエンティティ階層の葉です. このエンティティは
28
<para>このフィールドには親のハンドルが含まれます.
29
polylineエンティティの親は<literal>"Axes"</literal> 型または
30
<literal>"Compound"</literal>型です.
35
<term>children: </term>
38
このプロパティにはこのハンドルの<literal>children</literal>
40
しかし,現在,polylineには<literal>children</literal>がありません.
45
<term>visible: </term>
48
このフィールドはこのエンティティの<literal>visible</literal>
50
値は<literal>"on" </literal> または <literal>"off"</literal>となります.
51
デフォルトで polyline は可視であり,プロパティの値は
52
<literal>"on" </literal>となります. <literal>"off"</literal> の場合,
60
<para>このフィールドはxおよびy座標の値を有します.
62
この値は,各点の座標を含む2(3)列の行列<literal>[x,y,[z]]</literal>です.
69
<para>このフィールドはポリラインが閉じているかどうかを定義します:
70
値は <literal>"on"</literal> または <literal>"off"</literal>となります
71
(デフォルト値はなく,ポリラインを作成する際に使用されたプリミティブに
77
<term>line_mode: </term>
80
このフィールドはポリラインの<literal>line_mode</literal>プロパティの
81
デフォルト値を有します. この値には <literal>"on" </literal>(線を描画
82
) または <literal>"off"</literal> (線を描画しない)を指定します.
87
<term>fill_mode: </term>
90
<literal>polyline_style</literal>フィールドが 5ではない場合, 曲線の
91
背景が<literal>background</literal> プロパティで定義した色で塗られます.
96
<term>line_style: </term>
99
<literal>line_style</literal>プロパティの値は[0 8]の範囲の整数となります.
100
0と1は実線を意味し,その他の値は破線を意味します
101
(<link linkend="axes_properties">getlinestyle</link>参照).
106
<term>thickness: </term>
108
<para>このプロパティはピクセル単位で線幅を指定する正の実数です.
109
実際の表示幅は指定された幅を最も近い整数に丸めることで定義されます.
110
唯一の例外はベクトル単位のエキスポートで,この場合は全体の
111
<literal>thickness</literal>の値が考慮されます.
116
<term>arrow_size_factor: </term>
118
<para>この整数によりポリラインに描かれる矢印の大きさを設定することができます.
119
実際の矢印の大きさは<literal>thickness</literal>とこのsize factorの
125
<term>polyline_style: </term>
127
<para>このプロパティは以下の各種のポリライン描画モードを設定します:</para>
130
<para>値が 0または1の場合,連続する2つの点の間に線が描画されます.</para>
133
<para>値が2の場合,ポリラインは階段プロットとなります.
134
連続する2つの点は水平線の後に垂直線が続く線により結合されます.
138
<para>値が3の場合,ポリラインは棒グラフとなります.
139
指定された各(x,y)について, (x,y) から
144
<para>値が 4の場合,連続する2つの点の間に矢印が描かれます.</para>
147
<para>値が5の場合,ポリラインは塗りつぶされます (パッチ).</para>
150
<para>値が 6の場合,ポリラインはMatlabに似たbarオブジェクトとなります.
151
プロパティ<literal>bar_shift</literal> および<literal>bar_width</literal>
159
<imagedata fileref="../../images/polyline_style.svg"/>
166
<term>foreground: </term>
168
<para>このフィールドにはポリラインを描画する際に使用される
169
<literal>foreground</literal>プロパティのデフォルト値が含まれます.
170
その値には(カレントのカラーマップに沿った)色インデックスを指定します.
175
<term>background: </term>
177
<para>このフィールドはポリラインの背景を塗りつぶす際に使用される色を有します.
178
その値には(カレントのカラーマップに沿った)色インデックスを指定します.
183
<term>interp_color_vector: </term>
186
<literal>interp_color_mode</literal>プロパティが<literal>"on"</literal>に設定された
187
際にポリラインを塗る際に使用される色インデックスの
190
カラーマップインデックスの間隔を定義します.
192
インデックスがベクトルの最初の2つの要素の間にある各色により塗りつぶされます.
193
これはポリラインが 3 または 4つの点で定義されている場合のみ適用可能です.
194
このため,ベクトルの大きさはこの次元に一致している必要があります.
199
<term>interp_color_mode: </term>
201
<para>このフィールドはポリラインを塗る際に補間影モードを
203
この値は<literal>"on"</literal> または<literal>"off"</literal>となります.
204
"on"に値を切り替える前に <literal>interp_color_vector</literal>を
210
<term>mark_mode: </term>
213
このフィールドはポリラインの<literal>mark_mode</literal>
215
この値は<literal>"on"</literal> (マーカを描画
216
drawn) または <literal>"off"</literal> (マーカを描画しない)となります.
221
<term>mark_style: </term>
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>プロパティに依存する
239
<imagedata fileref="../../images/marks.svg"/>
246
<term>mark_size_unit: </term>
249
このフィールは<literal>mark_size_unit</literal>プロパティのデフォルト値
250
を有します.<literal>mark_size_unit</literal>が<literal>"point"</literal>
251
に設定された場合,<literal>mark_size</literal>の値はポイント単位で直接
253
<literal>mark_size_unit</literal> に<literal>"tabulated"</literal>が
254
指定された場合,<literal>mark_size</literal>はfont size配列に相対的に
256
8pt, 10pt, 12pt, 14pt, 18pt および 24pt を意味する
258
<link linkend="xrect">xrect</link>および Scilabのネーティブ関数は
259
<literal>tabulated</literal>モードをデフォルトとします;
260
<link linkend="plot">plot</link>関数を使用する場合,
261
<literal>point</literal> モードが自動的に有効となります.
266
<term>mark_size: </term>
269
<literal>mark_size</literal>プロパティは,
270
<literal>mark_mode</literal>プロパティが<literal>"on"</literal>の時,
271
マーカの大きさを選択するために使用されます.
272
この値は, 8pt, 10pt, 12pt, 14pt, 18pt および 24pt を意味する
278
<term>mark_foreground: </term>
281
このフィールドは,マーカの縁の色である<literal>mark_foreground</literal>
282
プロパティの値を有します.この値は(カレントのcolor_mapに関連する)色インデックス
283
または透過エッジを意味する 0 とします.
288
<term>mark_background: </term>
290
<para>このフィールドは,マーカの前景色である
291
<literal>mark_background</literal>プロパティの値を有します.
292
この値は(カレントのcolor_mapに関連する)色インデックス
293
または透過エッジを意味する 0 とします.
298
<term>x_shift: </term>
301
このフィールドは関数<link linkend="bar">bar</link>をコールする
303
(または<link linkend="barhomogenize">barhomogenize</link>を
304
コールすることにより再計算される)オフセットを有し,
305
見栄えの良い垂直棒グラフを作成するために使用されます.
306
このオフセットは他の<literal>polyline_style</literal>にも
313
<term>y_shift: </term>
316
このフィールドは関数<link linkend="bar">bar</link>をコールする
318
(または<link linkend="barhomogenize">barhomogenize</link>を
319
コールすることにより再計算される)オフセットを有し,
320
見栄えの良い水平棒グラフを作成するために使用されます.
321
このオフセットは他の<literal>polyline_style</literal>にも
328
<term>z_shift: </term>
330
<para>このフィールドはユーザが指定する
332
このオフセットは他の<literal>polyline_style</literal>にも
334
このユニットはユーザ座標で表されています.
339
<term>bar_width: </term>
342
<literal>polyline_style</literal> が棒グラフモード (ケース 6)に
350
<term>clip_state: </term>
353
このフィールドはポリラインの<literal>clip_state</literal>プロパティの
359
<literal>"off"</literal> ポリラインはクリップされません.
364
<literal>"clipgrf"</literal> ポリラインはAxesボックスの外側でクリップ
370
<literal>"on"</literal>ポリラインはclip_boxプロパティで
378
<term>clip_box: </term>
381
このフィールドは<literal>clip_box</literal>プロパティを定義します.
382
clip_state が "off" の場合, デフォルトで,この値は空の行列です.
383
その他の場合, ベクトル <literal>[x,y,w,h]</literal> (左上の点 幅 高さ)
384
は表示するポリラインの部分を定義しますが,
385
<literal>clip_state</literal>プロパティの値が変更されます.
390
<term>user_data: </term>
392
<para>このフィールドはpolylineデータ構造体に任意のScilab変数を
402
a=get("current_axes")
403
a.data_bounds=[-2,-2;2,2];
405
xpoly(sin(2*%pi*(0:5)/5),cos(2*%pi*(0:5)/5),"lines",0)
410
d=p.data;d(1,:)=[0 0];p.data=d;
411
a.rotation_angles=[0 45];
416
<programlisting role="example"><![CDATA[
402
417
a=get("current_axes")//新規に作成された軸のハンドルを取得
403
418
a.data_bounds=[-2,-2;2,2];