* Bug 16333: tree_show(xcos_block) crashed
[scilab.git] / scilab / modules / data_structures / help / ru_RU / tree_show.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2008 - INRIA
5  * Copyright (C) 2012 - 2016 - Scilab Enterprises
6  * Copyright (C) 2019 - Samuel GOUGEON
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
17           xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
18           xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
19           xml:lang="ru" xml:id="tree_show">
20     <refnamediv>
21         <refname>tree_show</refname>
22         <refpurpose>
23             Отображает в виде дерева содержимое list, tlist, mlist, cell-массивы или массивы структур,
24             Xcos diagram or block
25         </refpurpose>
26     </refnamediv>
27     <refsynopsisdiv>
28         <title>Синтаксис</title>
29         <synopsis>
30             tree_show(x)
31             tree_show(x, rootTitle)
32             tree_show(x, rootTitle, styles)
33             tree_show(x, rootTitle, styles, arrayByFields)
34         </synopsis>
35     </refsynopsisdiv>
36     <refsection>
37         <title>Аргументы</title>
38         <variablelist>
39             <varlistentry>
40                 <term>x</term>
41                 <listitem>
42                     <para>
43                         Контейнер для отображения. Поддерживаемые контейнеры list, mlist, tlist,
44                         cell-массивы или массивы структур, identifier of an Xcos diagram or block.
45                         Другие контейнеры могут быть вложены в <varname>x</varname>.
46                     </para>
47                 </listitem>
48             </varlistentry>
49             <varlistentry>
50                 <term>rootTitle</term>
51                 <listitem>
52                     <para>
53                         Отдельная строка: напрямую указанная метка корня дерева, например, имя
54                         переменной <varname>x</varname> в вызываюжщем окружении. По умолчанию
55                         <literal>""</literal>.
56                     </para>
57                     <note>
58                         Для изменения стиля названия корня могут использоваться теги стилей
59                         HTML.4.
60                         Например: "<literal>&lt;html>&lt;font color="red">&lt;b>Название&lt;/b></literal>"
61                         отобразит <emphasis>Название</emphasis> жирным красным шрифтом.
62                     </note>
63                 </listitem>
64             </varlistentry>
65             <varlistentry>
66                 <term>styles</term>
67                 <listitem>
68                     <para>
69                         Отдельная строка: тег стиля HTML.4, включающий символ
70                         <literal>"$"</literal>, который будет заменяться адресом данных (имена
71                         полей, индексы списков...).
72                     </para>
73                     <para>
74                         Опция <varname>styles</varname> может исползоваться для настройки стилей
75                         либо адресов, либо соответствующее содержимое или и то и другое. Примеры:
76                         <itemizedlist>
77                             <listitem>
78                                 <literal>"&lt;b>$&lt;/b>"</literal> : адрес жирным, содержимое нормальным чёрным шрифтом.
79                             </listitem>
80                             <listitem>
81                                 <literal>"$&lt;i>"</literal> : адрес нормальным, содержимое курсивным шрифтом.
82                             </listitem>
83                             <listitem>
84                                 <literal>"&lt;i>$"</literal> : и адрес и содержимое курсивным шрифтом.
85                             </listitem>
86                             <listitem>
87                                 <literal>"&lt;font color=''grey''>$&lt;/font>&lt;i>"</literal> :
88                                 адрес серым, содержимое курсивным шрифтом.
89                             </listitem>
90                         </itemizedlist>
91                     </para>
92                     <para>
93                         По умолчанию =
94                         <literal>"&lt;font color=""blue"">$&lt;/font>"</literal>
95                         (адрес синим, содержимое чёрным шрифтом).
96                     </para>
97                     <para>
98                         Установка <literal>""</literal> удаляет стилевое оформление.
99                     </para>
100                 </listitem>
101             </varlistentry>
102             <varlistentry>
103                 <term>arrayByFields</term>
104                 <listitem>
105                     <para>
106                         Отдельное логическое значение, используемое только для массивов структур:
107                         <table>
108                             <tr><th>%T :</th>
109                                 <td>
110                                     Для каждого поля структуры отображается массив его значений.
111                                 </td>
112                             </tr>
113                             <tr><th>%F :</th>
114                                 <td>
115                                     Для каждой структуры массива отображаются её поля и их значения.
116                                 </td>
117                             </tr>
118                         </table>
119                     </para>
120                     <para>
121                         Выбранный режим отображения используется также для каждого вложенного
122                         массива структур на любой глубине.
123                     </para>
124                 </listitem>
125             </varlistentry>
126         </variablelist>
127     </refsection>
128     <refsection>
129         <title>Описание</title>
130         <para>
131             Создаёт окно и отображает указанный контейнер в виде дерева.
132         </para>
133         <warning>
134             Это окно не имеет дескриптора.
135         </warning>
136     </refsection>
137     <refsection>
138         <title>Примеры</title>
139         <para>
140             <emphasis role="bold">list(), включая cell-массив</emphasis> :
141         </para>
142         <table>
143             <tr>
144                 <td>
145                     <programlisting role="example"><![CDATA[
146 films = struct("Title", "A.I. Artificial Intelligence",..
147                "Year", 2001, ..
148                "Director", "Steven Spielberg", ..
149                "Duration", 140);
150 L = list([%t %f %f],                ..
151          $:-1:3,                    ..
152          int8([1 2 3 ; 4 5 6]),     ..
153          [-%inf, -1, 0, %i, 7.1, 3.3e20, %inf, %nan], ..
154          sparse([0 1 2; 3 0 4]),    ..
155          ["This" "is" "some" "text"], ..
156          ,              ..
157          sin,           ..
158          logspace,      ..
159          iolib,         ..
160          {%pi, "abcd" ;
161           list(,)(1),(%i-%s)^3},    ..
162           {},           ..
163          films);
164 tree_show(L)
165              ]]></programlisting>
166                 </td>
167                 <td>
168                     <inlinemediaobject>
169                         <imageobject>
170                             <imagedata fileref="../images/tree_show_list.png"/>
171                         </imageobject>
172                     </inlinemediaobject>
173                 </td>
174             </tr>
175         </table>
176
177         <para>
178             <emphasis role="bold">
179                 Использование опций <emphasis>rootTitle</emphasis> и <emphasis>styles</emphasis>
180             </emphasis> :
181         </para>
182         <programlisting role="example"><![CDATA[
183 // Данные для отображения:
184 clear films
185 films(1) = struct("Title", "A.I. Artificial Intelligence",..
186                   "Year", 2001, ..
187                   "Director", "Steven Spielberg", ..
188                   "Duration", 140);
189 films(2,2) = struct("Title", "I, robot", ..
190                     "Year", 2004, ..
191                     "Director", "Alex Proyas", ..
192                     "Duration", 120);
193
194 // Стилевое оформление как адресов, так и содержимого:
195 mainTitle = "<html><b>Films (A)</b>";
196 tree_show(films, mainTitle , "<font color=""red"">$</font><i>");
197
198 // Стилевое оформление только содержимого:
199 mainTitle = "<html><b>Films (B)</b>";
200 tree_show(films([1 4]), mainTitle, "$<font color=""green"">", %t);
201      ]]></programlisting>
202         <para/>
203         <inlinemediaobject>
204             <imageobject>
205                 <imagedata fileref="../images/tree_show_styling.png"/>
206             </imageobject>
207         </inlinemediaobject>
208
209         <para>
210             <emphasis role="bold">Массив структур</emphasis> :
211         </para>
212         <programlisting role="example"><![CDATA[
213 clear films
214 films(1) = struct("Title", "A.I. Artificial Intelligence",..
215               "Year", 2001, ..
216               "Director", "Steven Spielberg", ..
217               "Duration", 140);
218 films(2) = struct("Title", "I, robot", ..
219               "Year", 2004, ..
220               "Director", "Alex Proyas", ..
221               "Duration", 120);
222 films(1,2) = struct("Title", "Gravity", ..
223                 "Year", 2013, ..
224                 "Director", "Alfonso Cuarón", ..
225                 "Duration", 100);
226 films(2,2) = struct("Title", "2001: A space odyssey", ..
227                 "Year", 1968, ..
228                 "Director", "Stanley Kubrick", ..
229                 "Duration", 141);
230
231 tree_show(films(:),"Films (I)");
232 tree_show(films   ,"Films (II)");
233 tree_show(films(:),"Films (III)", , %t);
234 tree_show(films   ,"Films (IV)" , , %t);
235      ]]></programlisting>
236         <screen><![CDATA[
237 2x2 struct array with fields:
238    Title
239    Director
240    Year
241    Duration
242     ]]></screen>
243         <inlinemediaobject>
244             <imageobject>
245                 <imagedata fileref="../images/tree_show_2x2.png"/>
246             </imageobject>
247         </inlinemediaobject>
248         <para/>
249         <para>
250             <emphasis role="bold">С пользовательским tlist или mlist</emphasis> :
251         </para>
252         <programlisting role="example"><![CDATA[
253 // Для mlist:
254 str = ['a','b','c','d','e','f','g','h'];
255 n = matrix(str, [2,2,2]);
256 v = matrix(1:8, [2,2,2]);
257 Mm = mlist(['V','name','value'],n,v);
258 tree_show(Mm);
259
260 // Для tlist:
261 Mt = tlist(['V','name','value'],['a','b','c'],[1 2 3]);
262 tree_show(Mt);
263      ]]></programlisting>
264         <para/>
265         <para>
266             <emphasis role="bold">For an Xcos diagram or block</emphasis> :
267         </para>
268         <programlisting role="example"><![CDATA[
269 loadXcosLibs();
270
271 filename = SCI+"/modules/xcos/demos/demo_Datatype.xmi";
272 xcosDiag = scicosDiagramToScilab(filename);
273 tree_show(xcosDiag)
274
275 blk = BIGSOM_f("define");
276 tree_show(blk)
277          ]]></programlisting>
278     </refsection>
279
280     <refsection role="see also">
281         <title>Смотрите также</title>
282         <simplelist type="inline">
283             <member>
284                 <link linkend="uiDisplayTree">uiDisplayTree</link>
285             </member>
286             <member>
287                 <link linkend="uiDumpTree">uiDumpTree</link>
288             </member>
289             <member>
290                 <link linkend="prettyprint">prettyprint</link>
291             </member>
292             <member>
293                 <link linkend="editvar">editvar</link>
294             </member>
295             <member>
296                 <link linkend="browsevar">browsevar</link>
297             </member>
298         </simplelist>
299     </refsection>
300
301     <refsection role="history">
302         <title>История</title>
303         <revhistory>
304             <revision>
305                 <revnumber>6.1.0</revnumber>
306                 <revdescription>
307                     <itemizedlist>
308                         <listitem>
309                             Добавлены входные опции rootTitle, styles и arrayByFields.
310                         </listitem>
311                         <listitem>
312                             Теперь поддерживаются входные контейнеры, включающие пустые элементы.
313                         </listitem>
314                     </itemizedlist>
315                 </revdescription>
316             </revision>
317         </revhistory>
318     </refsection>
319 </refentry>