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 * Copyright (C) INRIA - Jean-Baptiste silvy
6 * Copyright (C) 2018 - Samuel GOUGEON
7 *
8 * Copyright (C) 2012 - 2016 - Scilab Enterprises
9 *
10 * This file is hereby licensed under the terms of the GNU GPL v2.0,
11 * pursuant to article 5.3.4 of the CeCILL v.2.1.
12 * This file was originally licensed under the terms of the CeCILL v2.1,
13 * and continues to be available under such terms.
14 * For more information, see the COPYING file which you should have received
15 * along with this program.
16 *
17 -->
18<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
19    xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
20    xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
21    xml:lang="ja" xml:id="text_properties">
22    <refnamediv>
23        <refname>text_properties</refname>
24        <refpurpose>Textエンティティプロパティの説明</refpurpose>
25    </refnamediv>
26    <refsection>
27        <title>説明</title>
28        <para>Textエンティティはグラフィックエンティティ階層の葉です.
29            このエンティティは文字列描画用のパラメータを定義します.
30        </para>
31        <variablelist>
32            <varlistentry>
33                <term>parent: </term>
34                <listitem>
35                    <para>このフィールドには親のハンドルが含まれます.
36                        textエンティティの親は<literal>"Axes"</literal> 型または
37                        <literal>"Compound"</literal>型です.
38                    </para>
39                </listitem>
40            </varlistentry>
41            <varlistentry>
42                <term>children: </term>
43                <listitem>
44                    <para>
45                        このプロパティにはこのハンドルの<literal>children</literal>
46                        のベクトルが含まれます.
47                        しかし,現在, textハンドルには<literal>children</literal>がありません.
48                    </para>
49                </listitem>
50            </varlistentry>
51            <varlistentry>
52                <term>visible: </term>
53                <listitem>
54                    <para>
55                        このフィールドはエンティティの <literal>visible</literal> プロパティを有します.
56                        この値は, "on" または "off"とします. デフォルトでテキストは可視で,
57                        このプロパティの値は "on" です. "off" の場合, テキストは画面に表示されません.
58                    </para>
59                </listitem>
60            </varlistentry>
61            <varlistentry>
62                <term>text: </term>
63                <listitem>
64                    <para>オブジェクトの文字列を保持する行列.行列の各行は
65                        水平に表示され,列は縦方向に表示されます.
66                    </para>
67                </listitem>
68            </varlistentry>
69            <varlistentry>
70                <term>data: </term>
71                <listitem>
72                    <para>
73                        ベクトル<literal>[x、y、[z]]</literal>は、テキストブロックのピボットの位置を軸のデータ単位で設定します。
74                        デフォルトでは、ピボットはテキストブロックのフレーミングボックスの左下隅に設定されています。
75                    </para>
76                    <note>
77                        <literal>e = gce（）; e.text_box = [0 0]; e.text_box_mode = "centered"</literal>
78                        ピボット上にフレーミングボックスを配置するので、<literal>.data </literal> ポジション。
79                    </note>
80                </listitem>
81            </varlistentry>
82            <varlistentry>
83                <term>font_angle: </term>
84                <listitem>
85                    <para>このプロパティは、ピボットの周りのテキストブロックの向きを設定します。
86                    （0-右）方向から時計回りに回転する（これは間違いなく
87                    フォントの傾きには関係しません）。
88                    </para>
89                </listitem>
90            </varlistentry>
91            <varlistentry>
92                <term>alignment: </term>
93                <listitem>
94                    <para>文字列が列の中で整列される方法を指定します.値には,
95                        <literal>'left'</literal>, <literal>'center'</literal>
96                        または <literal>'right'</literal> を指定します. すべての列に適用されます。
97                    </para>
98                </listitem>
99            </varlistentry>
100            <varlistentry>
101                <term>font_style: </term>
102                <listitem>
103                    <para>
104                        文字列の表示に使用されるフォントを指定します.
105                        これはロード済みのフォントの一つを指す正の整数です.
106                        その値は最初のフォントを指す 0 から最後のフォントを指すロード済みの
107                        フォントの数から1を引いた数までとします.
108                        詳細については<link linkend="graphics_fonts">graphics_fonts</link>を参照ください.
109                    </para>
110                </listitem>
111            </varlistentry>
112            <varlistentry>
113                <term>font_foreground: </term>
114                <listitem>
115                    <para>このフィールドはテキストの文字を表示する際に使用される色を
116                        有します.色のインデックスは(カレントのカラーマップに基づく)色インデックス
117                        である必要があります.
118                    </para>
119                </listitem>
120            </varlistentry>
121            <varlistentry>
122                <term>font_size: </term>
123                <listitem>
124                    <para>
125                        表示される文字の大きさを指定するスカラー値です.
126                        <literal>fractional_font</literal>プロファイルが <literal>"off"</literal>の場合,
127                        値の整数部のみが使用されます.
128                        詳細については<link linkend="graphics_fonts">graphics_fonts</link>を参照ください.
129                    </para>
130                </listitem>
131            </varlistentry>
132            <varlistentry>
133                <term>fractional_font: </term>
134                <listitem>
135                    <para>このプロパティはテキストを分数のフォントサイズにより表示するかどうかを
136                        指定します.この値には,<literal>"on"</literal> または <literal>"off"</literal>を指定します.
137                        <literal>"on"</literal> の場合,<literal>font_size</literal>の浮動小数点の値が
138                        表示の際に使用され,フォントはアンチエイリアス処理されます.
139                        <literal>"off"</literal> の場合,整数部のみが使用され,フォントは平滑化されません.
140                    </para>
141                </listitem>
142            </varlistentry>
143            <varlistentry>
144                <term>box: </term>
145                <listitem>
146                    <para>
147                        このフィールドの値は,<literal>"on"</literal> または
148                        <literal>"off"</literal>です. <literal>"on"</literal>の場合,テキストの周囲に縁に線が引かれ,背景を有するボックスが描画されます.
149                    </para>
150                </listitem>
151            </varlistentry>
152            <varlistentry>
153                <term>line_mode: </term>
154                <listitem>
155                    <para>
156                        この論理値プロパティにより,<literal>box</literal> プロパティが
157                        <literal>"on"</literal>の時にボックスの周囲に線を描画するかどうかを指定できます.
158                        <literal>line_mode</literal> が <literal>"off"</literal>の場合,ボックスの線は
159                        描画されません.
160                    </para>
161                </listitem>
162            </varlistentry>
163            <varlistentry>
164                <term>foreground: </term>
165                <listitem>
166                    <para>このフィールドはボックスの周りに線を表示する際に使用される色を
167                        有します.この値は(カレントのカラーマップに基づく)色インデックス
168                        である必要があります.
169                    </para>
170                </listitem>
171            </varlistentry>
172            <varlistentry>
173                <term>fill_mode: </term>
174                <listitem>
175                    <para>
176                        <literal>"on"</literal>: enables the box background, provided that
177                        <literal>.box="on"</literal> as well. The background's color can
178                        then be set with the <literal>.background</literal> property.
179                    </para>
180                    <para>
181                      <literal>"off"</literal> (default): disables the box background,
182                      that becomes transparent.
183                    </para>
184                </listitem>
185            </varlistentry>
186            <varlistentry>
187                <term>background: </term>
188                <listitem>
189                    <para>このフィールドはボックスを塗る際に使用される色を
190                        有します.この値は(カレントのカラーマップに基づく)色インデックス
191                        である必要があります.
192                    </para>
193                </listitem>
194            </varlistentry>
195            <varlistentry>
196                <term>text_box: </term>
197                <listitem>
198                    <para>ユーザ座標で矩形の大きさを指定する2次元ベクトル.
199                        この矩形は,text_box_mode プロパティが
200                        <literal>'centered'</literal> または <literal>'filled'</literal>
201                        に設定されている時に使用されます.
202                    </para>
203                </listitem>
204            </varlistentry>
205            <varlistentry>
206                <term>text_box_mode: </term>
207                <listitem>
208                    <para>
209                        以下の3種類の値をとる可能性があります : <literal>'off'</literal>,
210                        <literal>'centered'</literal> または <literal>'filled'</literal>.
211                        <literal>'off'</literal>の場合,
212                        文字列は指令したフォントで表示され,
213                        dataフィールドはテキストの左下の点の位置を指定します.
214                        <literal>'centered'</literal>の場合, テキストは
215                        大きさがtext_boxで指定された矩形の中心に表示されます.
216                        <literal>'filled'</literal>の場合,
217                        文字列のフォントの大きさは矩形を塗りつぶすように拡大されます.
218                    </para>
219                    <para>
220                        <literal>'off'</literal>または<literal>'centered'</literal>モードを
221                        使用する場合,テキストの大きさはズームの際にも一定となります.
222                        これらはグラフの注記を作成する際には最適のモードです.
223                        逆に<literal>'filled'</literal>モードを使用した場合,
224                        テキストの大きさはグラフィックの縮尺に依存します.
225                        この場合,テキストオブジェクトをズームすることが可能です.
226                    </para>
227                </listitem>
228            </varlistentry>
229            <varlistentry>
230                <term>auto_dimensionning: </term>
231                <listitem>
232                    <para>
233                        auto_dimensionning を "off" にすることは,
234                        text_box_mode を "filled" にすることと等価です.
235                        text_box_mode が "off" または "centered" の場合,
236                        auto_dimensionning は "on" となります.
237                    </para>
238                </listitem>
239            </varlistentry>
240            <varlistentry>
241                <term>clip_state: </term>
242                <listitem>
243                    <para>このフィールドは,テキストに関する
244                        <literal>clip_state</literal>プロパティの値を有します.
245                        値は以下となります :
246                    </para>
247                    <itemizedlist>
248                        <listitem>
249                            <para>
250                                <literal>"off"</literal>
251                                テキストはクリップされません.
252                            </para>
253                        </listitem>
254                        <listitem>
255                            <para>
256                                <literal>"clipgrf"</literal>
257                                テキストはAxesボックスの外側でクリップされます.
258                            </para>
259                        </listitem>
260                        <listitem>
261                            <para>
262                                <literal>"on"</literal>
263                                テキストは<literal>clip_box</literal>プロパティで指定される
264                                矩形の外側でクリップされます.
265                            </para>
266                        </listitem>
267                    </itemizedlist>
268                </listitem>
269            </varlistentry>
270            <varlistentry>
271                <term>clip_box: </term>
272                <listitem>
273                    <para>
274                        このフィールドは
275                        <literal>clip_box</literal>プロパティを有します.
276                        この値はclip_state が"off"の場合,空の行列となります.
277                        その他の場合,ベクトル<literal>[x,y,w,h]</literal> (左上の点,幅,高さ)により
278                        クリップ領域が指定されます.
279                    </para>
280                </listitem>
281            </varlistentry>
282            <varlistentry>
283                <term>user_data: </term>
284                <listitem>
285                    <para>このフィールドは任意のScilab変数をtextデータ構造体に保存し,
286                        復元する際に使用できます.
287                    </para>
288                </listitem>
289            </varlistentry>
290        </variablelist>
291    </refsection>
292    <refsection>
293        <title>例</title>
294        <programlisting role="example"><![CDATA[
295a = get("current_axes");
296a.data_bounds = [0,0;1,1];
297a.axes_visible = 'on' ;
298
299xstring(0.5,0.5,"Scilab is not esilaB",0,0)
300
301t = gce()   //新規に作成されたオブジェクトのハンドルを取得
302t.font_foreground = 6; // フォントプロパティを変更
303t.font_size  = 5;
304t.font_style = 5;
305t.text = ["SCILAB","is";"not","esilaB"] ; // テキストを変更
306t.font_angle = 90 ; // turn the strings
307t.text_box = [0,0] ;
308t.text_box_mode = 'centered' ; // テキストの中心を [0.5,0.5]に設定.
309t.alignment = 'center' ;
310t.box = 'on' ; // テキストの周囲にボックスを描画
311
312// Using LaTeX and MathML:
313mathml = "<mrow><mfrac><mrow> <mi>d</mi> <mi>y</mi> </mrow>" + ..
314                      "<mrow> <mi>d</mi> <mi>x</mi> </mrow>" + ..
315               "</mfrac>" + ..
316               "<mo> = </mo>" + ..
317               "<mfrac> <mn>1</mn> <msup><mi>y</mi> <mn>2</mn> </msup> </mfrac>" + ..
318         "</mrow>";
319t.text = ["SCILAB","can write LaTeX :","$\frac{abc}{xyz}$";"or","MathML :",mathml] ;
320 ]]></programlisting>
321        <scilab:image>
322            a=get("current_axes");
323            a.data_bounds=[0,0;1,1];
324            a.axes_visible = 'on' ;
325            xstring(0,0,"Scilab is not esilaB",0,0)
326            t=get("hdl")
327            t.font_foreground=6;
328            t.font_size=5;
329            t.font_style=5;
330        </scilab:image>
331    </refsection>
332    <refsection role="see also">
333        <title>参照</title>
334        <simplelist type="inline">
335            <member>
336                <link linkend="xstring">xstring</link>
337            </member>
338            <member>
339                <link linkend="label_properties">label_properties</link>
340            </member>
341            <member>
342                <link linkend="legend_properties">legend_properties</link>
343            </member>
344            <member>
345                <link linkend="xtitle">xtitle</link>
346            </member>
347            <member>
348                <link linkend="graphics_entities">graphics_entities</link>
349            </member>
350            <member>
351                <link linkend="math_rendering_features_in_graphic">LaTeX or MathML expression</link>
352            </member>
353        </simplelist>
354    </refsection>
355    <refsection role="history">
356        <title>履歴</title>
357        <revhistory>
358            <revision>
359                <revnumber>5.0</revnumber>
360                <revdescription>
361                  <literal>.text_box</literal>, <literal>.text_box_mode</literal>,
362                  <literal>.alignment</literal>, and <literal>.auto_dimensionning</literal>
363                  properties added.
364                </revdescription>
365            </revision>
366            <revision>
367                <revnumber>5.2</revnumber>
368                <revdescription>
369                    LaTeX and MathML expressions are now supported.
370                </revdescription>
371            </revision>
372        </revhistory>
373    </refsection>
374</refentry>