eaaf8bf44d267e17f8a551265089b78e2db2dd0b
[scilab.git] / scilab / modules / data_structures / help / en_US / tree_show.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <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="tree_show">
3     <refnamediv>
4         <refname>tree_show</refname>
5         <refpurpose>Display a tree view of a list</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Syntax</title>
9         <synopsis>
10             tree_show(x)
11         </synopsis>
12     </refsynopsisdiv>
13     <refsection>
14         <title>Arguments</title>
15         <variablelist>
16             <varlistentry>
17                 <term>x</term>
18                 <listitem>
19                     <para>list or mlist or tlist to display.</para>
20                 </listitem>
21             </varlistentry>
22         </variablelist>
23     </refsection>
24     <refsection>
25         <title>Description</title>
26         <para>Creates a window and displays a tree view of the given list.</para>
27     </refsection>
28     <refsection>
29         <title>Examples</title>
30         <programlisting role="example"><![CDATA[
31 // Simple example
32 a=list(1,2,3);
33 tree_show(a);
34
35 // Another example with mlist
36 str=['a','b','c','d','e','f','g','h'];
37 n=matrix(str, [2,2,2]);
38 v=matrix(1:8, [2,2,2]);
39 Mm=mlist(['V','name','value'],n,v);
40 tree_show(Mm);
41
42 // Another example with tlist
43 Mt=tlist(['V','name','value'],['a','b','c'],[1 2 3]);
44 tree_show(Mt);
45  ]]></programlisting>
46     </refsection>
47 </refentry>