<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Copyright (C) INRIA -  Serge Steer Serge.Steer@inria.fr
 *
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 *
 * This file is hereby licensed under the terms of the GNU GPL v2.0,
 * pursuant to article 5.3.4 of the CeCILL v.2.1.
 * This file was originally licensed under the terms of the CeCILL v2.1,
 * and continues to be available under such terms.
 * For more information, see the COPYING file which you should have received
 * along with this program.
-->
<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="datatipGetEntities">
    <refnamediv>
        <refname>datatipGetEntities</refname>
        <refpurpose>Get all the entities compatible with datatips in the given axes.</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Syntax</title>
        <synopsis>
            curve_handles=datatipGetEntities(ax)
            curve_handles=datatipGetEntities()
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>ax</term>
                <listitem>
                    <para>
                        A handle on an axes entity. The default value is <literal>gca()</literal>
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
        <variablelist>
            <varlistentry>
                <term>curve_handles</term>
                <listitem>
                    <para>
                        An array of handle on entities compatible with datatips.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            Get all the entities compatible with datatips in the given
            axes. In the current version only polyline entities are
            handled.
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
    clf();plot2d();
    xarrows([3;2.72],[1.6;0.96],3,2);
    xstring(3,1.6,'sin(t)')
    curve_handles=datatipGetEntities()
    curve_handles.visible='off';
    curve_handles.visible='on';
    ]]></programlisting>
        <scilab:image>
            plot2d();
            xarrows([3;2.72],[1.6;0.96],3,2);
            xstring(3,1.6,'sin(t)')
            curve_handles=datatipGetEntities()
            curve_handles.visible='off';
            curve_handles.visible='on';
        </scilab:image>
    </refsection>
    <refsection role="see also">
        <title>See also</title>
        <simplelist type="inline">
            <member>
                <link linkend="datatips">datatips</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
