xset: help page only 'fpf' + equivalences
[scilab.git] / scilab / modules / graphics / help / ja_JP / xset.xml
index 1337f2e..2a1fc17 100644 (file)
@@ -1,14 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
 <!--
-
  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
-
  * Copyright (C) ENPC - Jean-Philippe Chancelier
-
+ * Copyright (C) 2017 - Samuel GOUGEON
  *
-
-
  * Copyright (C) 2012 - 2016 - Scilab Enterprises
  *
  * This file is hereby licensed under the terms of the GNU GPL v2.0,
  * and continues to be available under such terms.
  * For more information, see the COPYING file which you should have received
  * along with this program.
-
  *
-
  -->
-
-<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="xset">
-
+<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="xset">
     <refnamediv>
-
         <refname>xset</refname>
-
         <refpurpose>
-
-            グラフィックコンテキストの値を設定.
-
-            <emphasis role="bold">この関数は廃止されました.</emphasis>
-
+            グラフィックコンテキストの値を設定. <emphasis role="bold">この関数は廃止されました.</emphasis>
         </refpurpose>
-
     </refnamediv>
-
     <refsynopsisdiv>
-
         <title>呼び出し手順</title>
-
-        <synopsis>xset(choice-name,x1,x2,x3,x4,x5)
-
-            xset()
-
+        <synopsis>
+            xset(choice-name,x1,x2,x3,x4,x5)
         </synopsis>
-
     </refsynopsisdiv>
-
     <refsection>
-
         <title>引数</title>
-
         <variablelist>
-
             <varlistentry>
-
                 <term>choice-name</term>
-
                 <listitem>
-
                     <para>string</para>
-
                 </listitem>
-
             </varlistentry>
-
             <varlistentry>
-
                 <term>x1,...,x5</term>
-
                 <listitem>
-
                     <para>
-
                         <literal>choice-name</literal>に依存
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
         </variablelist>
-
     </refsection>
-
     <refsection>
-
         <title>説明</title>
-
-        <para>
-
-            <warning>
-
-                この関数は廃止されました.
-
-            </warning>
-
+        <warning>
+            <emphasis role="bold">この関数は廃止されました</emphasis>.
             替わりにScilabグラフィックオブジェクトの記法を使用してください
-
             (<link linkend="set">set</link> および <link linkend="get">get</link>
-
             関数および<link linkend="graphics_entities">graphics_entities</link>
-
             のヘルプページを参照ください).
-
-        </para>
-
+        </warning>
         <para>
-
             <literal>xset</literal> は現在のウインドウグラフィックコンテキストの
-
             デフォルト値を設定する際に使用されます.
-
-        </para>
-
-        <para>
-
-            引数を指定せずにコールした場合,
-
-            現在の値を表示する選択メニューが作成され,
-
-            トグルボタンにより変更が可能です.
-
-        </para>
-
-        <para>
-
-            現在の色,マーカ,使用するフォントを表示または設定する際には
-
-            <literal>xset()</literal> を使用してください.
-
         </para>
-
-        <para/>
-
         <variablelist>
