a11e9358f460d9eaf8eddb6ee24f9e17cbff68f2
[scilab.git] / scilab / modules / gui / help / ja_JP / figure.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <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="figure">
3     <refnamediv>
4         <refname>figure</refname>
5         <refpurpose>図を作成する</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>呼び出し手順</title>
9         <synopsis>
10             f = figure(num);
11             f = figure("PropertyName1", Propertyvalue1, ..., ..., "PropertyNameN", PropertyvalueN);
12         </synopsis>
13     </refsynopsisdiv>
14     <refsection>
15         <title>説明</title>
16         <para>
17             このルーチンは図を作成します. IDが指定された場合,
18             このIDに対応する図が作成されます.
19             それ以外の場合,
20             ウインドウは最初のフリーなID,すなわちウインドウで使用されていない
21             最小の番号で作成されます.
22         </para>
23     </refsection>
24     <refsection>
25         <title>引数</title>
26         <variablelist>
27             <varlistentry>
28                 <term>num</term>
29                 <listitem>
30                     <para>作成するウインドウのID.
31                         指定されない場合, 最初のフリーなIDが使用されます.
32                     </para>
33                 </listitem>
34             </varlistentry>
35             <varlistentry>
36                 <term>PropertyName{1, ..., N}</term>
37                 <listitem>
38                     <para>
39                         設定するプロパティ名の文字列,
40                         以下に一覧を示すプロパティ名のどれか.
41                     </para>
42                 </listitem>
43             </varlistentry>
44             <varlistentry>
45                 <term>PropertyValue{1, ..., N}</term>
46                 <listitem>
47                     <para>
48                         対応するプロパティに指定するscilabオブジェクトの値.
49                     </para>
50                 </listitem>
51             </varlistentry>
52             <varlistentry>
53                 <term>f</term>
54                 <listitem>
55                     <para>新規に作成されたウインドウのハンドル.</para>
56                 </listitem>
57             </varlistentry>
58         </variablelist>
59     </refsection>
60     <refsection>
61         <title>プロパティ</title>
62         <variablelist>
63             <varlistentry>
64                 <term>BackgroundColor</term>
65                 <listitem>
66                     <para>
67                         図の背景色を表す実数ベクトル [1,3] または文字列.
68                         色は赤, 緑および青の値で指定します.
69                         これらの値は[0,1]の範囲の実数です.
70                         色は実数ベクトル,すなわち[R,G,B]または
71                         "|"で区切られた文字列,すなわち"R|G|B"
72                         で指定できます.
73                     </para>
74                 </listitem>
75             </varlistentry>
76             <varlistentry>
77                 <term>Figure_name</term>
78                 <listitem>
79                     <para>文字列, 図の表題を設定できます.
80                     </para>
81                 </listitem>
82             </varlistentry>
83             <varlistentry>
84                 <term>ForegroundColor</term>
85                 <listitem>
86                     <para>
87                         図の表面色を表す実数ベクトル [1,3] または文字列.
88                         色は赤, 緑および青の値で指定します.
89                         これらの値は[0,1]の範囲の実数です.
90                         色は実数ベクトル,すなわち[R,G,B]または
91                         "|"で区切られた文字列,すなわち"R|G|B"
92                         で指定できます.
93                     </para>
94                 </listitem>
95             </varlistentry>
96             <varlistentry>
97                 <term>Position</term>
98                 <listitem>
99                     <para>
100                         これにより図の外観を制御できます.
101                         [1,4]の実数ベクトルで, [x y width height]
102                         各文字は左上隅の位置x,左上隅の位置y,
103                         仮想グラフィックウインドウの幅と高さ
104                         (uicontrolsおよびグラフィックを有する図の部分)
105                         を意味します.
106                         <link linkend="figure_properties">図のプロパティ</link>
107                         のヘルプページで説明された
108                         <emphasis role="bold">axes_size</emphasis>プロパティ
109                         を参照してください.
110                         "x|y|width|height"のように
111                         フィールドを"|"で区切った文字列によりこのプロパティを
112                         指定することもできます.
113                     </para>
114                 </listitem>
115             </varlistentry>
116             <varlistentry>
117                 <term>Tag</term>
118                 <listitem>
119                     <para>
120                         文字列で,このプロパティは一般に図を特定する際に使用されます.
121                         これにより,"名前"を付けることができるようになります.
122                         主にfindobj()と組み合わせて使用されます.
123                     </para>
124                 </listitem>
125             </varlistentry>
126             <varlistentry>
127                 <term>Userdata</term>
128                 <listitem>
129                     <para>
130                         図に何らかのScilabオブジェクトを関連付ける際に使用できます.
131                     </para>
132                 </listitem>
133             </varlistentry>
134         </variablelist>
135     </refsection>
136     <refsection>
137         <title>例</title>
138         <programlisting role="example"><![CDATA[
139 // figure_id==3の図を作成します
140 h=figure(3);
141 // 図3にテキストuicontrolを追加します
142 uicontrol(h, "style", "text", ...
143              "string", "This is a figure", ...
144              "position", [50 70 100 100], ...
145              "fontsize",15);
146 // figure_id==1の図を作成します
147 figure();
148 // 図1のテキストuicontrolを追加します
149 uicontrol("style", "text", ...
150           "string", "Another figure", ...
151           "position", [50 70 100 100], ...
152           "fontsize", 15);
153 // カレントの図(すなわち,図1)を閉じる
154 close();
155 // 図3を閉じる
156 close(h);
157  ]]></programlisting>
158     </refsection>
159     <refsection role="see also">
160         <title>参照</title>
161         <simplelist type="inline">
162             <member>
163                 <link linkend="close">close</link>
164             </member>
165             <member>
166                 <link linkend="gcf">gcf</link>
167             </member>
168         </simplelist>
169     </refsection>
170 </refentry>