<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) ENPC - Jean-Philippe Chancelier
 *
 * 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="xtitle">
    <refnamediv>
        <refname>xtitle</refname>
        <refpurpose>グラフィックスウインドにタイトルを追加する</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>呼び出し手順</title>
        <synopsis>xtitle(title,[x_label,[y_label,[z_label]]],&lt;opts_args&gt;)</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>引数</title>
        <variablelist>
            <varlistentry>
                <term>title,x_label,y_label, z_label</term>
                <listitem>
                    <para>文字列の行列.</para>
                    <para>Scilab 5.2以降,
                        <link linkend="math_rendering_features_in_graphic">LaTeX
                            または MathML 式
                        </link>
                        を指定することができます.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>&lt;opt_args&gt;</term>
                <listitem>
                    <para>
                        一連の命令 <literal>key1=value1,
                            key2=value2
                        </literal>
                        ,... ,ただし,
                        キーには<literal>boxed</literal>とすることが
                        できます(下記参照).
                        この場合, 順番に特別な意味はありません.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>boxed</term>
                <listitem>
                    <para>整数値. 1の場合, 各タイトルの周囲にボックスが
                        描画されます.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>説明</title>
        <para>
            <literal>xtitle</literal> は 2D または 3D プロットに
            タイトルを追加します.
            <literal>title</literal>は一般的なタイトルで,
            <emphasis role="bold">x_label</emphasis>,
            <emphasis role="bold">y_label</emphasis> および
            <emphasis role="bold">z_label</emphasis> は
            3軸のタイトルです.
            引数が行列の場合,行列の各行が異なる線上に表示されます.
        </para>
        <para>
            デモを参照には,コマンド <literal>xtitle()</literal> と入力してください.
        </para>
    </refsection>
    <refsection>
        <title>例</title>
        <programlisting role="example"><![CDATA[
plot3d() ;
// タイトルを描画
xtitle( 'My surface is blue', 'X axis', 'Y axis', 'Z axis' ) ;
// タイトルの周囲にボックスを描画
xtitle( 'My surface is blue', 'X axis', 'Y axis', 'Z axis', boxed = %t );

//  LaTeX & MathMLで指定:
mathml="<mrow>      <mfrac>        <mrow>          <mi>d</mi>          <mi>y</mi>        </mrow>        <mrow>          <mi>d</mi>          <mi>x</mi>        </mrow>      </mfrac>      <mo>=</mo>      <mfrac>        <mn>1</mn>        <msup>          <mi>y</mi>          <mn>2</mn>        </msup>      </mfrac>    </mrow>";

xtitle( 'My surface is blue', 'X axis', '$Y axis$', mathml );
 ]]></programlisting>
        <scilab:image>
            plot3d() ;
            xtitle( 'My surface is blue', 'X axis', 'Y axis', 'Z axis' ) ;
        </scilab:image>
    </refsection>
    <refsection role="see also">
        <title>参考</title>
        <simplelist type="inline">
            <member>
                <link linkend="titlepage">titlepage</link>
            </member>
            <member>
                <link linkend="label_properties">label_properties</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