-
-            <varlistentry>
-
-                <term>xset("auto clear","on"|"off")</term>
-
-                <listitem>
-
-                    <para>
-
-                        グラフィックの自動消去モードの "on" または "off"を切替ます.
-
-                        自動消去モードが"on"の場合,
-
-                        連続的なプロットは重ねて表示されません.
-
-                        つまり,各高レベルグラフィック関数の前に
-
-                        <literal>clf()</literal>処理
-
-                        (グラフィックウインドウが消去され,
-
-                        関連する記録されたグラフィックが消去される)
-
-                        が実行されます.
-
-                        デフォルト値は "off" です.
-
-                    </para>
-
-                </listitem>
-
-            </varlistentry>
-
-            <varlistentry>
-
-                <term>xset("background",color)</term>
-
-                <listitem>
-
-                    <para>
-
-                        現在の軸オブジェクトの背景色を設定します.
-
-                        <literal>color</literal>引数は使用する色の
-
-                        カラーマップ添字です.
-
-                    </para>
-
-                </listitem>
-
-            </varlistentry>
-
-            <varlistentry>
-
-                <term>xset("clipping",x,y,w,h)</term>
-
-                <listitem>
-
-                    <para>
-
-                        クリッピング領域を設定(プロットが描画される
-
-                        グラフィックウインドウの領域)を
-
-                        矩形(x,y,w,h) (左上の点 幅 高さ)に設定します.
-
-                        この関数は現在のプロットの座標系を使用します.
-
-                    </para>
-
-                </listitem>
-
-            </varlistentry>
-
-            <varlistentry>
-
-                <term>xset("color",value)</term>
-
-                <listitem>
-
-                    <para>
-
-                        塗るつぶし用, 線またはテキスト描画関数用のデフォルト色を
-
-                        設定します.
-
-                        <literal>value</literal> は,範囲 [0,whiteid]に
-
-                        投影された整数です.
-
-                        黒塗りつぶしの場合は0,白の場合はwhiteidが使用されます.
-
-                        whiteidの値は
-
-                        <literal>xget("white")</literal>で取得できます.
-
-                    </para>
-
-                </listitem>
-
-            </varlistentry>
-
-            <varlistentry>
-
-                <term>xset("colormap",cmap)</term>
-
-                <listitem>
-
-                    <para>
-
-                        Set the colormap as a m x 3 matrix. m is the number of colors.
-
-                        Color number i is given as a 3-uple cmap(i,1), cmap(i,2), cmap(i,3)
-
-                        corresponding respectively to red, green and blue intensity between 0
-
-                        and 1.
-
-                    </para>
-
-                </listitem>
-
-            </varlistentry>
-
-            <varlistentry>
-
-                <term>xset("dashes",i)</term>
-
-                <listitem>
-
-                    <para>
-
-                        In black and white mode (<literal>xset("use color",0)</literal>), set
-
-                        the dash style to style i (0 for solid line). In color mode
-
-                        (<literal>xset("use color",1 )</literal>) this is used to set line, mark and
-
-                        text color. This keyword is obsolete, please use
-
-                        <literal>xset('color',i)</literal> or <literal>xset('line style',i)</literal>
-
-                        instead.
-
-                    </para>
-
-                </listitem>
-
-            </varlistentry>
-
-            <varlistentry>
-
-                <term>xset("default")</term>
-
-                <listitem>
-
-                    <para>Reset the graphics context to default values.</para>
-
-                </listitem>
-
-            </varlistentry>
-
             <varlistentry>
-
-                <term>xset("font",fontid,fontsize)</term>
-                <listitem>
-                    <para>
-                        Set the current font and its current size.
-                        Note that <literal>fontsize</literal> applies to all fonts not
-                        only <literal>fontid</literal> .
-                    </para>
-
-                </listitem>
-
-            </varlistentry>
-
-            <varlistentry>
-
-                <term>xset("font size",fontsize)</term>
-
-                <listitem>
-
-                    <para>Set the fonts size.</para>
-
-                </listitem>
-
-            </varlistentry>
-
-            <varlistentry>
-
-                <term>xset("foreground",color)</term>
-
-                <listitem>
-
-                    <para>Set the foreground color of the current Axes object.
-
-                        The <literal>color</literal> argument is the colormap index of the color to use.
-
-                    </para>
-
-                </listitem>
-
-            </varlistentry>
-
-            <varlistentry>
-
                 <term>xset("fpf",string)</term>
-
                 <listitem>
-
                     <para>Set the floating point format for number display in contour
-
                         functions. <literal>string</literal> is a string giving the format in C
-
                         format syntax (for example <literal>string="%.3f"</literal>). Use
-
                         <literal>string=""</literal> to switch back to default format.
-
                     </para>
-
                 </listitem>
-
             </varlistentry>
