← 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/datatipGetEntities.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/datatipGetEntities.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="datatipGetEntities">
12
 
  <refnamediv>
13
 
    <refname>datatipGetEntities</refname>
14
 
    <refpurpose>Get all the entities compatible with datatips in the given axes. </refpurpose>
15
 
  </refnamediv>
16
 
  <refsynopsisdiv>
17
 
    <title>Calling Sequence</title>
18
 
    <synopsis>
19
 
      curve_handles=datatipGetEntities(ax)
20
 
      curve_handles=datatipGetEntities()
21
 
    </synopsis>
22
 
  </refsynopsisdiv>
23
 
  <refsection>
24
 
    <title>Arguments</title>
25
 
    <variablelist>
26
 
      <varlistentry>
27
 
        <term>ax</term>
28
 
        <listitem>
29
 
          <para>
30
 
            A handle on an axes entity. The default value is <literal>gca()</literal>
31
 
          </para>
32
 
        </listitem>
33
 
      </varlistentry>
34
 
    </variablelist>
35
 
    <variablelist>
36
 
      <varlistentry>
37
 
        <term>curve_handles</term>
38
 
        <listitem>
39
 
          <para>
40
 
            An array of handle on entities compatible with datatips. 
41
 
          </para>
42
 
        </listitem>
43
 
      </varlistentry>
44
 
    </variablelist>
45
 
  </refsection>
46
 
  <refsection>
47
 
    <title>Description</title>
48
 
    <para>
49
 
      Get all the entities compatible with datatips in the given
50
 
      axes. In the current version only polyline entities are
51
 
      handled.
52
 
    </para>
53
 
  </refsection>
54
 
  <refsection>
55
 
    <title>Examples</title>
56
 
    <programlisting role="example"><![CDATA[
 
12
    <refnamediv>
 
13
        <refname>datatipGetEntities</refname>
 
14
        <refpurpose>Get all the entities compatible with datatips in the given axes. </refpurpose>
 
15
    </refnamediv>
 
16
    <refsynopsisdiv>
 
17
        <title>Calling Sequence</title>
 
18
        <synopsis>
 
19
            curve_handles=datatipGetEntities(ax)
 
20
            curve_handles=datatipGetEntities()
 
21
        </synopsis>
 
22
    </refsynopsisdiv>
 
23
    <refsection>
 
24
        <title>Arguments</title>
 
25
        <variablelist>
 
26
            <varlistentry>
 
27
                <term>ax</term>
 
28
                <listitem>
 
29
                    <para>
 
30
                        A handle on an axes entity. The default value is <literal>gca()</literal>
 
31
                    </para>
 
32
                </listitem>
 
33
            </varlistentry>
 
34
        </variablelist>
 
35
        <variablelist>
 
36
            <varlistentry>
 
37
                <term>curve_handles</term>
 
38
                <listitem>
 
39
                    <para>
 
40
                        An array of handle on entities compatible with datatips. 
 
41
                    </para>
 
42
                </listitem>
 
43
            </varlistentry>
 
44
        </variablelist>
 
45
    </refsection>
 
46
    <refsection>
 
47
        <title>Description</title>
 
48
        <para>
 
49
            Get all the entities compatible with datatips in the given
 
50
            axes. In the current version only polyline entities are
 
51
            handled.
 
52
        </para>
 
53
    </refsection>
 
54
    <refsection>
 
55
        <title>Examples</title>
 
56
        <programlisting role="example"><![CDATA[
57
57
    clf();plot2d();
58
58
    xarrows([3;2.72],[1.6;0.96],3,2);
59
59
    xstring(3,1.6,'sin(t)')
61
61
    curve_handles.visible='off';
62
62
    curve_handles.visible='on';
63
63
    ]]></programlisting>
64
 
  </refsection>
65
 
  <refsection role="see also">
66
 
    <title>See Also</title>
67
 
    <simplelist type="inline">
68
 
      <member>
69
 
        <link linkend="datatips">datatips</link>
70
 
      </member>
71
 
    </simplelist>
72
 
  </refsection>
 
64
    </refsection>
 
65
    <refsection role="see also">
 
66
        <title>See Also</title>
 
67
        <simplelist type="inline">
 
68
            <member>
 
69
                <link linkend="datatips">datatips</link>
 
70
            </member>
 
71
        </simplelist>
 
72
    </refsection>
73
73
</refentry>