<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://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:ns5="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="plotframe" xml:lang="pt">
    <refnamediv>
        <refname>plotframe</refname>
        <refpurpose>esboça uma moldura com escalas e grides. Esta função está
            obsoleta.
        </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Syntax</title>
        <synopsis>plotframe(rect,tics,[arg_opt1,arg_opt2,arg_opt3])
            plotframe(rect,&lt;opts_args&gt;)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Parameters</title>
        <variablelist>
            <varlistentry>
                <term>rect</term>
                <listitem>
                    <para>
                        vetor <literal>[xmin,ymin,xmax,ymax]</literal>.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>tics</term>
                <listitem>
                    <para>
                        vetor <literal>[nx,mx,ny,my]</literal> onde <literal>mx,
                            nx
                        </literal>
                        (resp. <literal>my, ny</literal>) são o número de
                        intervalos e subintervalos do eixo x (resp. eixo y) .
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>arg_optX</term>
                <listitem>
                    <para>até três argumentos opcionais escolhidos entre.</para>
                    <variablelist>
                        <varlistentry>
                            <term>flags</term>
                            <listitem>
                                <para>
                                    vetor <literal>[wantgrids,findbounds]</literal> onde
                                    <literal>wantgrids</literal> é uma variável booleana
                                    (<literal>%t</literal> ou <literal>%f</literal>) que indica o
                                    gridding. <literal>findbounds</literal> é uma variável
                                    booleana. Se <literal>findbounds</literal> for
                                    <literal>%t</literal>, os limites dados em
                                    <literal>rect</literal> podem ser ligeiramente modificados (na
                                    verdade sempre aumentados) a fim de se obter graduações mais
                                    simples: então <literal>tics(2)</literal> e
                                    <literal>tics(4)</literal> são ignorados.
                                </para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>Captions</term>
                            <listitem>
                                <para>vetor de três strings
                                    <literal>[title,x-leg,y-leg]</literal> correspondentes
                                    respectivamente ao título do esboço e às legendas dos eixos x
                                    e y. Aviso: o "C" maiúsculo é importante.
                                </para>
                            </listitem>
                        </varlistentry>
                        <varlistentry>
                            <term>subwin</term>
                            <listitem>
                                <para>um vetor de tamanho 4 definindo a sub-janela. A
                                    sub-janela é especificada através do parâmetro
                                    <literal>subwin=[x,y,w,h]</literal> (ponto superior esquerdo,
                                    largura, altura). Os valores em <literal>subwin</literal> são
                                    especificados utilizando-se a proporção de largura ou altura
                                    da janela de gráficos corrente (ver
                                    <literal>xsetech</literal>).
                                </para>
                            </listitem>
                        </varlistentry>
                    </variablelist>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>&lt;opts_args&gt;</term>
                <listitem>
                    <para>
                        representa uma seqüência de declarações <emphasis role="bold">key1=value1</emphasis>,<emphasis role="bold">
                            key2=value2
                        </emphasis>
                        ,... onde <emphasis role="bold">key1</emphasis>, <emphasis role="bold">key2</emphasis>,... podem ser um dos seguintes:
                        <emphasis role="bold">tics</emphasis>, <emphasis role="bold">flags</emphasis>, <emphasis role="bold">captions</emphasis> ou <emphasis role="bold">subwin</emphasis>. Estes argumentos têm o mesmo
                        significado que aqueles utilizados na primeira forma da
                        rotina.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Descrição</title>
        <para>
            <literal>plotframe</literal> é utilizado com funções de esboço 2d
            <link linkend="plot2d">plot2d</link>, <link linkend="plot2d2">plot2d2</link>,... para ajustar uma moldura gráfica.
            Deve ser usado antes de <literal>plot2d</literal> que deve ser chamado com
            o modo de superposição "000" .
        </para>
        <para>
            <emphasis role="bold">Esta função está obsoleta.</emphasis>
        </para>
    </refsection>
    <refsection>
        <title>Exemplos</title>
        <programlisting role="example"><![CDATA[
x=[-0.3:0.8:27.3]';
y=rand(x);
rect=[min(x),min(y),max(x),max(y)];
tics=[4,10,2,5];    //4 x-intervalos e 2 y-intervalos
plotframe(rect,tics,[%f,%f],["Meu esboço","x","y"],[0,0,0.5,0.5])
plot2d(x,y,2,"000")
plotframe(rect,tics=tics,flags=[%t,%f],Captions=["Meu esboço com grides","x","y"],subwin=[0.5,0,0.5,0.5])
plot2d(x,y,3,"000")
plotframe(rect,tics,[%t,%t],..
["Meu esboço com grides e fronteiras automáticas","x","y"],[0,0.5,0.5,0.5])
plot2d(x,y,4,"000")
plotframe(rect,flags=[%f,%t],tics=tics,..
          Captions=["Meu esboço sem grides mas com fronteiras automáticas ","x","y"],..
          subwin=[0.5,0.5,0.5,0.5])
plot2d(x,y,5,"000")
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>Ver Também</title>
        <simplelist type="inline">
            <member>
                <link linkend="plot2d">plot2d</link>
            </member>
            <member>
                <link linkend="graduate">graduate</link>
            </member>
            <member>
                <link linkend="xsetech">xsetech</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
