Skip to content

S
sd-doc
Commit 3a09d2da authored by Valentin Skripnikov's avatar Valentin Skripnikov
Browse files
Options

-

parent fd88d4a9
Show whitespace changes
Inline Side-by-side
Showing with 125 additions and 107 deletions
docs/conf.py
View file @ 3a09d2da
......@@ -25,7 +25,7 @@ import os
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# Add any Sphinx extension module names here, as Strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = []
......
docs/forms/cmp/base.rst
View file @ 3a09d2da
......@@ -119,7 +119,7 @@
Вставить новое значение и отправить уведомление всем подписанным объектам, в т.ч. отображению
:param string newValue: Значение компонента
:param String newValue: Значение компонента
.. js:function:: getErrors()
......@@ -145,23 +145,23 @@
Получение локали, настроенной в компоненте
:returns: ``string`` Локаль пользователя
:returns: ``String`` Локаль пользователя
.. js:function:: getHTMLValue()
:returns: ``string`` HTML-представлениe текстового значения поля со стилями
:returns: ``String`` HTML-представлениe текстового значения поля со стилями
.. js:function:: getValue()
:returns: ``string`` значение компонента
:returns: ``String`` значение компонента
.. js:function:: getTextValue()
:returns: ``string`` текстовое значение компонента
:returns: ``String`` текстовое значение компонента
.. js:function:: getAsfData([blockNumber])
:param number blockNumber: Номер строки динамической таблицы (если это компонент статической таблицы, то передавать эту переменную не нужно)
:param Number blockNumber: Номер строки динамической таблицы (если это компонент статической таблицы, то передавать эту переменную не нужно)
:returns: ``asfData`` Данные компонента
.. js:function:: setAsfData(asfData)
......
docs/forms/cmp/check.rst
View file @ 3a09d2da
......@@ -90,19 +90,19 @@
Получить наименования выбранных элементов
:returns: ``string`` наименования выбранных элементов, разделенных запятой
:returns: ``String`` наименования выбранных элементов, разделенных запятой
.. js:function:: getTextValues()
Получить наименования выбранных элементов
:returns: ``[string]`` наименования выбранных элементов
:returns: ``[String]`` наименования выбранных элементов
.. js:function:: getValue()
Получить значения выбранных элементов
:returns: ``[string]`` значения выбранных элементов
:returns: ``[String]`` значения выбранных элементов
.. js:function:: doSetValue(newValue)
......
docs/forms/cmp/date.rst
View file @ 3a09d2da
......@@ -52,10 +52,10 @@
Получить значение компонента
:returns: ``string`` дата в формате «yyyy-MM-dd HH:mm:ss»
:returns: ``String`` дата в формате «yyyy-MM-dd HH:mm:ss»
.. js:function:: setValue(newValue)
Вставить значение
:param string newValue: значение даты в формате «yyyy-MM-dd HH:mm:ss»
:param String newValue: значение даты в формате «yyyy-MM-dd HH:mm:ss»
docs/forms/cmp/entity.rst
View file @ 3a09d2da
......@@ -63,7 +63,7 @@
Получить идентификаторы выбранных пользователей
:returns: ``[string]``
:returns: ``[String]``
.. js:function:: getValue()
......@@ -149,7 +149,7 @@
Получить идентификаторы выбранных должностей
:returns: ``[string]``
:returns: ``[String]``
.. js:function:: getValue()
......@@ -231,7 +231,7 @@
Получить идентификаторы выбранных подразделений
:returns: ``[string]``
:returns: ``[String]``
.. js:function:: getValue()
......
docs/forms/cmp/link.rst
View file @ 3a09d2da
......@@ -55,6 +55,6 @@
Вставить значение
:param string newUrl: URL ссылки
:param string newTitle: наименование ссылки
:param String newUrl: URL ссылки
:param String newTitle: наименование ссылки
:param boolean newOpenInNew: открывать ссылку в новом окне
docs/forms/cmp/listbox.rst
View file @ 3a09d2da
......@@ -104,19 +104,19 @@
Получить наименования выбранных элементов
:returns: ``string`` наименования выбранных элементов, разделенных запятой
:returns: ``String`` наименования выбранных элементов, разделенных запятой
.. js:function:: getTextValues()
Получить наименования выбранных элементов
:returns: ``[string]`` наименования выбранных элементов
:returns: ``[String]`` наименования выбранных элементов
.. js:function:: getValue()
Получить значения выбранных элементов
:returns: ``[string]`` значения выбранных элементов
:returns: ``[String]`` значения выбранных элементов
.. js:function:: doSetValue(newValue)
......
docs/forms/cmp/personlink.rst
View file @ 3a09d2da
......@@ -37,13 +37,13 @@
Получить идентификатор выбранного контакта в адресной книге
:returns: ``string`` идентификатор контакта в адресной книге
:returns: ``String`` идентификатор контакта в адресной книге
.. js:function:: setValue(newValue)
Задать значение
:param string newValue: идентификатор контакта в адресной книге
:param String newValue: идентификатор контакта в адресной книге
.. js:function:: setValueFromInput(newValue)
......
docs/forms/cmp/projectlink.rst
View file @ 3a09d2da
......@@ -41,13 +41,13 @@
Получить идентификатор выбранного проекта или портфеля
:returns: ``string`` идентификатор проекта/портфеля
:returns: ``String`` идентификатор проекта/портфеля
.. js:function:: setValue(newValue)
Задать значение
:param string newValue: идентификатор проекта/портфеля, либо null
:param String newValue: идентификатор проекта/портфеля, либо null
.. js:function:: setValueFromInput(newValue)
......
docs/forms/cmp/radio.rst
View file @ 3a09d2da
......@@ -90,19 +90,19 @@
Получить наименования выбранных элементов
:returns: ``string`` наименования выбранных элементов, разделенных запятой
:returns: ``String`` наименования выбранных элементов, разделенных запятой
.. js:function:: getTextValues()
Получить наименования выбранных элементов
:returns: ``[string]`` наименования выбранных элементов
:returns: ``[String]`` наименования выбранных элементов
.. js:function:: getValue()
Получить значения выбранных элементов
:returns: ``[string]`` значения выбранных элементов
:returns: ``[String]`` значения выбранных элементов
.. js:function:: doSetValue(newValue)
......
docs/forms/cmp/reglink.rst
View file @ 3a09d2da
......@@ -45,16 +45,16 @@
Получить идентификатор реестра на который ссылается компонент
:returns: ``string`` идентификатор реестра
:returns: ``String`` идентификатор реестра
.. js:function:: getValue()
Получить идентификатор выбранного документа реестра
:returns: ``string`` идентификатор документа реестра
:returns: ``String`` идентификатор документа реестра
.. js:function:: setValue(newValue)
Задать значение
:param string newValue: идентификатор документа реестра
:param String newValue: идентификатор документа реестра
docs/forms/cmp/repeater.rst
View file @ 3a09d2da
......@@ -65,23 +65,23 @@
Получить текстовую расшифровку выбранного типа
:returns: ``string``
:returns: ``String``
.. js:function:: getValue()
Получить значение компонента
:returns: ``[string]`` массив элементов согласно типу, например [«1.10», «31.12»]
:returns: ``[String]`` массив элементов согласно типу, например [«1.10», «31.12»]
.. js:function:: setValue(newValue)
Задать значение
:param string newValue: cтрока вида: ``4|1.4;11.5;12.7;30.9``
:param String newValue: cтрока вида: ``4|1.4;11.5;12.7;30.9``
.. js:function:: setValueFromInput(newType, newValues)
Задать значение
:param number newType: тип периода
:param Number newType: тип периода
:param array newValues: массив строк согласно типу, например [«4.1», «5.11», «7.12», «9.30»]
docs/forms/cmp/table.rst
View file @ 3a09d2da
......@@ -31,7 +31,7 @@
Делает столбец таблицы видимым / невидимым
:param number columnNumber: номер столбца
:param Number columnNumber: номер столбца
:param boolean visible: видимый
.. js:function:: getInvisibleColumns()
......@@ -44,9 +44,9 @@
таблице и указанном блоке, если идентификатор таблицы не указан, то ищется
модель компонента на странице или в статических таблицах
:param string cmpId: идентификатор компонента
:param string tableId: идентификатор динамической таблицы
:param number tableBlockIndex: номер строки динамической таблицы
:param String cmpId: идентификатор компонента
:param String tableId: идентификатор динамической таблицы
:param Number tableBlockIndex: номер строки динамической таблицы
:returns: ``object`` отображение компонента
.. js:class:: AS.FORMS.TableDynamicView
......@@ -83,7 +83,7 @@
Сделать столбец таблицы видимым
:param number column: номер столбца таблицы
:param Number column: номер столбца таблицы
:param boolean visible: является видимым
.. js:function:: getViewWithId(cmpId[, tableId[, tableBlockIndex]])
......@@ -92,26 +92,26 @@
в указанной таблице и указанном блоке, если идентификатор таблицы не указан,
то ищется модель компонента на странице или в статических таблицах
:param string cmpId: идентификатор компонента
:param string tableId: идентификатор динамической таблицы
:param number tableBlockIndex: номер строки динамической таблицы
:param String cmpId: идентификатор компонента
:param String tableId: идентификатор динамической таблицы
:param Number tableBlockIndex: номер строки динамической таблицы
:returns: ``object`` отображение компонента
.. js:function:: mergeCell(row, column, rows, cols)
Объединить ячейки в блоке
:param number row: номер ряда таблицы
:param number column: номер столбца таблицы
:param number rows: количество рядов для объединения
:param number cols: количество столбцов для объединения
:param Number row: номер ряда таблицы
:param Number column: номер столбца таблицы
:param Number rows: количество рядов для объединения
:param Number cols: количество столбцов для объединения
.. js:function:: splitCell(row, column)
Разъединить ячейки
:param number row: номер ряда таблицы
:param number column: номер столбца таблицы
:param Number row: номер ряда таблицы
:param Number column: номер столбца таблицы
.. js:class:: AS.FORMS.TableParagraphView
......@@ -170,7 +170,7 @@
Удаляет блок таблицы
:param number blockNumber: номер блока
:param Number blockNumber: номер блока
.. js:function:: getTextValue()
......
docs/forms/logger.rst
View file @ 3a09d2da
......@@ -9,7 +9,7 @@
Вывести сообщение в консоль браузера
:param string message: сообщение
:param String message: сообщение
.. js:function:: logError(error)
......@@ -22,5 +22,5 @@
Вывести ошибку в серверный лог Synergy
:param Error error: ошибка исполнения
:param string formId: идентификатор формы
:param string asfDataId: идентификатор данных формы
:param String formId: идентификатор формы
:param String asfDataId: идентификатор данных формы
docs/forms/player.rst
View file @ 3a09d2da
......@@ -5,9 +5,7 @@
.. js:data:: bus
Шина событий.
Генерируемые события:
Шина событий. Генерируемые события:
.. js:function:: formShow(event, playerModel, playerView)
......@@ -15,9 +13,9 @@
:param Object event: возникшее событие
:param Object playerModel: модель проигрывателя
:param string playerView: отображение проигрывателя
:param String playerView: отображение проигрывателя
.. js:function:: formShow(event, playerModel)
.. js:function:: formDestroy(event, playerModel)
Callback события уничтожения формы
......@@ -30,7 +28,7 @@
:param Object event: возникшее событие
:param Object model: модель компонента в котором изменилось значение
:param string value: новое значение компонента
:param String value: новое значение компонента
.. js:function:: createPlayer()
......@@ -58,17 +56,17 @@
Отобразить форму по ее коду, без создания соответствующего экземпляра asfData
:param string formCode: Код формы.
:param number version: Версия формы.
:param String formCode: Код формы.
:param Number version: Версия формы.
.. js:function:: showFormData(formUUID[, version[, dataUUID[, dataVersion]]])
Отобразить форму по идентификатору
:param string formUUID: Идентификатор формы.
:param number version: Номер версии формы.
:param string dataUUID: Идентификатор данных формы.
:param number dataVersion: Номер версии данных формы.
:param String formUUID: Идентификатор формы.
:param Number version: Номер версии формы.
:param String dataUUID: Идентификатор данных формы.
:param Number dataVersion: Номер версии данных формы.
.. js:function:: saveFormData(callback)
......@@ -81,8 +79,8 @@
Построение формы согласно definition и заполнение asfData значением параметра data.
Вспомогательный метод, вызывающийся при выполнении методов :js:func:`showFormData` и :js:func:`showFormByCode`.
:param string definition: Описание формы в формате JSON.
:param string data: Данные формы в форме JSON.
:param String definition: Описание формы в формате JSON.
:param String data: Данные формы в форме JSON.
.. js:function:: destroy()
......@@ -114,9 +112,9 @@
Получить отображение компонента по его идентификатору
:param string cmpId: идентификатор компонента
:param string tableId: идентификатор динамической таблицы
:param number blockNumber: номер строки динамической таблицы
:param String cmpId: идентификатор компонента
:param String tableId: идентификатор динамической таблицы
:param Number blockNumber: номер строки динамической таблицы
:returns: :js:class:`AS.FORMS.View`
.. js:function:: setEditable(editable)
......@@ -129,6 +127,26 @@
Модель проигрывателя
.. js:data:: bus
Шина событий. Генерируемые события:
.. js:function:: dataLoad(event, playerModel, value)
Callback события загрузки данных формы
:param Object event: возникшее событие
:param Object playerModel: модель проигрывателя
:param Object value: данные формы
.. js:function:: valueChange(event, model, value)
Callback события изменения данных формы/компонента
:param Object event: возникшее событие
:param Object model: модель компонента в котором изменилось значение
:param Object value: новое значение компонента
.. js:data:: models
Массив моделей страниц :js:class:`AS.FORMS.TableModel`
......@@ -177,7 +195,7 @@
Получить модель компонента по его идентификатору
:param string cmpId: идентификатор компонента
:param string tableId: идентификатор динамической таблицы
:param number blockNumber: номер строки динамической таблицы
:param String cmpId: идентификатор компонента
:param String tableId: идентификатор динамической таблицы
:param Number blockNumber: номер строки динамической таблицы
:returns: :js:class:`AS.FORMS.Model`
docs/forms/services.rst
View file @ 3a09d2da
......@@ -31,11 +31,11 @@
:param Object values: список выбранных элементов
:param boolean multiSelectable: позволять множественный выбор
:param string filterUserID: идентификатор пользователя для фильтрации элементов
:param string filterPositionID: идентификатор должности для фильтрации элементов
:param string filterDepartmentID: идентификатор подразделения для фильтрации элементов
:param string filterChildDepartmentID: идентификатор дочернего подразделения для фильтрации элементов
:param string locale: локаль диалога
:param String filterUserID: идентификатор пользователя для фильтрации элементов
:param String filterPositionID: идентификатор должности для фильтрации элементов
:param String filterDepartmentID: идентификатор подразделения для фильтрации элементов
:param String filterChildDepartmentID: идентификатор дочернего подразделения для фильтрации элементов
:param String locale: локаль диалога
:param Function handler: функция, которая будет вызвана после выбора значения
.. js:function:: showDropDown(values, anchor, minWidth, callback)
......@@ -44,9 +44,9 @@
:param Object values: массив элементов списка вида ``[{value : "value1", title : "title1", selected : true}, {value : "value2", title : "title2"}]``
:param HTMLElement anchor: якорный компонент, к которому следует привязать всплывающее окно
:param number minWidth: минимальная ширина всплывающего окна
:param Number minWidth: минимальная ширина всплывающего окна
:param Function callback: функция, которая будет вызвана после выбора элемента. В функцию будет
передан один параметр - значение выбранного элемента, тип ``string``
передан один параметр - значение выбранного элемента, тип ``String``
:ref:`widgets-examples-dropdown`
......@@ -56,10 +56,10 @@
:param Object values: список выбранных элементов
:param boolean multiSelect: позволять множественный выбор
:param string filterUserId: идентификатор пользователя для фильтрации элементов
:param string filterDepartmentId: идентификатор подразделения для фильтрации элементов
:param String filterUserId: идентификатор пользователя для фильтрации элементов
:param String filterDepartmentId: идентификатор подразделения для фильтрации элементов
:param boolean showVacant: отобразить только вакантные должности
:param string locale: локаль диалога
:param String locale: локаль диалога
:param Function handler: функция, которая будет вызвана после выбора значения
.. js:function:: showProjectLinkDialog(handler)
......@@ -83,9 +83,9 @@
:param boolean multiSelectable: позволять множественный выбор
:param boolean isGroupSelectable: позволять выбирать группы
:param boolean showWithoutPosition: отобразить не назначенных на должность
:param string filterPositionID: идентификатор должности для фильтрации элементов
:param string filterDepartmentID: идентификатор подразделения для фильтрации элементов
:param string locale: локаль диалога
:param String filterPositionID: идентификатор должности для фильтрации элементов
:param String filterDepartmentID: идентификатор подразделения для фильтрации элементов
:param String locale: локаль диалога
:param Function handler: функция, которая будет вызвана после выбора значения
.. js:function:: showWaitWindow()
......
docs/forms/utils.rst
View file @ 3a09d2da
......@@ -17,11 +17,11 @@ AS.FORMS.ApiUtils
Выполнить GET запрос по указанному URL REST API.
:param string urlPart: Часть URL метода REST API, без ``http://host:port/Synergy/``,
:param String urlPart: Часть URL метода REST API, без ``http://host:port/Synergy/``,
например ``rest/api/registry/create_doc?registryCode=someregistry``
:param function callback: Функция, которая будет вызвана в случае успешного выполнения запроса.
В данную функцию передается один параметр - ответ на запрос.
:param string dataType: ``default:'json'`` Тип данных ответа на запрос.
:param String dataType: ``default:'json'`` Тип данных ответа на запрос.
Может принимать значения: ``"xml"``, ``"html"``, ``"script"``, ``"json"``, ``"jsonp"``, ``"text"``.
Если не передавать параметр, то будет использоваться дефолтное значение ``"json"``.
:param object data: Данные запроса. Могут быть строкой, объектом или массивом.
......@@ -32,14 +32,14 @@ AS.FORMS.ApiUtils
Выполнить POST запрос по указанному URL REST API.
:param string urlPart: Часть URL метода REST API, без ``http://host:port/Synergy/``,
:param String urlPart: Часть URL метода REST API, без ``http://host:port/Synergy/``,
например ``rest/api/asforms/data/save``
:param function callback: Функция, которая будет вызвана в случае успешного выполнения запроса.
В данную функцию передается один параметр - ответ на запрос.
:param string dataType: ``default:'json'`` Тип данных ответа на запрос.
:param String dataType: ``default:'json'`` Тип данных ответа на запрос.
Может принимать значения: ``"xml"``, ``"html"``, ``"script"``, ``"json"``, ``"jsonp"``, ``"text"``.
:param object data: Данные запроса. Должны соответствовать параметру ``contentType``
:param string contentType: ``default:'application/x-www-form-urlencoded; charset=UTF-8'`` Тип данных запроса.
:param String contentType: ``default:'application/x-www-form-urlencoded; charset=UTF-8'`` Тип данных запроса.
:param function errorHandler: Функция, которая будет вызвана в случае неуспешного выполнения запроса.
AS.FORMS.ASFDataUtils
......@@ -55,9 +55,9 @@ AS.FORMS.ASFDataUtils
можно добавить к нему собственные свойства.
:param object asfProperty: Определение компонента :js:data:`.asfProperty`
:param number blockNumber: Номер строки динамической таблицы
:param string value: Значение компонента
:param string key: Ключ компонента
:param Number blockNumber: Номер строки динамической таблицы
:param String value: Значение компонента
:param String key: Ключ компонента
:returns: ``object``
.. code-block:: js
......@@ -74,7 +74,7 @@ AS.FORMS.ASFDataUtils
Получить локаль компонента. Если локаль в компоненте не задана, то вернется системная локаль.
:param object asfProperty: Определение компонента :js:data:`.asfProperty`
:returns: ``string`` Локаль компонента
:returns: ``String`` Локаль компонента
.. js:function:: isReadOnly(model)
......@@ -126,7 +126,7 @@ AS.FORMS.DateUtils
Привести дату к указанному формату
:param Date date: Дата, которую надо привести к формату
:param string format: Форматная строка. Поддерживаются следующие подстановки:
:param String format: Форматная строка. Поддерживаются следующие подстановки:
* ``${yyyy}``, ``${yy}`` - год (число)
* ``${mm}``, ``${m}`` - месяц (число)
......@@ -146,46 +146,46 @@ AS.FORMS.DateUtils
-> AS.FORMS.DateUtils.formatDate(new Date(), '${dd}.${mm}.${yyyy}');
<- "31.10.2017"
:returns: ``string`` Значение даты согласно формату
:returns: ``String`` Значение даты согласно формату
.. js:function:: getMonthName(monthNumber)
Получить строковое значение месяца по его номеру
:param number monthNumber: порядковый номер месяца 1-12
:returns: ``string`` наименование месяца
:param Number monthNumber: порядковый номер месяца 1-12
:returns: ``String`` наименование месяца
.. js:function:: getMonthPossessiveName(monthNumber)
Получить строковое значение месяца в родительном падеже по его номеру
:param number monthNumber: порядковый номер месяца 1-12
:returns: ``string`` наименование месяца в родительном падеже
:param Number monthNumber: порядковый номер месяца 1-12
:returns: ``String`` наименование месяца в родительном падеже
.. js:function:: getMonthShortName(monthNumber)
Получить строковое сокращенное значение месяца по его номеру
:param number monthNumber: порядковый номер месяца 1-12
:returns: ``string`` сокращенное наименование месяца
:param Number monthNumber: порядковый номер месяца 1-12
:returns: ``String`` сокращенное наименование месяца
.. js:function:: getWeekDayName(dayNumber)
Получить наименование дня недели по его номеру
:param number dayNumber: порядковый номер дня недели 1-7
:returns: ``string`` наименование дня недели
:param Number dayNumber: порядковый номер дня недели 1-7
:returns: ``String`` наименование дня недели
.. js:function:: getWeekDayShortName(dayNumber)
Получить сокращенное наименование дня недели по его номеру
:param number dayNumber: порядковый номер дня недели 1-7
:returns: ``string`` сокращенное наименование дня недели
:param Number dayNumber: порядковый номер дня недели 1-7
:returns: ``String`` сокращенное наименование дня недели
.. js:function:: parseDate(dateStr)
Получить дату по его строковому представлению
:param string dateStr: Дата в формате ``yyyy-MM-dd HH:mm``
:param String dateStr: Дата в формате ``yyyy-MM-dd HH:mm``
:returns: ``Date`` Объект даты
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment