Update events.rst

user_manual/events.rst

@@ -1353,3 +1353,112 @@
       fire(event, 'my_repeater_code');
      /
     CHANGE_REPEATER_SEARCH_PARAMS = 'change_repeater_search_params',
+
+События для компонента "дерево"
+--------------
+
+Событие обновления дерева
+~~~~~~~~~~~~~~~~~ 
+
+.. code-block:: js
+
+      Пример вызова события:
+     
+      fire({
+          type: 'reload_tree'
+      }, 'my_tree_comp')
+     /
+    RELOAD_TREE = 'reload_tree',
+    
+Событие клика по элементу дерева
+~~~~~~~~~~~~~~~~~ 
+
+.. code-block:: js
+
+      Пример вызова события
+     
+      fire({
+          type: 'tree_item_click',
+          item: '311d1bd0-4f45-442c-ac5d-daac30352213' || {
+               id,
+               children,
+               filterData: {
+                   filterType,
+               },
+               hasChildren,
+               name,
+               ...
+           },
+           data: getCompByCode('my_tree_comp').data
+      }, 'my_tree_comp')
+     /
+    TREE_ITEM_CLICK = 'tree_item_click',
+
+Событие установки данных дерева (изменяет всю структуру)
+~~~~~~~~~~~~~~~~~ 
+
+.. code-block:: js
+
+      Пример вызова события
+     
+      const treeData = [{
+           id: 'myTreeItem',
+           name: 'Первый президент',
+           hasChildren: true,
+           children: [{
+               id: 'myTreeItem-child',
+               name: 'Дочка первого президента',
+               hasChildren: false,
+               children: [],
+               counters: undefined
+           }],
+           counters: {
+               total: 10,
+               new: 2
+           } || undefined
+      }]
+     
+      Если counters === undefined, то его можно не передавать в объекте
+     
+      fire({
+          type: 'set_tree_data',
+          data: treeData
+      }, 'my_tree_comp')
+     /
+    TREE_SET_DATA = 'tree_set_data',
+
+Событие для установки дочерних элементов элементам дерева (изменяет структуру только указанных элементов - parentId)
+~~~~~~~~~~~~~~~~~ 
+
+.. code-block:: js
+
+      Пример вызова события
+   
+    const childElements = [{
+     id: 'childElement',
+     name: 'Дочерний элемент',
+     hasChildren: false,
+     children: []
+      }]
+     
+      fire({
+          type: 'tree_set_children',
+          parentId: '311d1bd0-4f45-442c-ac5d-daac30352213',
+          data: childElements
+      }, 'my_tree_comp')
+     /
+    TREE_SET_CHILDREN = 'tree_set_children'
+
+Событие для установки массива ID открытых эелментов дерева
+~~~~~~~~~~~~~~~~~ 
+
+.. code-block:: js
+
+      Пример вызова события
+     
+      fire({
+          type: 'tree_set_expanded',
+          expanded: ['1', '2', '33']
+      })
+     /
+    TREE_SET_EXPANDED = 'tree_set_expanded'