-
-            <varlistentry>
-
-                <term>xset("hidden3d",colorid)</term>
-                <listitem>
-                    <para>
-                        Set the color number for backward facing faces in
-                        <literal>plot3d</literal>. <literal>colorid=0</literal> zero suppress the
-                        drawing of backward facing faces of 3d objects. This is technically
-                        called 'culling' and speeds up the rendering of closed surfaces.
-                    </para>
-                </listitem>
-
-            </varlistentry>
-
-            <varlistentry>
-
-                <term>xset("line mode",type)</term>
-
-                <listitem>
-
-                    <para>This function is used to set the line drawing mode. Absolute
-
-                        mode is set with type=1 and relative mode with type=0. (Warning: the
-
-                        mode type=0 has bugs)
-
-                    </para>
-
-                </listitem>
-
-            </varlistentry>
-
-            <varlistentry>
-
-                <term>xset("line style",value)</term>
-
-                <listitem>
-
-                    <para>Set the current line style (1: solid, &gt;1 for dashed
-
-                        lines).
-
-                    </para>
-
-                </listitem>
-
-            </varlistentry>
-
-            <varlistentry>
-
-                <term>xset("mark",markid,marksize)</term>
-
-                <listitem>
-
-                    <para>Set the current mark and the current mark size. Use
-
-                        <literal>xset()</literal> to see the marks. Note that <literal>marksize</literal>
-
-                        applies to all marks not only <literal>markid</literal> .
-
-                    </para>
-
-                </listitem>
-
-            </varlistentry>
-
-            <varlistentry>
-
-                <term>xset("mark size",marksize)</term>
-
-                <listitem>
-
-                    <para>Set the marks size.</para>
-
-                </listitem>
-
-            </varlistentry>
-
-            <varlistentry>
-
-                <term>xset("pattern",value)</term>
-
-                <listitem>
-
-                    <para>Set the current pattern for filling functions. value is an
-
-                        integer projected in the interval [0,whiteid]. 0 is used for black
-
-                        filling and whiteid for white. The value of whiteid can be obtained
-
-                        with <literal>xget("white")</literal>. "pattern" is equivalent to
-
-                        "color".
-
-                    </para>
-
-                </listitem>
-
-            </varlistentry>
-
-            <varlistentry>
-
-                <term>xset("thickness",value)</term>
-
-                <listitem>
-
-                    <para>Set the thickness of lines in pixel (0 and 1 have the same
-
-                        meaning: 1 pixel thick).
-
-                    </para>
-
-                </listitem>
-
-            </varlistentry>
-
-            <varlistentry>
-
-                <term>xset("use color",flag)</term>
-
-                <listitem>
-
-                    <para>
-
-                        If flag=1 then <literal>xset("pattern",.)</literal> or
-
-                        <literal>xset("dashes",.)</literal> will be used so as to change the default
-
-                        color for drawing or for filling patterns. If flag=0 then we switch
-
-                        back to the gray and dashes mode.
-
-                    </para>
-
-                </listitem>
-
-            </varlistentry>
-
-            <varlistentry>
-
-                <term>xset("viewport",x,y)</term>
-
-                <listitem>
-
-                    <para>Set the position of the panner.</para>
-
-                </listitem>
-
-            </varlistentry>
-
-            <varlistentry>
-
-                <term>xset("wdim",width,height)</term>
-
-                <listitem>
-
-                    <para>Set the width and the height of the current graphics window.
-
-                        This option is not used by the postscript driver.
-
-                    </para>
-
-                </listitem>
-
-            </varlistentry>
-
-            <varlistentry>
-
-                <term>xset("wpdim",width,height)</term>
-
-                <listitem>
-
-                    <para>Sets the width and the height of the current physical graphic
-
-                        window (which can be different from the actual size in mode wresize
-
-                        1). This option is not used by the postscript driver.
-
-                    </para>
-
-                </listitem>
-
-            </varlistentry>
-
-            <varlistentry>
-
-                <term>xset("window",window-number)</term>
-
-                <listitem>
-
-                    <para>
-
-                        Set the current window to the window <literal>window-number</literal>
-
-                        and creates the window if it does not exist.
-
-                    </para>
-
-                </listitem>
-
-            </varlistentry>
-
-            <varlistentry>
-
-                <term>xset("wpos",x,y)</term>
-
-                <listitem>
-
-                    <para>Set the position of the upper left point of the graphics
-
-                        window.
-
-                    </para>
-
-                </listitem>
-
-            </varlistentry>
-
-            <varlistentry>
-
-                <term>xset("wresize",flag)</term>
-
-                <listitem>
-
-                    <para>If flag=1 then the graphic is automatically resized to fill the
-
-                        graphics window.
-
-                    </para>
-
-                    <programlisting role=""><![CDATA[
-xdel();
-xset("wresize",1);
-plot2d();
-xset("wdim",1000,500)
- ]]></programlisting>
-
-                    <para>If flag=0 the scale of the graphic is left unchanged when the
-
-                        graphics window is resized. Top left panner or keyboard arrows may be
-
-                        used to scroll over the graphic.
-
-                    </para>
-
-                    <programlisting role=""><![CDATA[
-xdel();
-plot2d();
-xset("wresize",0);
-xset("wdim",1000,500)
- ]]></programlisting>
-
-                </listitem>
-
-            </varlistentry>
-
         </variablelist>
