7cb53ef9bfc58df128de1983efb7045e4d7d83a6
[scilab.git] / scilab / modules / graphics / help / ja_JP / figure_operations / figure_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  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
17           xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
18           xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
19           xml:lang="ja" xml:id="figure_properties">
20     <refnamediv>
21         <refname>figure_properties</refname>
22         <refpurpose>グラフィックエンティティプロパティの説明</refpurpose>
23     </refnamediv>
24     <refsection>
25         <title>説明</title>
26         <para>
27             figureエンティティはグラフィックエンティティ階層の最上位です.
28             このエンティティにはScilabグラフィックオブジェクトの表示に
29             関する多くの要素を制御するために設計された多くのプロパティが
30             含まれています.
31             これらのプロパティは,図(figure)自体に関する情報を含むプロパティと,
32             子作成時のデフォルト値の設定に関連するプロパティの
33             2つのカテゴリに分けることができます.
34         </para>
35         <variablelist>
36             <varlistentry>
37                 <term>figure プロパティ: </term>
38                 <listitem>
39                     <variablelist>
40                         <varlistentry>
41                             <term>children: </term>
42                             <listitem>
43                                 <para>
44                                     このハンドルは図(figure)の子のベクトルを表します.
45                                     図の子は全て<literal>"Axes"</literal>であることに注意してください.
46                                     また,(<link linkend="scf">scf</link> コマンドにより)図のエンティティを作成する際,
47                                     同時に
48                                     <literal>Axes</literal>エンティティも一つ作成されることも覚えておいてください.
49                                 </para>
50                             </listitem>
51                         </varlistentry>
52                         <varlistentry>
53                             <term>figure_position: </term>
54                             <listitem>
55                                 <para>
56                                     このフィールドはスクリーン上でのグラフィックウインドウのピクセル単位の
57                                     位置を保持します.
58                                     これはウインドウの左上隅の位置を定義するベクトル<literal>[x,y]</literal>です.
59                                     位置 <literal>[0,0]</literal> は画面の左上隅です.
60                                 </para>
61                                 <para>
62                                     グラフィックウインドウの初期位置はデフォルトの figure エンティティ
63                                     (<link linkend="gdf">gdf</link>参照)により指定されます.
64                                     唯一の例外は,
65                                     デフォルトの図の値<literal>figure_position</literal>が<literal>[-1,-1]</literal>
66                                     の場合です.
67                                     この場合,グラフィックウインドウの初期位置はウインドウシステムにより自動的に
68                                     設定されます.
69                                 </para>
70                             </listitem>
71                         </varlistentry>
72                         <varlistentry>
73                             <term>figure_size: </term>
74                             <listitem>
75                                 <para>
76                                     このプロパティは画面のグラフィックウインドウのピクセル単位の
77                                     大きさを制御します.この大きさはベクトル<literal>[width,height]</literal>
78                                     です.
79                                 </para>
80                             </listitem>
81                         </varlistentry>
82                         <varlistentry>
83                             <term>axes_size: </term>
84                             <listitem>
85                                 <para>
86                                     仮想グラフィックウインドウにおけるピクセル単位の大きさを
87                                     指定する際に使用されます.
88                                     この大きさはベクトル <literal>[width,height] </literal> です.
89                                     仮想グラフィックウインドウは画面で実際に可視となる領域よりも
90                                     大きくなります.
91                                     このプロパティは図が他の要素に結合されている場合には修正することができません.
92                                 </para>
93                             </listitem>
94                         </varlistentry>
95                         <varlistentry>
96                             <term>auto_resize: </term>
97                             <listitem>
98                                 <para>
99                                     このプロパティはグラフィックウインドウの大きさの変更動作
100                                     を定義します.
101                                     この値が <literal>"on"</literal>の場合,<literal>axes_size</literal>
102                                     プロパティは <literal>figure_size</literal>に等しくなり,
103                                     子である軸自動的に拡大・縮小されます.
104                                     この値が<literal>"off"</literal> の場合,
105                                     <literal>figure_size</literal>が変更された場合でも
106                                     <literal>axes_size</literal>は変更されません.
107                                 </para>
108                             </listitem>
109                         </varlistentry>
110                         <varlistentry>
111                             <term>viewport: </term>
112                             <listitem>
113                                 <para>図の可視部分の位置.</para>
114                             </listitem>
115                         </varlistentry>
116                         <varlistentry>
117                             <term>figure_name or name:</term>
118                             <listitem>
119                                 <para>
120                                     このフィールドは図の名称を保持します.
121                                     この名称はグラフィックウインドウ上の最上部に表示される
122                                     文字列です.
123                                     この名称には文字列<literal>%d</literal>を一つ含めることができ,
124                                     この部分は<literal>figure_id</literal>で置換されます.
125                                     その他の<literal>%</literal>文字のインスタンスは名称の中で使用できません.
126                                 </para>
127                             </listitem>
128                         </varlistentry>
129                         <varlistentry>
130                             <term>figure_id: </term>
131                             <listitem>
132                                 <para>
133                                     このフィールドは図のIDを保持します.
134                                     これは図の生成時に設定される整数で,後で変更することはできません.
135                                 </para>
136                             </listitem>
137                         </varlistentry>
138                         <varlistentry>
139                             <term>color_map: </term>
140                             <listitem>
141                                 <para>
142                                     この図で使用されるカラーマップを定義するプロパティ.
143                                     カラーマップは <literal>m</literal> 行 <literal>3</literal>列の行列です.
144                                     <literal>m</literal>は色の数です.色番号 i は
145                                     <literal>R</literal>, <literal>G</literal>, <literal>B</literal>の3要素で
146                                     指定し,それぞれ, 0 から 1の間の赤,緑,青の輝度に対応します.
147                                 </para>
148                             </listitem>
149                         </varlistentry>
150                         <varlistentry>
151                             <term>pixel_drawing_mode: </term>
152                             <listitem>
153                                 <para>
154                                     このフィールドは画面上のピクセルの描画で使用されるビット単位の処理を定義します.
155                                     デフォルトのモードは <literal>copy</literal>です.
156                                     詳細については,<link linkend="pixel_drawing_mode">ピクセル描画モード参照ページ</link>
157                                     を参照ください.
158                                 </para>
159                             </listitem>
160                         </varlistentry>
161                         <varlistentry>
162                             <term>anti_aliasing: </term>
163                             <listitem>
164                                 <para>
165                                     このプロパティはグラフィックの品質を改善する際に使用される
166                                     アンチエイリアス処理のレベルを制御します.
167                                     このプロパティが "off" に設定された場合,アンチエイリアス処理は無効になります.
168                                     アンチエイリアス処理を有効にするには,"2x", "4x", "8x"または "16x"のどれかを
169                                     指定することが必要です.
170                                     この場合, この値はアンチエイリアスのレベルを意味します.例えば,
171                                     例えば, "16x" は "2x"よりも高い品質となります.
172                                     より高いアンチエイリアスのレベルを指定することにより画像の品質は改善されますが,
173                                     グラフィック性能は低下します.
174                                     Please visit the <link linkend="anti_aliasing">dedicated page</link>
175                                     to see specific examples.
176                                 </para>
177                             </listitem>
178                         </varlistentry>
179                         <varlistentry>
180                             <term>immediate_drawing: </term>
181                             <listitem>
182                                 <para>
183                                     このプロパティは図の表示を制御します.
184                                     この値は
185                                     <literal>"on"</literal> (デフォルトモード) または <literal>"off"</literal>です.
186                                     (複数の描画や再描画を適用することにより)グラフィックスコマンドが大量に連続する場合に,
187                                     表示を遅延させるために使用されます.
188                                     <literal>drawlater</literal> または <literal>drawnow</literal> コマンドを
189                                     使用した場合, カレントの図のプロパティの値を変更することに注意してください
190                                     (それぞれ,この値を<literal>'off'</literal> または
191                                     <literal>'on'</literal>に変更します).
192                                 </para>
193                             </listitem>
194                         </varlistentry>
195                         <varlistentry>
196                             <term>background: </term>
197                             <listitem>
198                                 <para>
199                                     このプロパティは図の背景を制御します.
200                                     カレントのカラーマップに関連する添え字を値として指定します.
201                                 </para>
202                             </listitem>
203                         </varlistentry>
204                         <varlistentry>
205                             <term>event_handler</term>
206                             <listitem>
207                                 <para>
208                                     文字列. イベントを処理を受け持つScilab 関数の名前.
209                                     空の文字列を指定するとイベントハンドラが無効となることに注意してください.
210                                     イベントハンドラに関する詳細は
211                                     <link linkend="eventhandlerfunctions">イベントハンドラ関数</link> ヘルプを
212                                     参照してください.
213                                 </para>
214                             </listitem>
215                         </varlistentry>
216                         <varlistentry>
217                             <term>event_handler_enable</term>
218                             <listitem>
219                                 <para>イベントハンドラを有効または無効にします. 値は "on" または "off" のどちらかです.
220                                 </para>
221                             </listitem>
222                         </varlistentry>
223                         <varlistentry>
224                             <term>user_data: </term>
225                             <listitem>
226                                 <para>このフィールドは図のデータ構造に何らかのScilab変数を保存したり,
227                                     取得したりするために使用することができます.
228                                 </para>
229                             </listitem>
230                         </varlistentry>
231                         <varlistentry>
232                             <term>tag: </term>
233                             <listitem>
234                                 <para>このフィールドは一般に制御を識別するための文字列を保存するために使用できます.
235                                     これにより"名前"を指定することが可能となります.
236                                     主にfindobj()との組み合わせで使用されます.
237                                 </para>
238                             </listitem>
239                         </varlistentry>
240                         <varlistentry>
241                             <term>resizefcn: </term>
242                             <listitem>
243                                 <para>
244                                     このフィールドは,このScilab関数名またはScilab式を文字列として保存する際に使用されます.
245                                     この文字列は,ユーザが図をリサイズした際および図の作成時に評価されます.
246                                 </para>
247                             </listitem>
248                         </varlistentry>
249                         <varlistentry>
250                             <term>closerequestfcn: </term>
251                             <listitem>
252                                 <para>
253                                     このフィールドは,このScilab関数名またはScilab式を文字列として保存する際に使用されます.
254                                     この文字列は,ユーザが図を右上の十字により図を閉じようとした際に評価されます.
255                                 </para>
256                                 <para>
257                                     このプロパティが設定された際, "figure closed" イベント (-1000) は
258                                     イベントハンドラ関数でトラップされなくなります.
259                                 </para>
260                             </listitem>
261                         </varlistentry>
262                         <varlistentry>
263                             <term>resize: </term>
264                             <listitem>
265                                 <para>
266                                     このプロパティは図の大きさをロックします.
267                                     値は,
268                                     <literal>"on"</literal> (デフォルト値) または <literal>"off"</literal>
269                                     (図は,マウスイベントによりリサイズできません)とします. Resizing the figure
270                                     is always possible with <literal>.figure_size</literal>.
271                                 </para>
272                             </listitem>
273                         </varlistentry>
274                         <varlistentry>
275                             <term>menubar_visible: </term>
276                             <listitem>
277                                 <para>
278                                     このプロパティは図のメニューバーの可視性を制御します.値は,
279                                     <literal>"on"</literal> (デフォルト値) または <literal>"off"</literal>とします.
280                                 </para>
281                             </listitem>
282                         </varlistentry>
283                         <varlistentry>
284                             <term>toolbar_visible: </term>
285                             <listitem>
286                                 <para>
287                                     このプロパティは図のツールバーの可視性を制御します.値は,
288                                     <literal>"on"</literal> (デフォルト値) または <literal>"off"</literal>とします.
289                                 </para>
290                             </listitem>
291                         </varlistentry>
292                         <varlistentry>
293                             <term>infobar_visible: </term>
294                             <listitem>
295                                 <para>
296                                     このプロパティは図の図のステータスバーの可視性を制御します.値は,
297                                     <literal>"on"</literal> (デフォルト値) または <literal>"off"</literal>とします.
298                                 </para>
299                             </listitem>
300                         </varlistentry>
301                         <varlistentry>
302                             <term>info_message: </term>
303                             <listitem>
304                                 <para>この文字列はグラフィックウインドウの情報バーに表示されるテキストを指定します.</para>
305                             </listitem>
306                         </varlistentry>
307                         <varlistentry>
308                             <term>visible: </term>
309                             <listitem>
310                                 <para>
311                                     図の <literal>"dockable"</literal> プロパティが <literal>"off"</literal>の場合,
312                                     <literal>"Visible"</literal> プロパティを設定すると
313                                     ウインドウの装飾を含む図全体に影響します.
314                                 </para>
315                                 <para>
316                                     図の <literal>"dockable"</literal> プロパティが <literal>"on"</literal>で,
317                                     図が同じ親ウインドウの他の図に結合されている場合,
318                                     このフィールドは図の子にのみ作用します(以下の関連部分を参照).
319                                     図が他の図に結合されていない場合,
320                                     <literal>"Visible"</literal> プロパティは
321                                     <literal>"dockable"</literal>プロパティが<literal>"off"</literal>に設定された場合と
322                                     同様に動作します.
323                                 </para>
324                             </listitem>
325                         </varlistentry>
326                         <varlistentry>
327                             <term>layout: </term>
328                             <listitem>
329                                 <para>
330                                     このプロパティは図の子を並べる際に使用されるレイアウトを設定します.
331                                     利用可能なレイアウトに関する詳細については
332                                     <link linkend="layout">レイアウト</link> のページを参照ください.
333                                 </para>
334                             </listitem>
335                         </varlistentry>
336                         <varlistentry>
337                             <term>layout_options: </term>
338                             <listitem>
339                                 <para>
340                                     このプロパティは図の子を並べる際に使用されるレイアウトのオプションを設定します.
341                                     利用可能なオプションに関する詳細については
342                                     <link linkend="layout">レイアウト</link> のページを参照ください.
343                                 </para>
344                             </listitem>
345                         </varlistentry>
346                         <varlistentry>
347                             <term>icon: </term>
348                             <listitem>
349                                 <para>このフィールドはScilab図のアイコンをカスタマイズする際に使用します.</para>
350                                 <para>
351                                     この値は,アイコンを保持する画像ファイルへの
352                                     絶対またはScilab<link linkend="pwd">カレントのワーキングディレクトリ</link>への
353                                     相対パスを有する文字列です.
354                                 </para>
355                             </listitem>
356                         </varlistentry>
357                         <varlistentry>
358                             <term>default_axes: </term>
359                             <listitem>
360                                 <para>
361                                     <literal>"on"</literal> (default value) means that the figure has always
362                                     a default axes: it is automatically set at the figure creation,
363                                     or automatically reset when the last axes of the figure is
364                                     intentionally deleted.
365                                 </para>
366                                 <para>
367                                     <literal>"off"</literal> means that
368                                     <itemizedlist>
369                                         <listitem>
370                                             the newly created figure has no default axes.
371                                         </listitem>
372                                         <listitem>
373                                             for an existing figure, it is possible to actually delete
374                                             all its existing axes.
375                                         </listitem>
376                                     </itemizedlist>
377                                     In both cases,
378                                     <itemizedlist>
379                                         <listitem>
380                                             without any axes, the figure can't be the default
381                                             target of any plotting instruction. This feature
382                                             can be used to protect an interactive interface built in a
383                                             figure (like the demos and the ATOMS ones) from being the default
384                                             plotting target when there is no other proper opened
385                                             graphical figures.
386                                         </listitem>
387                                         <listitem>
388                                             It is still possible to force creating an axes using the
389                                             <link linkend="newaxes">newaxes</link> function.
390                                         </listitem>
391                                     </itemizedlist>
392                                 </para>
393                             </listitem>
394                         </varlistentry>
395                     </variablelist>
396                 </listitem>
397             </varlistentry>
398         </variablelist>
399         <variablelist>
400             <varlistentry>
401                 <term>子のデフォルト値: </term>
402                 <listitem>
403                     <variablelist>
404                         <varlistentry>
405                             <term>visible: </term>
406                             <listitem>
407                                 <para>このフィールドは,
408                                     図の内容が再描画されるかどうかを定義します.
409                                     この値は <literal>"on"</literal> または
410                                     <literal>"off"</literal>となります.
411                                 </para>
412                             </listitem>
413                         </varlistentry>
414                         <varlistentry>
415                             <term>rotation_style: </term>
416                             <listitem>
417                                 <para>
418                                     このフィールドは "3D Rot"(3次元回転) ボタンに関係します.
419                                     デフォルトは,選択された3次元プロットのみが回転することを意味する
420                                     <literal>unary</literal>となっています.
421                                     この値は,全ての3次元プロットが回転することを意味する <literal>multiple</literal>
422                                     とすることができます.
423                                 </para>
424                             </listitem>
425                         </varlistentry>
426                     </variablelist>
427                 </listitem>
428             </varlistentry>
429         </variablelist>
430         <variablelist>
431             <varlistentry>
432                 <term>作成関連のプロパティ: </term>
433                 <para>
434                     いくつかのプロパティは,
435                     <link linkend="figure">figure</link> 関数により作成時に設定でき,その後は読込み専用となります.
436                 </para>
437                 <listitem>
438                     <variablelist>
439                         <varlistentry>
440                             <term>dockable</term>
441                             <listitem>
442                                 <para>
443                                     このプロパティは作成されるウインドウがScilab環境の中で結合できるかどうかを定義します.
444                                     この値が<literal>"on"</literal> の場合,
445                                     ウインドウにユーザが結合/結合解除することを可能にするバーが追加されます.
446                                     そうでない場合,ウインドウは通常のOSウインドウのようになります.
447                                     この値は作成時にのみ指定できます.
448                                 </para>
449                             </listitem>
450                         </varlistentry>
451                         <varlistentry>
452                             <term>menubar</term>
453                             <listitem>
454                                 <para>{"figure"} | "none"</para>
455                                 <para>
456                                     このプロパティは図のメニューバーの型を定義します.
457                                     この値が<literal>"none"</literal>の場合,
458                                     <link linkend="uimenu">uimenu function</link>によりメニューが追加されるまで
459                                     メニューバーが現れなくなります.
460                                     そうでない場合,デフォルトの図メニューが作成されます.
461                                     この値は作成時にのみ指定できます.
462                                 </para>
463                             </listitem>
464                         </varlistentry>
465                         <varlistentry>
466                             <term>toolbar</term>
467                             <listitem>
468                                 <para>{"figure"} | "none"</para>
469                                 <para>
470                                     このプロパティは図のツールバーの型を定義します.
471                                     この値が<literal>"none"</literal>の場合,ウインドウに
472                                     ツールバーが現れなくなります.
473                                     そうでない場合,デフォルトのツールバーが作成されます.
474                                     この値は作成時にのみ指定できます.
475                                 </para>
476                             </listitem>
477                         </varlistentry>
478                     </variablelist>
479                 </listitem>
480             </varlistentry>
481             <varlistentry>
482                 <term>デフォルト値に関する注記 :</term>
483                 <listitem>
484                     <variablelist>
485                         <varlistentry>
486                             <term/>
487                             <listitem>
488                                 <para>
489                                     上記リストに提示した全てのプロパティとフィールドは,
490                                     figureモデルに保存されたデフォルト値から継承されたものです
491                                     これらのデフォルト値は,参照したり,変更したりすることができます.
492                                     これを行うには,<literal>get("default_figure")</literal>コマンドを
493                                     使用してください.これにより,figureモデルのグラフィックウインドウが
494                                     取得できます.
495                                     このコマンドにより特定のグラフィックウインドウが作成されるわけではない
496                                     ことに注意してください.
497                                     次に作成される図はこのモデルから継承されます
498                                     (下記の例2を参照).
499                                 </para>
500                             </listitem>
501                         </varlistentry>
502                     </variablelist>
503                 </listitem>
504             </varlistentry>
505         </variablelist>
506     </refsection>
507     <refsection>
508         <title>例</title>
509         <programlisting role="example"><![CDATA[
510 lines(0) // 垂直ページングを無効に
511
512 //例 1
513 f=get("current_figure") //カレント図のハンドルを取得 :
514                         //存在しない場合,図を作成,ハンドルを返す
515 f.figure_position
516 f.figure_size=[200,200]
517 f.background=2
518 f.children  // axesエンティティが既に存在することを確認
519 delete(f);
520 f=gcf(); // マクロショートカット <=> f=get("current_figure")
521 plot2d() // 画面には何も起こりません...
522
523 //例 2 : default_figure 設定
524 df=get("default_figure") // デフォルト値を取得 (ショートカットは gdf() )
525 // デフォルトを変更...
526 df.color_map=hotcolormap(128)
527 df.background= 110 // 背景を黄色に設定 (既存のカラーマップ内の色添字を使用することに注意)
528 scf(122); // 新規デフォルトで図番122の図を新規作成
529 plot2d()
530 scf(214);
531 t=-%pi:0.3:%pi;
532 plot3d(t,t,sin(t)'*cos(t),35,45,'X@Y@Z',[15,2,4]);
533  ]]></programlisting>
534     </refsection>
535     <refsection>
536         <title>参考</title>
537         <simplelist type="inline">
538             <member>
539                 <link linkend="eventhandlerfunctions">event handler functions</link>
540             </member>
541             <member>
542                 <link linkend="pixel_drawing_mode">pixel_drawing_mode</link>
543             </member>
544             <member>
545                 <link linkend="anti_aliasing">anti_aliasing</link>
546             </member>
547             <member>
548                 <link linkend="colormap">colormap</link>
549             </member>
550             <member>
551                 <link linkend="xname">xname</link>
552             </member>
553             <member>
554                 <link linkend="scf">scf</link>
555             </member>
556             <member>
557                 <link linkend="gcf">gcf</link>
558             </member>
559             <member>
560                 <link linkend="gdf">gdf</link>
561             </member>
562             <member>
563                 <link linkend="findobj">findobj</link>
564             </member>
565             <member>
566                 <link linkend="axes_properties">axes_properties</link>
567             </member>
568             <member>
569                 <link linkend="set">set</link>
570             </member>
571             <member>
572                 <link linkend="get">get</link>
573             </member>
574         </simplelist>
575     </refsection>
576     <refsection>
577         <title>履歴</title>
578         <revhistory>
579             <revision>
580                 <revnumber>5.5.0</revnumber>
581                 <revremark>
582                     <itemizedlist>
583                         <listitem>"visible" プロパティの意味が変更されました (uicontrols が管理し,いくつかのケースでは図全体を不可視にできるようになりました.</listitem>
584                         <listitem>"icon" プロパティが追加され,図のアイコンを変更できるようになりました.</listitem>
585                         <listitem>"menubar_visible" プロパティ追加.</listitem>
586                         <listitem>"toolbar_visible" プロパティ追加.</listitem>
587                         <listitem>"infobar_visible" プロパティ追加.</listitem>
588                         <listitem>"resize" プロパティ追加.</listitem>
589                         <listitem>"dockable" プロパティ追加.</listitem>
590                         <listitem>"menubar" プロパティ追加.</listitem>
591                         <listitem>"toolbar" プロパティ追加.</listitem>
592                         <listitem>"default_axes" プロパティ追加.</listitem>
593                         <listitem>"layout" プロパティ追加.</listitem>
594                         <listitem>"layout_options" プロパティ追加.</listitem>
595                     </itemizedlist>
596                 </revremark>
597             </revision>
598             <revision>
599                 <revnumber>5.4.0</revnumber>
600                 <revremark>resizefcn &amp; closerequestfcn プロパティが追加されました.</revremark>
601             </revision>
602         </revhistory>
603     </refsection>
604 </refentry>