xset: help page only 'fpf' + equivalences
[scilab.git] / scilab / modules / graphics / help / ja_JP / xset.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) ENPC - Jean-Philippe Chancelier
5  * Copyright (C) 2017 - Samuel GOUGEON
6  *
7  * Copyright (C) 2012 - 2016 - Scilab Enterprises
8  *
9  * This file is hereby licensed under the terms of the GNU GPL v2.0,
10  * pursuant to article 5.3.4 of the CeCILL v.2.1.
11  * This file was originally licensed under the terms of the CeCILL v2.1,
12  * and continues to be available under such terms.
13  * For more information, see the COPYING file which you should have received
14  * along with this program.
15  *
16  -->
17 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
18     xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
19     xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
20     xml:lang="ja" xml:id="xset">
21     <refnamediv>
22         <refname>xset</refname>
23         <refpurpose>
24             グラフィックコンテキストの値を設定. <emphasis role="bold">この関数は廃止されました.</emphasis>
25         </refpurpose>
26     </refnamediv>
27     <refsynopsisdiv>
28         <title>呼び出し手順</title>
29         <synopsis>
30             xset(choice-name,x1,x2,x3,x4,x5)
31         </synopsis>
32     </refsynopsisdiv>
33     <refsection>
34         <title>引数</title>
35         <variablelist>
36             <varlistentry>
37                 <term>choice-name</term>
38                 <listitem>
39                     <para>string</para>
40                 </listitem>
41             </varlistentry>
42             <varlistentry>
43                 <term>x1,...,x5</term>
44                 <listitem>
45                     <para>
46                         <literal>choice-name</literal>に依存
47                     </para>
48                 </listitem>
49             </varlistentry>
50         </variablelist>
51     </refsection>
52     <refsection>
53         <title>説明</title>
54         <warning>
55             <emphasis role="bold">この関数は廃止されました</emphasis>.
56             替わりにScilabグラフィックオブジェクトの記法を使用してください
57             (<link linkend="set">set</link> および <link linkend="get">get</link>
58             関数および<link linkend="graphics_entities">graphics_entities</link>
59             のヘルプページを参照ください).
60         </warning>
61         <para>
62             <literal>xset</literal> は現在のウインドウグラフィックコンテキストの
63             デフォルト値を設定する際に使用されます.
64         </para>
65         <variablelist>
66             <varlistentry>
67                 <term>xset("fpf",string)</term>
68                 <listitem>
69                     <para>Set the floating point format for number display in contour
70                         functions. <literal>string</literal> is a string giving the format in C
71                         format syntax (for example <literal>string="%.3f"</literal>). Use
72                         <literal>string=""</literal> to switch back to default format.
73                     </para>
74                 </listitem>
75             </varlistentry>
76         </variablelist>
77         <refsect2>
78             <title>Replacements</title>
79             <para>
80             <literal>xset(..)</literal> returned nothing. Please take care appending a semi-colon
81             after replacement instructions in order to cancel the display of their output.
82             </para>
83         <screen><![CDATA[
84 // SCILAB 3 & 4                 SCILAB N>4
85 // ------------                 ----------
86 xset("default")                 clf("reset")
87
88 xset("wpos", [x y])             gcf().figure_position = [x y];
89 xset("wpdim", w, h)             gcf().figure_size = [w h];
90 xset("wdim", w, h)              gcf().figure_size = [w h];
91 xset("wresize", 0|1)  HS        gcf().auto_resize = "off"|"on";
92 xset("colormap", CM)            gcf().color_map = CM;
93 xset("figure", i)               scf(i);
94 xset("window", i)               scf(i);
95 xset("viewport", xp,yp)         gcf().viewport = [xp yp];
96
97 xset("auto clear","on"|"off")   gca().auto_clear = "on"|"off";
98 xset("line mode", 0|1)          gca().line_mode = "off"|"on";
99 xset("line style", n)           gca().line_style = n;
100 xset("dashes", n)               gca().line_style = n;
101 xset("thickness", n)            gca().thickness = n;
102 xset("font size", s)            gca().font_size = s;
103 xset("font", id, fsize)         set(gca(), "font_style", id, "font_size", fsize);
104 xset("mark size", msize)        set(gca(), "mark_size_unit", "tabulated", "mark_size", msize);
105 xset("mark", id, msize)         set(gca(), "mark_style", id, "mark_size_unit", "tabulated", "mark_size", msize);
106 xset("color", icol)             gca().foreground = icol;
107 xset("color", 0)                gca().foreground = -1;
108 xset("pattern", icol)           gca().foreground = icol;
109 xset("pattern", 0)              gca().foreground = -1;
110 xset("foreground", icol)        gca().foreground = icol;
111 xset("background", icol)        gca().background = icol;
112 xset("hidden3d", icol)          gca().hiddencolor = icol;
113
114 xset("clipping", rect)          set(gca(), "clip_box", rect, "clip_state", "on");
115 xset("clipgrf")                 gca().clip_state = "clipgrf";
116 xset("clipoff")                 gca().clip_state = "off";
117
118 xset("alufunction",i)           gcf().pixel_drawing_mode = str(i);
119                                 #i   str(i)
120                                 --   ------
121                                 0 => "clear"
122                                 1 => "and"
123                                 2 => "andReverse"
124                                 3 => "copy"
125                                 4 => "andInverted"
126                                 5 => "noop"
127                                 6 => "xor"
128                                 7 => "or"
129                                 8 => "nor"
130                                 9 => "equiv"
131                                 10 => "invert"
132                                 11 => "orReverse"
133                                 12 => "copyInverted"
134                                 13 => "orInverted"
135                                 14 => "nand"
136                                 15 => "set"
137 ]]></screen>
138         </refsect2>
139     </refsection>
140     <refsection role="see also">
141         <title>See also</title>
142         <simplelist type="inline">
143             <member>
144                 <link linkend="xget">xget</link>
145             </member>
146             <member>
147                 <link linkend="set">set</link>
148             </member>
149             <member>
150                 <link linkend="graphics_entities">graphics entities</link>
151             </member>
152             <member>
153                 <link linkend="gcf">gcf</link>
154             </member>
155             <member>
156                 <link linkend="gdf">gdf</link>
157             </member>
158             <member>
159                 <link linkend="gca">gca</link>
160             </member>
161             <member>
162                 <link linkend="gda">gda</link>
163             </member>
164             <member>
165                 <link linkend="ged">ged</link>
166             </member>
167             <member>
168                 <link linkend="getcolor">getcolor</link>
169             </member>
170         </simplelist>
171     </refsection>
172     <refsection>
173         <title>History</title>
174         <revhistory>
175             <revision>
176                 <revnumber>5.0.1</revnumber>
177                 <revremark>
178                     The <literal>.alufunction</literal> property is obsolete. It is no longer
179                     taken into account for graphical renderings. It is replaced with
180                     <literal>gcf().pixel_drawing_mode</literal>.
181                 </revremark>
182             </revision>
183             <revision>
184                 <revnumber>5.4.0</revnumber>
185                 <revremark>
186                     The <literal>"alufunction"</literal> is no longer supported..
187                 </revremark>
188             </revision>
189             <revision>
190                 <revnumber>6.0.0</revnumber>
191                 <revremark>
192                     The only <literal>xset("fpf", format)</literal> syntax is now supported.
193                 </revremark>
194             </revision>
195         </revhistory>
196     </refsection>
197 </refentry>