-
+        <refsect2>
+            <title>Replacements</title>
+            <para>
+            <literal>xset(..)</literal> returned nothing. Please take care appending a semi-colon
+            after replacement instructions in order to cancel the display of their output.
+            </para>
+        <screen><![CDATA[
+// SCILAB 3 & 4                 SCILAB N>4
+// ------------                 ----------
+xset("default")                 clf("reset")
+
+xset("wpos", [x y])             gcf().figure_position = [x y];
+xset("wpdim", w, h)             gcf().figure_size = [w h];
+xset("wdim", w, h)              gcf().figure_size = [w h];
+xset("wresize", 0|1)  HS        gcf().auto_resize = "off"|"on";
+xset("colormap", CM)            gcf().color_map = CM;
+xset("figure", i)               scf(i);
+xset("window", i)               scf(i);
+xset("viewport", xp,yp)         gcf().viewport = [xp yp];
+
+xset("auto clear","on"|"off")   gca().auto_clear = "on"|"off";
+xset("line mode", 0|1)          gca().line_mode = "off"|"on";
+xset("line style", n)           gca().line_style = n;
+xset("dashes", n)               gca().line_style = n;
+xset("thickness", n)            gca().thickness = n;
+xset("font size", s)            gca().font_size = s;
+xset("font", id, fsize)         set(gca(), "font_style", id, "font_size", fsize);
+xset("mark size", msize)        set(gca(), "mark_size_unit", "tabulated", "mark_size", msize);
+xset("mark", id, msize)         set(gca(), "mark_style", id, "mark_size_unit", "tabulated", "mark_size", msize);
+xset("color", icol)             gca().foreground = icol;
+xset("color", 0)                gca().foreground = -1;
+xset("pattern", icol)           gca().foreground = icol;
+xset("pattern", 0)              gca().foreground = -1;
+xset("foreground", icol)        gca().foreground = icol;
+xset("background", icol)        gca().background = icol;
+xset("hidden3d", icol)          gca().hiddencolor = icol;
+
+xset("clipping", rect)          set(gca(), "clip_box", rect, "clip_state", "on");
+xset("clipgrf")                 gca().clip_state = "clipgrf";
+xset("clipoff")                 gca().clip_state = "off";
+
+xset("alufunction",i)           gcf().pixel_drawing_mode = str(i);
+                                #i   str(i)
+                                --   ------
+                                0 => "clear"
+                                1 => "and"
+                                2 => "andReverse"
+                                3 => "copy"
+                                4 => "andInverted"
+                                5 => "noop"
+                                6 => "xor"
+                                7 => "or"
+                                8 => "nor"
+                                9 => "equiv"
+                                10 => "invert"
+                                11 => "orReverse"
+                                12 => "copyInverted"
+                                13 => "orInverted"
+                                14 => "nand"
+                                15 => "set"
+]]></screen>
+        </refsect2>
     </refsection>
-
-    <refsection>
-
-        <title>参照</title>
-
+    <refsection role="see also">
+        <title>See also</title>
         <simplelist type="inline">
-
             <member>
-
                 <link linkend="xget">xget</link>
-
             </member>
-
             <member>
-
-                <link linkend="getcolor">getcolor</link>
-
+                <link linkend="set">set</link>
             </member>
-
             <member>
-
-                <link linkend="ged">ged</link>
-
+                <link linkend="graphics_entities">graphics entities</link>
             </member>
-
             <member>
-
-                <link linkend="set">set</link>
-
+                <link linkend="gcf">gcf</link>
             </member>
-
             <member>
-
-                <link linkend="graphics_entities">graphics_entities</link>
-
+                <link linkend="gdf">gdf</link>
+            </member>
+            <member>
+                <link linkend="gca">gca</link>
+            </member>
+            <member>
+                <link linkend="gda">gda</link>
+            </member>
+            <member>
+                <link linkend="ged">ged</link>
+            </member>
+            <member>
+                <link linkend="getcolor">getcolor</link>
             </member>
-
         </simplelist>
-
     </refsection>
-
     <refsection>
-
-        <title>履歴</title>
-
+        <title>History</title>
         <revhistory>
-
             <revision>
-
+                <revnumber>5.0.1</revnumber>
+                <revremark>
+                    The <literal>.alufunction</literal> property is obsolete. It is no longer
+                    taken into account for graphical renderings. It is replaced with
+                    <literal>gcf().pixel_drawing_mode</literal>.
+                </revremark>
+            </revision>
+            <revision>
                 <revnumber>5.4.0</revnumber>
-
                 <revremark>
-
-                    The "alufunction" プロパティはもはやサポートされておらず,
-
-                    このプロパティは Scilab 5.0.1の描画では使用されいません.
-
+                    The <literal>"alufunction"</literal> is no longer supported..
+                </revremark>
+            </revision>
+            <revision>
+                <revnumber>6.0.0</revnumber>
+                <revremark>
+                    The only <literal>xset("fpf", format)</literal> syntax is now supported.
                 </revremark>
-
             </revision>
-
         </revhistory>
-
     </refsection>
-
-</refentry>
-
+</refentry>
\ No newline at end of file