scatter with extended polyline properties mark_size, mark_foreground, mark_background
[scilab.git] / scilab / modules / graphics / help / en_US / xgetech.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  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
11  *
12  -->
13 <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="en" xml:id="xgetech">
14     <refnamediv>
15         <refname>xgetech</refname>
16         <refpurpose>get the current graphics scale</refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>Calling Sequence</title>
20         <synopsis>[wrect, frect, logflag, arect] = xgetech()</synopsis>
21     </refsynopsisdiv>
22     <refsection>
23         <title>Arguments</title>
24         <variablelist>
25             <varlistentry>
26                 <term>wrect, frect</term>
27                 <listitem>
28                     <para>real vectors.</para>
29                 </listitem>
30             </varlistentry>
31             <varlistentry>
32                 <term>logflag</term>
33                 <listitem>
34                     <para>
35                         string of size 2 <literal>"xy"</literal>.
36                     </para>
37                 </listitem>
38             </varlistentry>
39         </variablelist>
40     </refsection>
41     <refsection>
42         <title>Description</title>
43         <para>
44             <function>xgetech</function> returns the current graphics scale (of
45             the current window). The rectangle <literal>[xmin, ymin, xmax,
46                 ymax]
47             </literal>
48             given by <varname>frect</varname> is the size of the
49             whole graphics window. The plotting will be made in the region of
50             the current graphics window specified by <varname>wrect</varname>.
51         </para>
52         <para>
53             <literal>wrect=[x, y, w, h]</literal> (upper-left point, width,
54             height) describes a region inside the graphics window. The values in
55             <varname>wrect</varname> are specified using proportion of the width
56             and height of the graphics window:
57         </para>
58         <para>
59             <literal>wrect=[0, 0, 1, 1]</literal> means that the whole graphics
60             window is used.
61         </para>
62         <para>
63             <literal>wrect=[0.5, 0, 0.5, 1]</literal> means that the graphics
64             region is the right half of the graphics window.
65         </para>
66         <para>
67             <literal>logflag</literal> is a string of size 2
68             <literal>"xy"</literal>, where <literal>x</literal> and
69             <literal>y</literal> can be <literal>"n"</literal> or
70             <literal>"l"</literal>. <literal>"n"</literal> stands for normal (linear) scale and <literal>"l"</literal> stands for logscale.
71             <literal>x</literal> stands for the x-axis and <literal>y</literal>
72             stands for the y-axis.
73         </para>
74         <para>
75             <literal>arect = [x_left, x_right, y_up, y_down]</literal> gives the
76             frame size inside the subwindow. The graphic frame is specified
77             (like <varname>wrect</varname>) using proportion of the width or
78             height of the current graphic subwindow. Default value is
79             <literal>1/8*[1,1,1,1]</literal>. If <varname>arect</varname> is not
80             given, current value remains unchanged.
81         </para>
82     </refsection>
83     <refsection>
84         <title>Examples</title>
85         <programlisting role="example"><![CDATA[ 
86 // first subwindow 
87 xsetech([0,0,1.0,0.5])
88 plot2d()
89 // then xsetech is used to set the second sub window 
90 xsetech([0,0.5,1.0,0.5])
91 grayplot()
92 // get the graphic scales of first subwindow 
93 xsetech([0,0,1.0,0.5])
94 [wrect,frect,logflag,arect]=xgetech();
95 // get the graphic scales of second subwindow 
96 xsetech([0,0.5,1.0,0.5])
97 [wrect,frect,logflag,arect]=xgetech();
98  ]]></programlisting>
99         <scilab:image>
100             xsetech([0,0,1.0,0.5])
101             plot2d()
102             xsetech([0,0.5,1.0,0.5])
103             grayplot()
104             xsetech([0,0,1.0,0.5])
105             [wrect,frect,logflag,arect]=xgetech();
106             xsetech([0,0.5,1.0,0.5])
107             [wrect,frect,logflag,arect]=xgetech();
108         </scilab:image>
109         
110     </refsection>
111     <refsection role="see also">
112         <title>See Also</title>
113         <simplelist type="inline">
114             <member>
115                 <link linkend="xsetech">xsetech</link>
116             </member>
117         </simplelist>
118     </refsection>
119 </refentry>