<?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:ns3="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"  xml:id="legend" xml:lang="ja">

    <refnamediv>

        <refname>legend</refname>

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

    </refnamediv>

    <refsynopsisdiv>

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

        <synopsis>hl=legend([h,] string1,string2, ... [,pos] [,boxed])

            hl=legend([h,] strings [,pos] [,boxed])

        </synopsis>

    </refsynopsisdiv>

    <refsection>

        <title>引数</title>

        <variablelist>

            <varlistentry>

                <term>h</term>

                <listitem>

                    <para>

                        軸エンティティのグラフィックハンドルまたは

                        ポリラインエンティティのハンドルを表すベクトル.

                        デフォルト値は<literal>current_axes</literal>の

                        ハンドルとなります.

                    </para>

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>string1,string2, ...</term>

                <listitem>

                    <para>文字列 stringsi は i番目の曲線の凡例となります.</para>

                    <para>Scilab 5.2 以降,

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

                            MathML 式

                        </link>

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

                    </para>

                </listitem>

            </varlistentry>

            <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>pos</term>

                <listitem>

                    <para>(オプション) 凡例を描画する場所を指定;

                        このパラメータには文字列(または廃止予定ですが等価な整数)

                        または

                        凡例ボックスの左上隅の座標を指定するベクトル [x,y]のどちらかを指定します.

                    </para>

                    <para>

                        最初のケースの場合,指定可能な値は次のようになります:

                    </para>

                    <itemizedlist>

                        <listitem>

                            <para>1 または "in_upper_right":

                                凡例は右上隅に描画されます(デフォルト).

                            </para>

                        </listitem>

                        <listitem>

                            <para>2 または "in_upper_left":

                                凡例は左上隅に描画されます.

                            </para>

                        </listitem>

                        <listitem>

                            <para>3 または "in_lower_left":

                                凡例は左下隅に描画されます.

                            </para>

                        </listitem>

                        <listitem>

                            <para>4 または "in_lower_right":

                                凡例は右下隅に描画されます.

                            </para>

                        </listitem>

                        <listitem>

                            <para>5 または "by_coordinates":

                                マウスにより対話的に配置.

                            </para>

                        </listitem>

                        <listitem>

                            <para>-1 または "out_upper_right":

                                凡例は右上隅の右に描画されます.

                            </para>

                        </listitem>

                        <listitem>

                            <para>-2 または "out_upper_left":

                                凡例は左上隅の左に描画されます.

                            </para>

                        </listitem>

                        <listitem>

                            <para>-3 または "out_lower_left":

                                凡例は左下隅の左に描画されます.

                            </para>

                        </listitem>

                        <listitem>

                            <para>-4 または "out_lower_right":

                                凡例は右下隅の右に描画されます.

                            </para>

                        </listitem>

                        <listitem>

                            <para>-5 または "upper_caption":

                                凡例は左上隅の上に描画されます.

                            </para>

                        </listitem>

                        <listitem>

                            <para>-6 または "lower_caption":

                                凡例は左下隅の下に描画されます.

                            </para>

                        </listitem>

                    </itemizedlist>

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>boxed</term>

                <listitem>

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

                </listitem>

            </varlistentry>

            <varlistentry>

                <term>hl</term>

                <listitem>

                    <para>ハンドルで, 全ての凡例を含む複合要素(compound)を指定します.</para>

                </listitem>

            </varlistentry>

        </variablelist>

    </refsection>

    <refsection>

        <title>説明</title>

        <para>

            ラベルとして指定された文字列を用いてカレントのプロットに凡例を出力します.

            凡例の前には対応する線またはパッチに付随する記号が付加されます.

            この記号の形状やプロパティは指定したハンドルから取得されます:

        </para>

        <para>ハンドル引数を指定せずにコールされた場合(もしくは軸エンティティの

            ハンドルが指定された場合),この関数はまず指定した軸の子であるポリラインの

            ハンドルからなるベクトルを構築します.

        </para>

        <para>対話的な配置モード (opt=5) においては, マウスで凡例ボックスを

            移動し, 離す際には左ボタンを押します.

        </para>

    </refsection>

    <refsection>

        <title>例</title>

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

t=linspace(0,%pi,20);

a=gca();

a.data_bounds=[t(1) -1.8;t($) 1.8];



plot2d(t,[cos(t'),cos(2*t'),cos(3*t')],[-5,2 3]);

e=gce();

e1=e.children(1);

e1.thickness=2;

e1.polyline_style=4;

e1.arrow_size_factor = 1/2;

e.children(2).line_style=4;

e3=e.children(3);

e3.line_mode='on';

e3.mark_background=5;



hl=legend(['cos(t)';'cos(2*t)';'cos(3*t)']);

 ]]></programlisting>

        <scilab:image>



            t=linspace(0,%pi,20);

            a=gca();

            a.data_bounds=[t(1) -1.8;t($) 1.8];



            plot2d(t,[cos(t'),cos(2*t'),cos(3*t')],[-5,2 3]);

            e=gce();

            e1=e.children(1);

            e1.thickness=2;

            e1.polyline_style=4;

            e1.arrow_size_factor = 1/2;

            e.children(2).line_style=4;

            e3=e.children(3);

            e3.line_mode='on';

            e3.mark_background=5;



            hl=legend(['cos(t)';'cos(2*t)';'cos(3*t)']);

        </scilab:image>

    </refsection>

    <refsection role="see also">

        <title>参照</title>

        <simplelist type="inline">

            <member>

                <link linkend="xstring">xstring</link>

            </member>

            <member>

                <link linkend="captions">captions</link>

            </member>

            <member>

                <link linkend="polyline_properties">polyline_properties</link>

            </member>

        </simplelist>

    </refsection>

</refentry>

