<?xml version="1.0" encoding="UTF-8"?>

<!--

 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab

 * Copyright (C) INRIA

 *


 * 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="ja" xml:id="legends">

    <refnamediv>

        <refname>legends</refname>

        <refpurpose>グラフの凡例を描画</refpurpose>

    </refnamediv>

    <refsynopsisdiv>

        <title>呼び出し手順</title>

        <synopsis>legends(strings,style,&lt;opt_args&gt;)

        </synopsis>

    </refsynopsisdiv>

    <refsection>

        <title>引数</title>

        <variablelist>

            <varlistentry>

                <term>strings</term>

                <listitem>

                    <para>文字列のベクトルで, strings(i) は i番目の曲線の凡例となります.</para>

                    <para>Scilab 5.2 以降,

                        <link linkend="math_rendering_features_in_graphic">LaTeX または

                            MathML 式

                        </link>

                        を記述することが可能です.

                    </para>

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>style</term>

                <listitem>

                    <para>大きさnの整数行ベクトル (プロット形式, plot2d の3番目のパラメータ)

                        または 2 x n の整数行列. 後者の場合, style(1,k)はk番目の曲線のプロット形式,

                        style(2,k) は線の種類(style(1,k)&gt;0 の場合) またはマーカの色 ( style(1,k)&lt;0の場合)

                        です.

                    </para>

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>&lt;opt_args&gt;</term>

                <listitem>

                    <para>一連の命令

                        <literal>key1=value1,key2=value2</literal>,...を表し, <literal>key1</literal>,

                        <literal>key2,...</literal> には以下のどれかを指定できます:

                    </para>

                    <variablelist>

                        <varlistentry>

                            <term>opt</term>

                            <listitem>

                                <para>凡例を描画する場所を指定します;

                                    このパラメータは整数フラグ(または等価な文字列フラグ)または

                                    凡例ボックスの左上隅の座標を指定するベクトル [x,y] とすることができます.

                                    最初の場合,以下の値を指定可能です:

                                </para>

                                <variablelist>

                                    <varlistentry>

                                        <term>1 または "ur"</term>

                                        <listitem>

                                            <para>凡例は右上隅に描画されます.</para>

                                        </listitem>

                                    </varlistentry>

                                    <varlistentry>

                                        <term>2 または "ul"</term>

                                        <listitem>

                                            <para>凡例は左上隅に描画されます.</para>

                                        </listitem>

                                    </varlistentry>

                                    <varlistentry>

                                        <term>3 または "ll"</term>

                                        <listitem>

                                            <para> 凡例は左下隅に描画されます.</para>

                                        </listitem>

                                    </varlistentry>

                                    <varlistentry>

                                        <term>4 または "lr"</term>

                                        <listitem>

                                            <para>凡例は右下隅に描画されます.</para>

                                        </listitem>

                                    </varlistentry>

                                    <varlistentry>

                                        <term>5 または "?"</term>

                                        <listitem>

                                            <para>マウスにより対話的に配置(デフォルト).</para>

                                        </listitem>

                                    </varlistentry>

                                    <varlistentry>

                                        <term>6 または "below"</term>

                                        <listitem>

                                            <para>凡例はグラフの下に描画されます (適当にリサイズされます).</para>

                                        </listitem>

                                    </varlistentry>

                                </variablelist>

                            </listitem>

                        </varlistentry>

                        <varlistentry>

                            <term>with_box</term>

                            <listitem>

                                <para>論理値 (デフォルト値 %t) で,ボックス描画の有無を指定します.</para>

                            </listitem>

                        </varlistentry>

                        <varlistentry>

                            <term>font_size</term>

                            <listitem>

                                <para>整数 (デフォルト値 1) で,凡例で使用されるフォントの大きさを指定します.</para>

                            </listitem>

                        </varlistentry>

                    </variablelist>

                </listitem>

            </varlistentry>

        </variablelist>

    </refsection>

    <refsection>

        <title>説明</title>

        <para>

            カレントのプロットに指定された文字列をラベルとする凡例を表示します.

        </para>

        <para>

            対話的な配置(opt=5 または opt="?")ではマウスで凡例ボックスを移動し,

            左ボタンを押すことでリリースします.

        </para>

        <para>

            この関数は plot2d の leg 引数よりも柔軟に凡例を配置することができます.

        </para>

    </refsection>



    <refsection>

        <title>例</title>

        <programlisting role="example"><![CDATA[

// 例 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")

 ]]></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[

t=0:0.1:2*%pi;

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>

        <programlisting role="example"><![CDATA[

// 例 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>参照</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>

