<?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="pt" xml:id="datatip_properties">
    <refnamediv>
        <refname>propriedades das datatips</refname>
        <refpurpose>Descição das propriedades para a entidade Datatip.
        </refpurpose>
    </refnamediv>
    <refsection>
        <title>Descrição</title>
        <para>
            A entidade Datatip é uma das folhas na hierarquia de entidades gráficas. Esta
            entidade define os parametros para as Datatips.
        </para>
        <variablelist>
            <varlistentry>
                <term>parent: </term>
                <listitem>
                    <para>
                        handle of the curve the datatip is plugged on.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>children: </term>
                <listitem>
                    <para>unused.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>visible: </term>
                <listitem>
                    <para>"on": the datatip is displayable according to the
                            <literal>parent.datatip_display_mode</literal> setting.
                    </para>
                    <para>"off": the datatip display is canceled anyway.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>data: </term>
                <listitem>
                    <para>
                        Cartesian coordinates of the datatip's anchor on its curve, in data scales.
                        For curves in special not-cartesian grids (after polarplot(), sgrid(), etc),
                        <varname>.data</varname> contains the raw equivalent cartesian coordinates.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>text: </term>
                <listitem>
                    <para>
                        Matrix of texts to be displayed (as a matrix) in the datatip label.
                        Leading and trailing spaces are all trimmed. In each cell,
                        the text is centered.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>interp_mode: </term>
                <listitem>
                    <para>
                        Esse campo controla a interpolação utilizada para posicionar a datatip. Quando este valor é
                        <literal>"on"</literal> é aplicada uma interpolação linear entre a malha de pontos no posicionamento
                        das datatips, quando seu valor é <literal>"off"</literal> as datatips so podem ser posicionadas sobre
                        os pontos contidos na malha.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>box_mode: </term>
                <listitem>
                    <para>
                        Esse campo contêm o valor padrão para a propriedade <literal>box_mode</literal>
                        das datatips. Quando este valor é <literal>"on"</literal> a caixa envoltória é desenhada,
                        quando o valor é <literal>"off"</literal> nenhuma caixa é desenhada.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>label_mode: </term>
                <listitem>
                    <para>
                        Esse campo contêm o valor padrão para a propriedade <literal>label_mode</literal>
                        das datatips. Quando este valor é <literal>"on"</literal> os rótulos são desenhados,
                        quando o valor é <literal>"off"</literal> nenhuma  rótulo é desenhado.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>display_components: </term>
                <listitem>
                    <para>
                        Esse campo controla quais componentes são desenhadas. Quando em 2D, seu valor padrão é
                        <literal>"xy"</literal>, para 3D seu valor padrão é <literal>"xyz"</literal>.
                        Possíveis valores para este campo incluem qualquer combinação de <literal>"x"</literal>,
                        <literal>"y"</literal> e <literal>"z"</literal>.
                        Alguns exemplos para este campo são <literal>"zy"</literal>,
                        <literal>"xzy"</literal>, <literal>"xz"</literal>, <literal>"y"</literal>
                        e assim por diante.
                    </para>
                   <para>
                     As componentes sao desenhadas na mesma ordem em que são encontradas na string.
                   </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>display_function: </term>
                <listitem>
                    <para>Veja
                        <literal>
                            <link linkend="polyline_properties">polyline_properties</link>
                        </literal>
                        nas páginas de ajuda.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>orientation: </term>
                <listitem>
                    <para>
                        Este campo controla a posição da caixa de texto em respeito ao ponto de âncora na polyline.
                        Os possíveis valores são 0 (esquerdo superior), 1 (direito superior), 2 (esquerdo inferior), 3 (direito inferior),
                        4 (esquerda), 5 (direita), 6 (superior) ou 7 (inferior).
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>auto_orientation: </term>
                <listitem>
                    <para>
                        Esse campo contêm o valor padrão para a propriedade <literal>auto_orientation</literal>
                        das datatips.  Quando este valor é <literal>"on"</literal> a orientação é automatica,
                        quando o valor é <literal>"off"</literal> a orientação é dada pelo campo <literal>orientation</literal>.
                        Veja a propriedade <literal>orientation</literal>.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>detached_position: </term>
                <listitem>
                    <para>
                      This field sets the position <literal>[x y z]</literal> of the bottom left
                      corner of the datatip text box, even when the link to the polyline starts
                      from another corner.  When its value  is <literal>[]</literal>,
                      the datatip text box is drawn attached to its anchor point in the polyline.
                    </para>
                    <para>
                      In detached mode, it is not possible to force the starting point of the link
                      on the box frame. It is autoset.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>font_foreground: </term>
                <listitem>
                    <para>
                        Esse campo contêm o valor padrão para a propriedade <literal>font_foreground</literal>.
                        Seu valor deve ser o índice de uma cor relativo ao mapa de cores atual.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>foreground: </term>
                <listitem>
                    <para>
                        Esse campo contêm o valor padrão para a propriedade <literal>foreground</literal>
                        usado para desenhar a caixa envoltória. Seu valor deve ser o índice de
                        uma cor relativo ao mapa de cores atual.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>background: </term>
                <listitem>
                    <para>Veja
                        <literal>
                            <link linkend="polyline_properties">polyline_properties</link>
                        </literal>
                        nas páginas de ajuda.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>mark_mode: </term>
                <listitem>
                    <para>Veja
                        <literal>
                            <link linkend="polyline_properties">polyline_properties</link>
                        </literal>
                        nas páginas de ajuda.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>mark_style: </term>
                <listitem>
                    <para>Veja
                        <literal>
                            <link linkend="polyline_properties">polyline_properties</link>
                        </literal>
                        nas páginas de ajuda.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>mark_size_unit: </term>
                <listitem>
                    <para>Veja
                        <literal>
                            <link linkend="polyline_properties">polyline_properties</link>
                        </literal>
                        nas páginas de ajuda.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>mark_size: </term>
                <listitem>
                    <para>Veja
                        <literal>
                            <link linkend="polyline_properties">polyline_properties</link>
                        </literal>
                        nas páginas de ajuda.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>mark_foreground: </term>
                <listitem>
                    <para>Veja
                        <literal>
                            <link linkend="polyline_properties">polyline_properties</link>
                        </literal>
                        nas páginas de ajuda.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>mark_background: </term>
                <listitem>
                    <para>Veja
                        <literal>
                            <link linkend="polyline_properties">polyline_properties</link>
                        </literal>
                        nas páginas de ajuda.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>user_data: </term>
                <listitem>
                    <para>Veja
                        <literal>
                            <link linkend="polyline_properties">polyline_properties</link>
                        </literal>
                        nas páginas de ajuda.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>tag: </term>
                <listitem>
                    <para>
                        Esse campo contêm uma string normalmente utilizada para identificar o controle.
                        Veja <literal>
                            <link linkend="figure_properties">figure_properties</link>
                        </literal>
                        nas páginas de ajuda.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection role="see also">
        <title>See also</title>
        <simplelist type="inline">
            <member>
                <link linkend="polyline_properties">polyline_properties</link>
            </member>
            <member>
                <link linkend="figure_properties">figure_properties</link>
            </member>
            <member>
                <link linkend="graphics_entities">graphics_entities</link>
            </member>
        </simplelist>
    </refsection>
    <refsection>
        <title>History</title>
        <revhistory>
            <revision>
                <revnumber>5.5.2</revnumber>
                <revremark>
                    <para>
                        Novo "orientation" valores disponíveis: "left", "right", "upper", "lower".
                    </para>
                </revremark>
            </revision>
            <revision>
                <revnumber>6.0.0</revnumber>
                <revremark>
                   <itemizedlist>
                     <listitem>
                       <literal>.z_component</literal> is removed.
                     </listitem>
                     <listitem>
                       New <literal>.display_components</literal> and
                       <literal>.detached_position</literal> properties.
                     </listitem>
                   </itemizedlist>
                </revremark>
            </revision>
        </revhistory>
    </refsection>
</refentry>
