Add new positions for datatips (left, right, upper, lower).
[scilab.git] / scilab / modules / graphics / help / en_US / datatips / datatipSetOrientation.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Copyright (C) INRIA -  Serge Steer Serge.Steer@inria.fr
4  *
5  * This file must be used under the terms of the CeCILL.
6  * This source file is licensed as described in the file COPYING, which
7  * you should have received as part of this distribution.  The terms
8  * are also available at
9  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
10 -->
11 <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_US" xml:id="datatipSetOrientation">
12     <refnamediv>
13         <refname>datatipSetOrientation</refname>
14         <refpurpose>Set the position of the text box associated with the given tip.</refpurpose>
15     </refnamediv>
16     <refsynopsisdiv>
17         <title>Calling Sequence</title>
18         <synopsis>
19             datatipSetOrientation(tip_handle,orient)
20         </synopsis>
21     </refsynopsisdiv>
22     <refsection>
23         <title>Arguments</title>
24         <variablelist>
25             <varlistentry>
26                 <term>tip_handle</term>
27                 <listitem>
28                     <para>
29                         A handle on a datatip.
30                     </para>
31                 </listitem>
32             </varlistentry>
33         </variablelist>
34         <variablelist>
35             <varlistentry>
36                 <term>orient</term>
37                 <listitem>
38                     <para>
39                         A character string with possible values:
40                         <literal>"automatic"</literal>, <literal>"upper
41                             left"
42                         </literal>
43                         ,<literal>"upper right"</literal>,
44                         <literal>"lower left"</literal>, <literal>"lower right"</literal>, 
45                         <literal>"left"</literal>, <literal>"right"</literal>, 
46                         <literal>"upper"</literal>, or <literal>"lower"</literal>.
47                     </para>
48                 </listitem>
49             </varlistentry>
50         </variablelist>
51     </refsection>
52     <refsection>
53         <title>Description</title>
54         <para>
55             Set the position on the text box with respect to the polyline
56             point. With the <literal>"automatic"</literal> orientation the
57             program makes the choice of the position trying to prevent
58             text from overlapping polyline, it also tries to to keep the text
59             box within the plot boundaries.
60         </para>
61     </refsection>
62     <refsection>
63         <title>Examples</title>
64         <programlisting role="example"><![CDATA[
65     x=linspace(-20,20,1000);
66     clf()
67     plot(x,sinc(x),x,sinc(x.^2));
68     e=gce();e=e.children;
69     d1=datatipCreate(e(1),500);
70     d2=datatipCreate(e(2),60);
71     datatipSetOrientation(d1,"lower left");
72     datatipSetOrientation(d2,"lower right");
73     ]]></programlisting>
74         <scilab:image>
75             x=linspace(-20,20,1000);
76             plot(x,sinc(x),x,sinc(x.^2));
77             e=gce();e=e.children;
78             d1=datatipCreate(e(1),500);
79             d2=datatipCreate(e(2),60);
80             datatipSetOrientation(d1,"lower left");
81             datatipSetOrientation(d2,"lower right");
82         </scilab:image>
83     </refsection>
84     <refsection role="see also">
85         <title>See Also</title>
86         <simplelist type="inline">
87             <member>
88                 <link linkend="datatips">datatips</link>
89             </member>
90             <member>
91                 <link linkend="datatipCreate">datatipCreate</link>
92             </member>
93             <member>
94                 <link linkend="datatipRemove">datatipRemove</link>
95             </member>
96         </simplelist>
97     </refsection>
98     <refsection>
99         <title>History</title>
100         <revhistory>
101             <revision>
102                 <revnumber>5.5.2</revnumber>
103                 <revremark>
104                     <para>
105                         New "orient" values available: "left", "right", "upper", "lower".
106                     </para>
107                 </revremark>
108             </revision>
109         </revhistory>
110     </refsection>
111 </refentry>