<?xml version="1.0" encoding="UTF-8"?>
<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="fr" xml:id="legends">
    <refnamediv>
        <refname>legends</refname>
        <refpurpose>dessine des légendes de courbes
            2D
        </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Séquence d'appel</title>
        <synopsis>legends(strings,style,&lt;opt_args&gt;)
            legends(strings,style,xy)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Paramètres</title>
        <variablelist>
            <varlistentry>
                <term>strings</term>
                <listitem>
                    <para>vecteur de chaînes de caractères, strings(i) est la légende de
                        la ième courbe
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>style :</term>
                <listitem>
                    <para>vecteur ligne entier de taille n (les styles de dessin de chaque
                        courbe, troisième paramètre de plot2d) ou une matrice d'entiers 2 x
                        n, style(1,k) contenant le style pour la k-ième courbe et style(2,k)
                        contient le style de ligne (si style(1,k)&gt;0) ou la couleur du
                        marqueur (si style(1,k)&lt;0).
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>&lt;opt_args&gt;</term>
                <listitem>
                    <para>This represents a sequence of statements
                        <literal>key1=value1,key2=value2</literal>,... where <literal>key1</literal>,
                        <literal>key2,...</literal> can be one of the following:
                    </para>
                    <variablelist>
                        <varlistentry>
                            <term>opt</term>
                            <listitem>
                                <para>determine la position des légendes. Ce paramètre peut être un vecteur
                                    [x,y] spécifiant les coordonnées du point supérieur gauche de la boîte
                                    contenant les légendes. Il peut aussi prendre l'une des valeurs suivantes:
                                </para>
                                <variablelist>
                                    <varlistentry>
                                        <term>1 or "ur"</term>
                                        <listitem>
                                            <para>les légendes sont positionnées dans le coin supérieur droit.</para>
                                        </listitem>
                                    </varlistentry>
                                    <varlistentry>
                                        <term>2 or "ul"</term>
                                        <listitem>
                                            <para>les légendes sont positionnées dans le coin supérieur gauche.</para>
                                        </listitem>
                                    </varlistentry>
                                    <varlistentry>
                                        <term>3 or "ll"</term>
                                        <listitem>
                                            <para>les légendes sont positionnées dans le coin inférieur gauche.</para>
                                        </listitem>
                                    </varlistentry>
                                    <varlistentry>
                                        <term>4 or "lr"</term>
                                        <listitem>
                                            <para>les légendes sont positionnées dans le coin inférieur droit.</para>
                                        </listitem>
                                    </varlistentry>
                                    <varlistentry>
                                        <term>5 or "?"</term>
                                        <listitem>
                                            <para>placement intéractif avec la souris.</para>
                                        </listitem>
                                    </varlistentry>
                                    <varlistentry>
                                        <term>6 or "below"</term>
                                        <listitem>
                                            <para>les légendes sont positionnées en dessous du graphique
                                                (qui est alors réduit pour laisser de la place aux légendes).
                                            </para>
                                        </listitem>
                                    </varlistentry>
                                </variablelist>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>with_box</term>
                            <listitem>
                                <para>booléen (%t par défaut) qui détermine la présence du cadre
                                    des légendes.
                                </para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>font_size</term>
                            <listitem>
                                <para>entier (1 par défaut) précisant la taille de la fonte utilisée pour
                                    les légendes.
                                </para>
                            </listitem>
                        </varlistentry>
                    </variablelist>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>Dessine des légendes sur le dessin courant à partir des chaînes de
            caractères données.
        </para>
        <para>En cas de placement interactif (opt=5) déplacer la boîte de la légende
            avec la souris et presser bouton de gauche pour la fixer.
        </para>
        <para>Cette fonction permet de placer les légendes avec plus de liberté que
            l'argument leg de plot2d.
        </para>
        <para/>
    </refsection>
    <refsection>
        <title>Exemples</title>
        <programlisting role="example"><![CDATA[
// Exemple 1
t=0:0.1:2*%pi;
plot2d(t,[cos(t'),cos(2*t'),cos(3*t')],[-1,2 3]);
legends(['cos(t)';'cos(2*t)';'cos(3*t)'],[-1,2 3],opt="lr")

scf() ;
gca().line_style = 2;
plot2d(t,cos(t),style=5);
gca().line_style = 4;
plot2d(t,sin(t),style=3);
legends(["sin(t)";"cos(t)"],[[5;2],[3;4]], with_box=%f, opt="?")
 ]]></programlisting>
        <scilab:image>
            t=0:0.1:2*%pi;
            plot2d(t,[cos(t'),cos(2*t'),cos(3*t')],[-1,2 3]);
            legends(['cos(t)';'cos(2*t)';'cos(3*t)'],[-1,2 3],opt="lr")
        </scilab:image>
        <programlisting role="example"><![CDATA[
// Exemple 2
scf() ;
subplot(221)
t=0:0.1:2*%pi;
plot2d(t,[cos(t'),cos(2*t'),cos(3*t')],[-1,2 3]);
legends(['cos(t)';'cos(2*t)';'cos(3*t)'],[-1,2 3], opt=3 )

subplot(222)
gca().line_style = 2;
plot2d(t,cos(t),style=5);
gca().line_style = 4;
plot2d(t,sin(t),style=3);
legends(["sin(t)";"cos(t)"],[[5;2],[3;4]], with_box=%f, opt=6 )

subplot(223)
gca().line_style = 2;
plot2d(t,cos(t),style=5);
gca().line_style = 4;
plot2d(t,sin(t),style=3);
legends(["sin(t)";"cos(t)"],[[5;2],[3;4]], with_box=%f, opt=1, font_size=2 )

subplot(224)
t=0:0.1:2*%pi;
plot2d(t,[cos(t'),cos(2*t'),cos(3*t')],[-1,2 3]);
legends(['cos(t)';'cos(2*t)';'cos(3*t)'],[-1,2 3], opt=2, font_size=1 )
 ]]></programlisting>
        <scilab:image>
            subplot(221)
            t=0:0.1:2*%pi;
            plot2d(t,[cos(t'),cos(2*t'),cos(3*t')],[-1,2 3]);
            legends(['cos(t)';'cos(2*t)';'cos(3*t)'],[-1,2 3], opt=3 )

            subplot(222)
            gca().line_style = 2;
            plot2d(t,cos(t),style=5);
            gca().line_style = 4;
            plot2d(t,sin(t),style=3);
            legends(["sin(t)";"cos(t)"],[[5;2],[3;4]], with_box=%f, opt=6 )

            subplot(223)
            gca().line_style = 2;
            plot2d(t,cos(t),style=5);
            gca().line_style = 4;
            plot2d(t,sin(t),style=3);
            legends(["sin(t)";"cos(t)"],[[5;2],[3;4]], with_box=%f, opt=1, font_size=2 )

            subplot(224)
            t=0:0.1:2*%pi;
            plot2d(t,[cos(t'),cos(2*t'),cos(3*t')],[-1,2 3]);
            legends(['cos(t)';'cos(2*t)';'cos(3*t)'],[-1,2 3], opt=2, font_size=1 )
        </scilab:image>
    </refsection>
    <refsection role="see also">
        <title>Voir aussi</title>
        <simplelist type="inline">
            <member>
                <link linkend="plot2d">plot2d</link>
            </member>
            <member>
                <link linkend="xstring">xstring</link>
            </member>
            <member>
                <link linkend="xtitle">xtitle</link>
            </member>
            <member>
                <link linkend="legend">legend</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
