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         </refpurpose>
  25     </refnamediv>
  26     <refsynopsisdiv>
  27         <title>Синтаксис</title>
  28         <synopsis>
  29             tree_show(x)
  30             tree_show(x, rootTitle)
  31             tree_show(x, rootTitle, styles)
  32             tree_show(x, rootTitle, styles, arrayByFields)
  33         </synopsis>
  34     </refsynopsisdiv>
  35     <refsection>
  36         <title>Аргументы</title>
  37         <variablelist>
  38             <varlistentry>
  39                 <term>x</term>
  40                 <listitem>
  41                     <para>
  42                         Контейнер для отображения. Поддерживаемые контейнеры list, mlist, tlist,
  43                         cell-массивы или массивы структур. Другие контейнеры могут быть вложены
  44                         в <varname>x</varname>.
  45                     </para>
  46                 </listitem>
  47             </varlistentry>
  48             <varlistentry>
  49                 <term>rootTitle</term>
  50                 <listitem>
  51                     <para>
  52                         Отдельная строка: напрямую указанная метка корня дерева, например, имя
  53                         переменной <varname>x</varname> в вызываюжщем окружении. По умолчанию
  54                         <literal>""</literal>.
  55                     </para>
  56                     <note>
  57                         Для изменения стиля названия корня могут использоваться теги стилей
  58                         HTML.4.
  59                         Например: "<literal>&lt;html>&lt;font color="red">&lt;b>Название&lt;/b></literal>"
  60                         отобразит <emphasis>Название</emphasis> жирным красным шрифтом.
  61                     </note>
  62                 </listitem>
  63             </varlistentry>
  64             <varlistentry>
  65                 <term>styles</term>
  66                 <listitem>
  67                     <para>
  68                         Отдельная строка: тег стиля HTML.4, включающий символ
  69                         <literal>"$"</literal>, который будет заменяться адресом данных (имена
  70                         полей, индексы списков...).
  71                     </para>
  72                     <para>
  73                         Опция <varname>styles</varname> может исползоваться для настройки стилей
  74                         либо адресов, либо соответствующее содержимое или и то и другое. Примеры:
  75                         <itemizedlist>
  76                             <listitem>
  77                                 <literal>"&lt;b>$&lt;/b>"</literal> : адрес жирным, содержимое нормальным чёрным шрифтом.
  78                             </listitem>
  79                             <listitem>
  80                                 <literal>"$&lt;i>"</literal> : адрес нормальным, содержимое курсивным шрифтом.
  81                             </listitem>
  82                             <listitem>
  83                                 <literal>"&lt;i>$"</literal> : и адрес и содержимое курсивным шрифтом.
  84                             </listitem>
  85                             <listitem>
  86                                 <literal>"&lt;font color=''grey''>$&lt;/font>&lt;i>"</literal> :
  87                                 адрес серым, содержимое курсивным шрифтом.
  88                             </listitem>
  89                         </itemizedlist>
  90                     </para>
  91                     <para>
  92                         По умолчанию =
  93                         <literal>"&lt;font color=""blue"">$&lt;/font>"</literal>
  94                         (адрес синим, содержимое чёрным шрифтом).
  95                     </para>
  96                     <para>
  97                         Установка <literal>""</literal> удаляет стилевое оформление.
  98                     </para>
  99                 </listitem>
 100             </varlistentry>
 101             <varlistentry>
 102                 <term>arrayByFields</term>
 103                 <listitem>
 104                     <para>
 105                         Отдельное логическое значение, используемое только для массивов структур:
 106                         <table>
 107                             <tr><th>%T :</th>
 108                                 <td>
 109                                     Для каждого поля структуры отображается массив его значений.
 110                                 </td>
 111                             </tr>
 112                             <tr><th>%F :</th>
 113                                 <td>
 114                                     Для каждой структуры массива отображаются её поля и их значения.
 115                                 </td>
 116                             </tr>
 117                         </table>
 118                     </para>
 119                     <para>
 120                         Выбранный режим отображения используется также для каждого вложенного
 121                         массива структур на любой глубине.
 122                     </para>
 123                 </listitem>
 124             </varlistentry>
 125         </variablelist>
 126     </refsection>
 127     <refsection>
 128         <title>Описание</title>
 129         <para>
 130             Создаёт окно и отображает указанный контейнер в виде дерева.
 131         </para>
 132         <warning>
 133             Это окно не имеет дескриптора.
 134         </warning>
 135     </refsection>
 136     <refsection>
 137         <title>Примеры</title>
 138     <para>
 139     <emphasis role="bold">list(), включая cell-массив</emphasis> :
 140     </para>
 141     <table>
 142         <tr>
 143             <td>
 144                 <programlisting role="example"><![CDATA[
 145         films = struct("Title", "A.I. Artificial Intelligence",..
 146                        "Year", 2001, ..
 147                        "Director", "Steven Spielberg", ..
 148                        "Duration", 140);
 149         L = list([%t %f %f],                ..
 150                  $:-1:3,                    ..
 151                  int8([1 2 3 ; 4 5 6]),     ..
 152                  [-%inf, -1, 0, %i, 7.1, 3.3e20, %inf, %nan], ..
 153                  sparse([0 1 2; 3 0 4]),    ..
 154                  ["This" "is" "some" "text"], ..
 155                  ,              ..
 156                  sin,           ..
 157                  logspace,      ..
 158                  iolib,         ..
 159                  {%pi, "abcd" ;
 160                   list(,)(1),(%i-%s)^3},    ..
 161                   {},           ..
 162                  films);
 163         tree_show(L)
 164          ]]></programlisting>
 165             </td>
 166             <td>
 167                 <inlinemediaobject>
 168                     <imageobject>
 169                         <imagedata fileref="../images/tree_show_list.png"/>
 170                     </imageobject>
 171                 </inlinemediaobject>
 172             </td>
 173         </tr>
 174     </table>
 175
 176     <para>
 177     <emphasis role="bold">Использование опций <emphasis>rootTitle</emphasis> и <emphasis>styles</emphasis>
 178     </emphasis> :
 179     </para>
 180         <programlisting role="example"><![CDATA[
 181 // Данные для отображения:
 182 clear films
 183 films(1) = struct("Title", "A.I. Artificial Intelligence",..
 184                   "Year", 2001, ..
 185                   "Director", "Steven Spielberg", ..
 186                   "Duration", 140);
 187 films(2,2) = struct("Title", "I, robot", ..
 188                     "Year", 2004, ..
 189                     "Director", "Alex Proyas", ..
 190                     "Duration", 120);
 191
 192 // Стилевое оформление как адресов, так и содержимого:
 193 mainTitle = "<html><b>Films (A)</b>";
 194 tree_show(films, mainTitle , "<font color=""red"">$</font><i>");
 195
 196 // Стилевое оформление только содержимого:
 197 mainTitle = "<html><b>Films (B)</b>";
 198 tree_show(films([1 4]), mainTitle, "$<font color=""green"">", %t);
 199  ]]></programlisting>
 200     <para/>
 201     <inlinemediaobject>
 202         <imageobject>
 203             <imagedata fileref="../images/tree_show_styling.png"/>
 204         </imageobject>
 205     </inlinemediaobject>
 206
 207     <para>
 208     <emphasis role="bold">Массив структур</emphasis> :
 209     </para>
 210         <programlisting role="example"><![CDATA[
 211 clear films
 212 films(1) = struct("Title", "A.I. Artificial Intelligence",..
 213               "Year", 2001, ..
 214               "Director", "Steven Spielberg", ..
 215               "Duration", 140);
 216 films(2) = struct("Title", "I, robot", ..
 217               "Year", 2004, ..
 218               "Director", "Alex Proyas", ..
 219               "Duration", 120);
 220 films(1,2) = struct("Title", "Gravity", ..
 221                 "Year", 2013, ..
 222                 "Director", "Alfonso Cuarón", ..
 223                 "Duration", 100);
 224 films(2,2) = struct("Title", "2001: A space odyssey", ..
 225                 "Year", 1968, ..
 226                 "Director", "Stanley Kubrick", ..
 227                 "Duration", 141);
 228
 229 tree_show(films(:),"Films (I)");
 230 tree_show(films   ,"Films (II)");
 231 tree_show(films(:),"Films (III)", , %t);
 232 tree_show(films   ,"Films (IV)" , , %t);
 233  ]]></programlisting>
 234     <screen><![CDATA[
 235 2x2 struct array with fields:
 236    Title
 237    Director
 238    Year
 239    Duration
 240 ]]></screen>
 241     <inlinemediaobject>
 242         <imageobject>
 243             <imagedata fileref="../images/tree_show_2x2.png"/>
 244         </imageobject>
 245     </inlinemediaobject>
 246     <para/>
 247
 248     <para>
 249     <emphasis role="bold">С пользовательским tlist или mlist</emphasis> :
 250     </para>
 251         <programlisting role="example"><![CDATA[
 252 // Для mlist:
 253 str = ['a','b','c','d','e','f','g','h'];
 254 n = matrix(str, [2,2,2]);
 255 v = matrix(1:8, [2,2,2]);
 256 Mm = mlist(['V','name','value'],n,v);
 257 tree_show(Mm);
 258
 259 // Для tlist:
 260 Mt = tlist(['V','name','value'],['a','b','c'],[1 2 3]);
 261 tree_show(Mt);
 262  ]]></programlisting>
 263     <para/>
 264     </refsection>
 265
 266     <refsection role="see also">
 267         <title>Смотрите также</title>
 268         <simplelist type="inline">
 269             <member>
 270                 <link linkend="uiDisplayTree">uiDisplayTree</link>
 271             </member>
 272             <member>
 273                 <link linkend="uiDumpTree">uiDumpTree</link>
 274             </member>
 275             <member>
 276                 <link linkend="prettyprint">prettyprint</link>
 277             </member>
 278             <member>
 279                 <link linkend="editvar">editvar</link>
 280             </member>
 281             <member>
 282                 <link linkend="browsevar">browsevar</link>
 283             </member>
 284         </simplelist>
 285     </refsection>
 286
 287     <refsection role="history">
 288         <title>История</title>
 289         <revhistory>
 290             <revision>
 291                 <revnumber>6.1.0</revnumber>
 292                 <revdescription>
 293                     <itemizedlist>
 294                         <listitem>
 295                             Добавлены входные опции rootTitle, styles и arrayByFields.
 296                         </listitem>
 297                         <listitem>
 298                             Теперь поддерживаются входные контейнеры, включающие пустые элементы.
 299                         </listitem>
 300                     </itemizedlist>
 301                 </revdescription>
 302             </revision>
 303         </revhistory>
 304     </refsection>
 305 </refentry>