<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) INRIA - Djalel Abdemouche
 *
 * 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="en" xml:id="Compound_properties">
    <refnamediv>
        <refname>Compound properties</refname>
        <refpurpose>
            description of the Compound entity properties
        </refpurpose>
    </refnamediv>
    <refsection>
        <title>Description</title>
        <para>
            The <literal>Compound</literal> entity is a third of the graphics
            entities hierarchy. This entity defines interdependencies of the
            various graphics entities and their global visibility property.
        </para>
        <variablelist>
            <varlistentry>
                <term>parent: </term>
                <listitem>
                    <para>
                        This property contains the handle of the parent. The
                        parent of the text entity should be of the type <literal>"Axes"</literal> or
                        <literal>"Compound"</literal>.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>children: </term>
                <listitem>
                    <para>
                        A vector containing the handles of all graphics objects
                        children of the <literal>Compound</literal>. These
                        graphics objects can be of type
                        <literal>"Compound"</literal>, <literal>"Rectangle"</literal>,
                        <literal>"Polyline"</literal>, <literal>"Patch"</literal>, <literal>"Segs"</literal>,
                        <literal>"Arc"</literal>, <literal>"Grayplot"</literal>, ...
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>visible: </term>
                <listitem>
                    <para>
                        This field contains the <literal>visible</literal>
                        property value for the entity. It should be
                        <literal>"on"</literal> or <literal>"off"</literal>. By
                        default, value is <literal>"on"</literal> where graphics
                        entities children of the <literal>Compound</literal> are
                        drawn according to their visibility property. If
                        <literal>"off"</literal> all children of
                        <literal>Compound</literal> are not displayed on the
                        screen.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>user_data: </term>
                <listitem>
                    <para>
                        This field can be use to store any scilab variable in the
                        figure data structure, and to retrieve it.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection role="see also">
        <title>See also</title>
        <simplelist type="inline">
            <member>
                <link linkend="glue">glue</link>
            </member>
            <member>
                <link linkend="unglue">unglue</link>
            </member>
            <member>
                <link linkend="graphics_entities">graphics entities</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
