-

docs/interpreter/api.rst

@@ -10,6 +10,18 @@
     Предоставляет доступ к некоторым функциям платформы.
     Список функций см. ниже.
 
+    .. js:function:: getFormsManager()
+
+        Получить объект доступа к данным формы
+
+        :returns: :js:class:`FormsManager`
+
+    .. js:function:: getCardsManager()
+
+        Получить объект доступа к личным карточкам пользователей
+
+        :returns: :js:class:`CardsManager`
+
 .. js:data:: dataUUID
 
     Идентификатор данных формы, по которым запущен процесс
@@ -50,47 +62,95 @@
           Загружаем данные формы путем обращения к объектам
           :js:data:`platform` и :js:data:`dataUUID`
 
-#### Платформа {#interpreter.objects.platform}
 
-Назначение: Отвечает за создание экземпляров других объектов.
-Класс: `kz.arta.ext.interpreter.platform.Platform`.
+.. js:class:: FormsManager
+
+    Объект доступа к данным формы
+
+    .. js:function:: getFormData(dataUUID)
+
+        Получить данные формы
+
+        :param String dataUUID: идентификатор данных формы
+        :returns:               :js:class:`FormData`
+
+.. js:class:: CardsManager
+
+    Объект доступа к личным карточкам пользователей
+
+    .. js:function:: getUserCard(formID, userID)
+
+        Получить личную карточку пользователя
+
+        :param String formID:   идентификатор формы
+        :param String userID:   идентификатор пользователя
+        :returns:               :js:class:`FormData`
+
+.. js:class:: FormData
+
+    Объект данных формы
+
+    .. js:function:: getValue(component_id)
+
+        Получить значение компонента
+
+        :param String component_id:   идентификатор компонента
+        :returns:                     ``String``
+
+    .. js:function:: getValue(table_id, component_id, row_number)
+
+        Получить значение компонента
+
+        :param String table_id:       идентификатор дин. таблицы
+        :param String component_id:   идентификатор компонента
+        :param String row_number:     номер строки дин. таблицы (начинается с нуля)
+        :returns:                     ``String``
+
+    .. js:function:: getNumericValue(component_id)
+
+        Получить числовое значение компонента
+
+        :param String component_id:   идентификатор компонента
+        :returns:                     ``Number`` если значение компонента не
+                                      приводится к числу - возвращает NaN
+
+    .. js:function:: getNumericValue(table_id, component_id, row_number)
+
+        Получить числовое значение компонента
 
-Методы:
+        :param String table_id:       идентификатор дин. таблицы
+        :param String component_id:   идентификатор компонента
+        :param Number row_number:     номер строки дин. таблицы (начинается с нуля)
+        :returns:                     ``Number`` если значение компонента не
+                                      приводится к числу - возвращает NaN
 
-*   `getFormsManager()` возвращает «Менеджер данных по формам»;
-*   `getCardsManager()` возвращает «Менеджер личных карточек».
+    .. js:function:: getRowsCount(table_id)
 
-#### Менеджер данных по формам {#interpreter.objects.forms_manager}
+        Получить количество строк в динамической таблице
 
-Назначение: Поиск и получение данных по формам.
-Класс: `kz.arta.ext.interpreter.forms.search.FormsManager`.
+        :param String table_id:       идентификатор дин. таблицы
+        :returns:                     ``Number``
 
-Методы:
+    .. js:function:: load()
 
-*   `getFormData(идентификатор_данных)` возвращает объект
-    FormData.
+        Получить данные формы
 
-#### Менеджер личных карточек {#interpreter.objects.cards_manager}
+    .. js:function:: save()
 
-Назначение: Поиск и получение личных карточек пользователей.
-Класс: `kz.arta.ext.interpreter.forms.cards.CardsManager`.
+        Сохранить данные формы
 
-Методы:
+    .. js:function:: setValue(component_id, value)
 
-*   `getUserCard(идентификатор_формы, идентификатор_пользователя)`
+        Задать значение компонента
 
-#### Файл по форме {#interpreter.objects.form_data}
+        :param String component_id:   идентификатор компонента
+        :param String value:          значение компонента
 
-Назначение: Подгрузка и сохранение данных по форме.
-Класс: `kz.arta.ext.interpreter.forms.data.FormData`.
+    .. js:function:: setValue(table_id, component_id, row_number, value)
 
-Методы:
+        Задать значение компонента в динамической таблице
 
-*   `getValue(code)`
-*   `setValue(code, value)`
-*   `load()`
-*   `save()`
-*   `getRowsCount("id_таблицы")`
-*   `getValue("id_таблицы", "id_компонента", номер_строки)`
-*   `setValue("id_таблицы", "id_компонента", номер_строки,
-    значение)`
+        :param String table_id:       идентификатор дин. таблицы
+        :param String component_id:   идентификатор компонента
+        :param Number row_number:     номер строки дин. таблицы (начинается с нуля)
+        :param String value:          значение компонента