Список версий МТ

Главная

api.utils

Утилитарные функции и свойства

Properties:
Name Type Description
constants function Получение значений констант
convertExtraAttributeValue function Конвертация значений дополнительных атрибутов
documentLink function Создание ссылки на открытие документа
documentNames function Получение списка имен документов
extraAttributesFunctions function Получение данных для работы с дополнительными атрибутами
references function Получение наименований из базы данных
tableNames Object Имена таблиц в базе данных

Methods

api.utils.constants(codeKey) → String
api.utils.convertExtraAttributeValue(extraAttribute) → String
api.utils.documentLink(id) → String
api.utils.documentNames() → Object
api.utils.references(id, method) → String|Null

Members

emptyValue :String|Number

Значение, подставляемое вместо пустого, по-умолчанию " — "

extraAttributesFunctions :Object

Ассоциативный массив с функциями получения дополнительных атрибутов для заголовочных и строчных частей документа. Ключами выступают типы документов (documentType или из С++ класса Document). Вложенные объекты имеют два метода: "head" (получение доп. атрибутов заголовочной части) и "rows" (доп. атрибуты строчной части), а также свойство "objectType", содержащее типы объектов для заголовка ("head") и строк ("rows")

tableNames :Object

Ассоциативный массив с именами таблиц для заголовочной и строчной частей документа. Ключами выступают типы документов (documentType или из С++ класса Document). Вложенные объекты имеют два поля: "head" (таблица заголовочной части) и "rows" (таблица строчной части).

Methods description

constants(codeKey) → String

Вернуть значение константы по ключу.

Parameters:
Name Type Description
codeKey String Код константы
Return:
String - - Значение константы

convertExtraAttributeValue(extraAttribute) → String

Вернуть конвертированное значение дополнительного атрибута.

Parameters:
Name Type Description
extraAttribute ExtAttributeValueTitle Доп. атрибут, значение которого необходимо конвертировать
Return:
String - Конвертированное для вывода значение доп. атрибута
Example
• Для дополнительных атрибутов типа "DataTypeMultiple" возвращаются значения объединенные тэгом 
 в строку
• Для дополнительных атрибутов типа "DataTypePhoto" и "DataTypePhotoPackage" возвращается тэг изображения с
  data-атрибутом, хранящим пути до файлов, объединенных символом "|"
• Для атрибутов остальных типов просто возвращаются значения

Вернуть ссылку на документ по его идентификатору.

Parameters:
Name Type Description
id ID Идентификатор документа
Return:
String - Тэг ссылки с onclick-атрибутом, выполняющим stmobile.launcher.open необхоимого URI
Example
Кликабельная ссылка с текстом:
"Отгрузка №666421337 от 30.02.1984"

documentNames() → Object

Вернуть ассоциативный массив с именами документов (ShortName из enOperationTypes).

Return:
Object - Имена документов. Ключами выступают имена таблиц строчной или заголовочной части

references(id, method) → String|Null

Запросы названий из таблиц ref.

Parameters:
Name Type Description
id ID Идентификатор объекта
method String Имя метода api.ref, посредством которого определяется наименование
Return:
String | Null - Наименование объекта или Null, если переданы неверные данные / объект не имеет имени