path: root/modules/graphics/help/ja_JP/xget.xml

<?xml version="1.0" encoding="UTF-8"?>

<!--

 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab

 * Copyright (C) ENPC - Jean-Philippe Chancelier

 * 

 * This file must be used under the terms of the CeCILL.

 * This source file is licensed as described in the file COPYING, which

 * you should have received as part of this distribution.  The terms

 * are also available at    

 * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt

 *

 -->

<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="xget" xml:lang="ja">
    
    <refnamediv>
        
        <refname>xget</refname>
        
        <refpurpose>
            
            グラフィックコンテキストのカレントの値を取得. 
            
            <emphasis role="bold">この関数は廃止されました.</emphasis>
            
        </refpurpose>
        
    </refnamediv>
    
    <refsynopsisdiv>
        
        <title>呼び出し手順</title>
        
        <synopsis>[x1]=xget(str,[flag])
            
            xget()
            
        </synopsis>
        
    </refsynopsisdiv>
    
    <refsection>
        
        <title>パラメータ</title>
        
        <variablelist>
            
            <varlistentry>
                
                <term>str</term>
                
                <listitem>
                    
                    <para>文字列.</para>
                    
                </listitem>
                
            </varlistentry>
            
            <varlistentry>
                
                <term>flag</term>
                
                <listitem>
                    
                    <para>オプション. 1を指定すると冗長モード.</para>
                    
                </listitem>
                
            </varlistentry>
            
        </variablelist>
        
    </refsection>
    
    <refsection>
        
        <title>説明</title>
        
        <para>
            
            <warning>
                
                この関数は廃止されました.
                
            </warning>
            
            代わりにScilabグラフィックオブジェクト表現を使用してください
            
            (<link linkend="set">set</link>および <link linkend="get">get</link>関数
            
            および<link linkend="graphics_entities">graphicsエンティティ</link>を参照).
            
        </para>
        
        <para>
            
            This function is used to get values from the graphics context on the
            
            topic specified by the string <literal>str</literal>. When called with no
            
            argument, a choice menu is created showing the current values and changes
            
            can be performed through toggle buttons.
            
        </para>
        
        <variablelist>
            
            <varlistentry>
                
                <term>str = xget("auto clear")</term>
                
                <listitem>
                    
                    <para>
                        
                        Get the auto clear status (<literal>"on"</literal> or
                        
                        <literal>"off"</literal>).
                        
                    </para>
                    
                </listitem>
                
            </varlistentry>
            
            <varlistentry>
                
                <term>color = xget("background")</term>
                
                <listitem>
                    
                    <para>
                        
                        Get the background color of the current
                        
                        <literal>Axes</literal> object. The result is a colormap
                        
                        index corresponding to the color.
                        
                    </para>
                    
                </listitem>
                
            </varlistentry>
            
            <varlistentry>
                
                <term>rect = xget("clipping")</term>
                
                <listitem>
                    
                    <para>
                        
                        Get the clipping zone as a rectangle <literal>rect =
                            
                            [x,y,w,h]
                            
                        </literal>
                        
                        (Upper-Left point, Width, Height).
                        
                    </para>
                    
                </listitem>
                
            </varlistentry>
            
            <varlistentry>
                
                <term>c = xget("color")</term>
                
                <listitem>
                    
                    <para>
                        
                        Get the default color for filling, line or text drawing
                        
                        functions. <literal>c</literal> is an integer projected
                        
                        in the interval <literal>[0,whiteid]</literal>. 0 stands
                        
                        for black filling and <literal>whiteid</literal> for
                        
                        white. The value of <literal>whiteid</literal> can be
                        
                        obtained with <code>xget("white")</code>.
                        
                    </para>
                    
                </listitem>
                
            </varlistentry>
            
            <varlistentry>
                
                <term>cmap = xget("colormap")</term>
                
                <listitem>
                    
                    <para>
                        
                        Get the colormap used for the current graphics window as
                        
                        a <literal>m x 3</literal> RGB matrix.
                        
                    </para>
                    
                </listitem>
                
            </varlistentry>
            
            <varlistentry>
                
                <term>dash = xget("dashes")</term>
                
                <listitem>
                    
                    <para>
                        
                        Get the dash style <literal>dash = [dash_number]</literal>
                        
                        where <literal>dash_number</literal> is the id of the
                        
                        dash.
                        
                        <warning>
                            
                            This keyword is obsolete, please use
                            
                            <literal>xget("color")</literal> or
                            
                            <literal>xget("line style")</literal> instead.
                            
                        </warning>
                        
                    </para>
                    
                </listitem>
                
            </varlistentry>
            
            <varlistentry>
                
                <term>font = xget("font")</term>
                
                <listitem>
                    
                    <para>
                        
                        Get <literal>font = [fontid, fontsize]</literal>, the
                        
                        default font and the default value of font size.
                        
                    </para>
                    
                </listitem>
                
            </varlistentry>
            
            <varlistentry>
                
                <term>fontsize = xget("font size")</term>
                
                <listitem>
                    
                    <para>Get the default value of font size.</para>
                    
                </listitem>
                
            </varlistentry>
            
            <varlistentry>
                
                <term>color = xget("foreground")</term>
                
                <listitem>
                    
                    <para>
                        
                        Get the foreground color of the current
                        
                        <literal>Axes</literal> object. The result is a colormap index corresponding to the color.
                        
                    </para>
                    
                </listitem>
                
            </varlistentry>
            
            <varlistentry>
                
                <term>str = xget("fpf")</term>
                
                <listitem>
                    
                    <para>
                        
                        Get the floating point format for number display in
                        
                        contour functions. Note that <literal>str</literal> is <literal>""</literal> when default format is used.
                        
                    </para>
                    
                </listitem>
                
            </varlistentry>
            
            <varlistentry>
                
                <term>color = xget("hidden3d")</term>
                
                <listitem>
                    
                    <para>
                        
                        Get the color number for hidden faces in <function>plot3d</function>.
                        
                    </para>
                    
                </listitem>
                
            </varlistentry>
            
            <varlistentry>
                
                <term>pat = xget("lastpattern")</term>
                
                <listitem>
                    
                    <para>
                        
                        Get the id of the last available pattern or color, with
                        
                        the current colormap of the current window. In fact
                        
                        <literal>pat+1</literal> and <literal>pat+2</literal>
                        
                        are also available and stand respectively for black and
                        
                        white pattern.
                        
                    </para>
                    
                </listitem>
                
            </varlistentry>
            
            <varlistentry>
                
                <term>type = xget("line mode")</term>
                
                <listitem>
                    
                    <para>
                        
                        Get the line drawing mode. <literal>type = 1</literal>
                        
                        is absolute mode and <literal>type = 0</literal> is
                        
                        relative mode.
                        
                        <warning>
                            
                            The mode <literal>type = 0</literal> has bugs.
                            
                        </warning>
                        
                    </para>
                    
                </listitem>
                
            </varlistentry>
            
            <varlistentry>
                
                <term>xget("line style")</term>
                
                <listitem>
                    
                    <para>
                        
                        Get the default line style (1 for solid line, &gt;1 for
                        
                        dashed lines).
                        
                    </para>
                    
                </listitem>
                
            </varlistentry>
            
            <varlistentry>
                
                <term>mark = xget("mark")</term>
                
                <listitem>
                    
                    <para>
                        
                        Get the default mark id and the default mark size.
                        
                        <literal>mark=[markid, marksize]</literal>.
                        
                    </para>
                    
                </listitem>
                
            </varlistentry>
            
            <varlistentry>
                
                <term>marksize = xget("mark size")</term>
                
                <listitem>
                    
                    <para>Get the default mark size.</para>
                    
                </listitem>
                
            </varlistentry>
            
            <varlistentry>
                
                <term>pat = xget("pattern")</term>
                
                <listitem>
                    
                    <para>
                        
                        Get the current pattern or the current color.
                        
                        <literal>pat</literal> is an integer in the range
                        
                        <literal>[1, last]</literal>. When one uses black and
                        
                        white, 0 is used for black filling and
                        
                        <literal>last</literal> for white. The value of
                        
                        <literal>last</literal> can be obtained with
                        
                        <code>xget("lastpattern")</code>.
                        
                    </para>
                    
                </listitem>
                
            </varlistentry>
            
            <varlistentry>
                
                <term>value = xget("thickness")</term>
                
                <listitem>
                    
                    <para>
                        
                        Get the thickness of lines in pixel (0 and 1 have the same meaning: 1 pixel thick).
                        
                    </para>
                    
                </listitem>
                
            </varlistentry>
            
            <varlistentry>
                
                <term>flag = xget("use color")</term>
                
                <listitem>
                    
                    <para>
                        
                        Get the flag 0 (use black and white) or 1 (use colors).
                        
                        See <function>xset</function>.
                        
                    </para>
                    
                </listitem>
                
            </varlistentry>
            
            <varlistentry>
                
                <term>[x, y] = xget("viewport")</term>
                
                <listitem>
                    
                    <para>
                        
                        Get the current position of the visible part of graphics
                        
                        in the panner.
                        
                    </para>
                    
                </listitem>
                
            </varlistentry>
            
            <varlistentry>
                
                <term>dim = xget("wdim")</term>
                
                <listitem>
                    
                    <para>
                        
                        Get the width and the height of the current graphics
                        
                        window <literal>dim = [width, height]</literal>.
                        
                    </para>
                    
                </listitem>
                
            </varlistentry>
            
            <varlistentry>
                
                <term>win = xget("window")</term>
                
                <listitem>
                    
                    <para>
                        
                        Get the current window number <literal>win</literal>.
                        
                    </para>
                    
                </listitem>
                
            </varlistentry>
            
            <varlistentry>
                
                <term>pos = xget("wpos")</term>
                
                <listitem>
                    
                    <para>
                        
                        Get the position of the upper left point of the graphics
                        
                        window <literal>pos = [x, y]</literal>.
                        
                    </para>
                    
                </listitem>
                
            </varlistentry>
            
        </variablelist>
        
    </refsection>
    
    <refsection role="see also">
        
        <title>参照</title>
        
        <simplelist type="inline">
            
            <member>
                
                <link linkend="xset">xset</link>
                
            </member>
            
            <member>
                
                <link linkend="getcolor">getcolor</link>
                
            </member>
            
            <member>
                
                <link linkend="ged">ged</link>
                
            </member>
            
            <member>
                
                <link linkend="set">set</link>
                
            </member>
            
            <member>
                
                <link linkend="graphics_entities">graphics_entities</link>
                
            </member>
            
        </simplelist>
        
    </refsection>
    
    <refsection>
        
        <title>履歴</title>
        
        <revhistory>
            
            <revision>
                
                <revnumber>5.4.0</revnumber>
                
                <revremark>
                    
                    "alufunction" プロパティはもはやサポートされておらず,
                    
                    このプロパティは Scilab 5.0.1の描画では使用されいません.
                    
                </revremark>
                
            </revision>
            
        </revhistory>
        
    </refsection>
    
</refentry>