← Back to branch summary

~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/graphics/help/en_US/datatips/datatipSetOrientation.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
modules/graphics/help/en_US/datatips/datatipSetOrientation.xml
9
9
 * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
10
10
-->
11
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" version="5.0-subset Scilab" 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
45
 
              right"
46
 
            </literal>
47
 
            .
48
 
          </para>
49
 
        </listitem>
50
 
      </varlistentry>
51
 
    </variablelist>
52
 
  </refsection>
53
 
  <refsection>
54
 
    <title>Description</title>
55
 
    <para>
56
 
      Set the position on the text box with respect to the polyline
57
 
      point. With the <literal>"automatic"</literal> orientation the
58
 
      program makes the choice of the position trying to prevent
59
 
      text from overlapping polyline, it also tries to to keep the text
60
 
      box within the plot boundaries.
61
 
    </para>
62
 
  </refsection>
63
 
  <refsection>
64
 
    <title>Examples</title>
65
 
    <programlisting role="example"><![CDATA[
 
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
 
45
                            right"
 
46
                        </literal>
 
47
                        .
 
48
                    </para>
 
49
                </listitem>
 
50
            </varlistentry>
 
51
        </variablelist>
 
52
    </refsection>
 
53
    <refsection>
 
54
        <title>Description</title>
 
55
        <para>
 
56
            Set the position on the text box with respect to the polyline
 
57
            point. With the <literal>"automatic"</literal> orientation the
 
58
            program makes the choice of the position trying to prevent
 
59
            text from overlapping polyline, it also tries to to keep the text
 
60
            box within the plot boundaries.
 
61
        </para>
 
62
    </refsection>
 
63
    <refsection>
 
64
        <title>Examples</title>
 
65
        <programlisting role="example"><![CDATA[
66
66
    x=linspace(-20,20,1000);
67
67
    clf()
68
68
    plot(x,sinc(x),x,sinc(x^2));
71
71
    d2=datatipCreate(e(2),60);
72
72
    datatipSetOrientation(d2,"lower left") 
73
73
    ]]></programlisting>
74
 
  </refsection>
75
 
  <refsection role="see also">
76
 
    <title>See Also</title>
77
 
    <simplelist type="inline">
78
 
      <member>
79
 
        <link linkend="datatips">datatips</link>
80
 
      </member>
81
 
      <member>
82
 
        <link linkend="datatipCreate">datatipCreate</link>
83
 
      </member>
84
 
      <member>
85
 
        <link linkend="datatipRemove">datatipRemove</link>
86
 
      </member>
87
 
    </simplelist>
88
 
  </refsection>
 
74
    </refsection>
 
75
    <refsection role="see also">
 
76
        <title>See Also</title>
 
77
        <simplelist type="inline">
 
78
            <member>
 
79
                <link linkend="datatips">datatips</link>
 
80
            </member>
 
81
            <member>
 
82
                <link linkend="datatipCreate">datatipCreate</link>
 
83
            </member>
 
84
            <member>
 
85
                <link linkend="datatipRemove">datatipRemove</link>
 
86
            </member>
 
87
        </simplelist>
 
88
    </refsection>
89
89
</refentry>