Просмотр кода страницы Модуль взаимодействия с ядром ЛИС

Модуль <code>@chemsof/chemic</code> дает доступ к ядру ЛИС из node, по сути являясь оберткой над <code>chemic.dll</code>, обращаясь к его методам через Chemic API. Модуль поделен на пространства имен и классы.

<b>Принятые обозначения в заголовках и оглавлении:</b>

<code>Something():</code> метод, функция, что-то, что можно вызвать, сигнатура может не совпадать 

<code>EXP:</code> Фича с экспериментальной поддержкой

<code>READONLY:</code> свойство только для чтения

==Быстрый старт==

===Установка===
Настроить подключение <code>npm-registry</code> из GitLab (для инструкций см. сам репозиторий <code>npm-registry</code>)

После этого для Установка модуля пишем
<syntaxhighlight lang="javascript">
npm i @chemsoft/chemic
</syntaxhighlight>

===Подключение===
Модуль подключается из кода следующим образом:
<syntaxhighlight lang="javascript">
const chemic = require('@chemsoft/chemic')
</syntaxhighlight>
Теперь обращаясь к <code>chemic</code> можно взаимодействовать с ядром ЛИС.

==Инициализация ядра==
===Подключение к БД===
По умолчанию строка подключения БД считывается из реестра ветки ЛИС (<code>\HKCU\SOFTWARE\НИИ ВН\АРМ «Химик-аналитик»\Connect</code> или аналогичный ключ в <code>HKLM</code>).

Для изменения строки подключение можно передать кастомную через переменную среды <code>CONNECTION_STRING</code>.

Например:
<syntaxhighlight lang="javascript">
set CONNECTION_STRING=Provider=SQLNCLI11.1;Password=1;User ID=ch_ttg2_barabinsk;Data Source=MSSQL08;Application Name=LISChemic;MARS Connection=True

# Теперь можно запускать скрипт
</syntaxhighlight>

===Пользовательская часть===
*По идентификатору

Передача переменных среды
<syntaxhighlight lang="javascript">
set LIS_USER_ID=777

# Теперь можно запускать скрипт
</syntaxhighlight>

Установка значений в глобальном объекте
<syntaxhighlight lang="javascript">
global.LIS_USER_ID = 777;

const chemic = require("@chemsoft/chemic");
</syntaxhighlight>

*По логину и паролю
При инициализации по логину и паролю существует два варианта аутентификации:
#Прямой (<code>raw</code>) - в данном случае при аутентификации сверяется только пароль и никакие доп. проверки не осуществляются;
#Стандартный (<code>default</code>) - стандартный способ аутентификации, аналогичный входу в ЛИС через обычный лаунчер.

Передача переменных среды
<syntaxhighlight lang="javascript">
# Вариант аутентификации
set LIS_CREDENTIAL_INITIALIZE_MODE=raw
# set LIS_CREDENTIAL_INITIALIZE_MODE=raw

# Учетные данные
set LIS_USER_LOGIN=test_user
set LIS_USER_PASSWORD=1
# Пароль также может быть пустым или не указан (эквивалент пустому)
# set LIS_USER_PASSWORD=

# Теперь можно запускать скрипт
</syntaxhighlight>

Установка значений в глобальном объекте
<syntaxhighlight lang="javascript">
global.LIS_CREDENTIAL_INITIALIZE_MODE = "default";
global.LIS_USER_LOGIN = "test_user_simple";
global.LIS_USER_PASSWORD = ""; // Пустой пароль

const chemic = require("@chemsoft/chemic");
</syntaxhighlight>

==Пространство имен <code>Session</code>==

Пространство имен <code>Session</code> дает доступ к текущей сессии пользователя.

===Вложенное пространство имен <code>Session.user</code>===
Внутри <code>Session.user</code> хранится информация о пользователе текущей сессии

<code>Session.user.name</code> хранит в себе строку с ФИО пользователя

<code>Session.user.id</code> идентификатор пользователя

<code>Session.user.roles.id</code> идентификатор роли пользователя

<code>Session.user.roles.name</code> название роли

<code>Session.user.roles.banned</code> флаг бана роли

===Свойство <code>Session.labId</code>===
<code>Session.labId</code> идентификатор лаборатории

==Пространство имен <code>User</code>==

<code>User.hasRole()</code> Проверка на то, имеет ли пользователь указанную роль

<code>param: idOrName</code> Идентификатор или имя роли

<code>param: ignoreBanned</code> Игнорирует при рассмотрении заблокированные роли

<code>return: boolean</code> Возвращает <code>true</code>, если пользователь имеет указанную роль, <code>false</code> - если нет

<syntaxhighlight lang="javascript">
User.hasRole(idOrName: number | string, ignoreBanned?: boolean): boolean;
</syntaxhighlight>

==Пространство имен <code>SecurityStorage</code>==

Пространство имен <code>SecurityStorage</code> дает доступ защищенному хранилищу пользователя. Защищенное хранилище место где пользователь может хранить какую-то чувствительную информацию в словарном представлении (ключ-значение).

===<code>SecurityStorage.isPathExist()</code>===
Проверка существования файла по пути из защищенного хранилища (ЗХ), также можно задать имя файла, которое добавится к директории из ЗХ

<code>param: pathKey</code> Ключ из ЗХ, по которому хранится полный путь к файлу или директории

<code>param: filename</code> Имя файла (необязательно)

<code>return: boolean</code> Результат проверки существования пути

<syntaxhighlight lang="javascript">
SecurityStorage.isPathExist(pathKey: string, filename?: string): boolean
</syntaxhighlight>

===<code>SecurityStorage.readFileContent()</code>===
Синхронное чтение данных из файла по пути из ЗХ, также можно задать имя файла, которое добавится к директории из ЗХ

<code>param: pathKey</code> Ключ из ЗХ, по которому хранится полный путь к файлу или директории

<code>param: filename</code> Имя файла (необязательно)

<code>return: string | null</code> Содержимое файла

<syntaxhighlight lang="javascript">
SecurityStorage.readFileContent(pathKey: string, filename?: string): string | null;
</syntaxhighlight>

===<code>SecurityStorage.writeFileContent()</code>===
Синхронная запись данных в файл по пути из ЗХ, также можно задать имя файла, которое добавится к директории из ЗХ

<code>param: pathKey</code> Ключ из ЗХ, по которому хранится полный путь к файлу или директории

<code>param: filename</code> Имя файла (может быть <code>null</code>)

<code>param: content</code> Данные для записи в файл

<syntaxhighlight lang="javascript">
SecurityStorage.writeFileContent(pathKey: string, filename: string | null, content: string): void;
</syntaxhighlight>

===<code>SecurityStorage.copyFile()</code>===
Копирование файла по пути из ЗХ

<code>param: srcPath</code> Путь к файлу

<code>param: dstPathKey</code> Ключ из ЗХ, по которому хранится полный путь к директории

<syntaxhighlight lang="javascript">
SecurityStorage.copyFile(srcPath: string, dstPathKey: string): void;
</syntaxhighlight>

===<code>SecurityStorage.moveFile()</code>===
Перемещение файла по пути из ЗХ

<code>param: srcPath</code> Путь к файлу

<code>param: dstPathKey</code> Ключ из ЗХ, по которому хранится полный путь к директории

<syntaxhighlight lang="javascript">
SecurityStorage.moveFile(srcPath: string, dstPathKey: string): void;
</syntaxhighlight>

===<code>SecurityStorage.getKeyValue()</code>===
Получение значение из защищенного хранилища пользователя

<code>param: key</code> Ключ

<code>return: string | null</code> Значение (если есть)

<syntaxhighlight lang="javascript">
SecurityStorage.getKeyValue(key: string): string | null;
</syntaxhighlight>

==Пространство имен <code>Documents</code>==

Пространство имен <code>Documents</code> позволяет работать с документами ЛИС: создавать и экспортировать.

===<code>Documents.exportToPdf()</code>===
Экспортирует готовый документ в pdf

<code>param: documentId</code> Идентификатор готового документа (таблица dFormsDOX)

<code>param: filePath</code> Полный путь к файлу для экспорта (расширение .pdf)

<syntaxhighlight lang="javascript">
Documents.exportToPdf(documentId: number, filePath: string): void;
</syntaxhighlight>

===<code>Documents.exportToPdfAsync() EXP</code>===
Асинхронно экспортирует готовый документ в pdf

<code>param: documentId</code> Идентификатор готового документа (таблица dFormsDOX)

<code>param: filePath</code> Полный путь к файлу для экспорта (расширение .pdf)

<code>param: callback</code> Обработчик завершения операции

<syntaxhighlight lang="javascript">
Documents.exportToPdfAsync(documentId: number, filePath: string, callback: (err?: Error) => void): void;
</syntaxhighlight>

===<code>Documents.exportToPdfSecure()</code>===
Экспортирует готовый документ в pdf, в качестве пути используя значение из защищенного хранилища ЛИС

<code>param: documentId</code> Идентификатор готового документа

<code>param: pathSecureKey</code> Ключ защищенного хранилища, по которому хранится путь

<code>param: fileName</code> Имя файла для сохранения (расширение .pdf)

<syntaxhighlight lang="javascript">
Documents.exportToPdfSecure(documentId: number, pathSecureKey: string, fileName: string): void;
</syntaxhighlight>

===<code>Documents.exportToPdfSecureAsync() EXP</code>===
Асинхронно экспортирует готовый документ в pdf, в качестве пути используя значение из защищенного хранилища ЛИС

<code>param: documentId</code> Идентификатор готового документа

<code>param: pathSecureKey</code> Ключ защищенного хранилища, по которому хранится путь

<code>param: fileName</code> Имя файла для сохранения (расширение .pdf)

<code>param: callback</code> Обработчик завершения операции

<syntaxhighlight lang="javascript">
Documents.exportToPdfSecureAsync(documentId: number, pathSecureKey: string, fileName: string, callback: (err?: Error) => void): void;
</syntaxhighlight>

===<code>Documents.exportToXml()</code>===
Экспортирует готовый документ в файл XML (win1251)

<code>param: id</code> Идентификатор документа

<code>param: path</code> Путь к сохраняемому файлу

<syntaxhighlight lang="javascript">
Documents.exportToXml(id: number, path: string): void;
</syntaxhighlight>

===<code>Documents.extractToXml()</code>===
Экспортирует готовый документ в строку XML

<code>param: id</code> Идентификатор документа

<syntaxhighlight lang="javascript">
Documents.extractToXml(id: number): string;
</syntaxhighlight>

==Класс <code>Documents.Generator</code>==

===Базовые типы, которыми оперирует класс===

<syntaxhighlight lang="javascript">
type GeneratorParameterType = null | number | string | { type: 'time' | 'date', value: Date };

interface GeneratorParameter {
  readonly type?: 'number' | 'string' | 'date' | 'time';
  readonly name: string;
  readonly isComboBox: boolean;
  readonly isReadOnly: boolean;
  readonly value: number | string | Date;
  readonly availableValues?: string[]; // Только для комбо (isComboBox === true)
  readonly meta: {
    readonly min?: number; // Минимальное значение числа (для type === 'number')
    readonly max?: number; // Максимальное значение числа (для type === 'number')
    readonly stringMaxLength: number;
  },
}
</syntaxhighlight>

===Статические методы (методы класса)===

<b><code>Documents.Generator.create()</code></b>

<code>param: formId</code> Идентификатор формы документа

<syntaxhighlight lang="javascript">
Documents.Generator.create(formId: number): Generator;
</syntaxhighlight>

<b><code>Documents.Generator.createAsync() EXP</code></b>

Асинхронное создание документа

<code>param: formId</code> Идентификатор формы документа

<code>param: callback</code> Обработчик завершения операции

<syntaxhighlight lang="javascript">
Documents.Generator.createAsync(formId: number, callback: (err?: Error, generator?: Generator) => void): void;
</syntaxhighlight>

===Методы экземпляра (ex)===

<b><code>ex.getParameters()</code></b>

Возвращает список параметров документа и информацию о них

<syntaxhighlight lang="javascript">
ex.getParameters(): GeneratorParameter[];
</syntaxhighlight>

<b><code>ex.setParameter()</code></b>

Устанавливает значение параметра для текстового поля ввода документа

<code>param: parameterNumber</code> Номер параметра

<code>param: parameter</code> Значение параметра

<syntaxhighlight lang="javascript">
ex.setParameter(parameterNumber: number, parameter: GeneratorParameterType): Generator;
</syntaxhighlight>

<b><code>ex.setParameterByIndex()</code></b>

Устанавливает значение параметра для выпадающего списка по индексу из списка доступных значений (GeneratorParameter.availableValues)

<code>param: parameterNumber</code> Номер параметра

<code>param: valueIndex</code> Индекс значения

<syntaxhighlight lang="javascript">
ex.setParameterByIndex(parameterNumber: number, valueIndex: number): Generator;
</syntaxhighlight>

<b><code>ex.saveInDatabase()</code></b>

Сохраняет документ в базе данных

<code>return: number</code> Идентификатор сохраненного документа

<syntaxhighlight lang="javascript">
ex.saveInDatabase(): number;
</syntaxhighlight>

<b><code>ex.toPdf()</code></b>

Экспортирует документ в формат pdf

<code>param: filePath</code> Путь к экспортируемому документу

<syntaxhighlight lang="javascript">
ex.toPdf(filePath: string): Generator;
</syntaxhighlight>

<b><code>ex.toPdfAsync() EXP</code></b>

Асинхронно экспортирует документ в формат pdf. Недоступно для вызова из планировщика.

<code>param: filePath</code> Путь к экспортируемому документу

<code>param callback</code> Обработчик завершения операции

<syntaxhighlight lang="javascript">
ex.toPdfAsync(filePath: string, callback: (err?: Error, generator?: Generator) => void): void;
</syntaxhighlight>

<b><code>ex.toXlsx()</code></b>

Экспортирует документ в формат xlsx

<code>param: filePath</code> Путь к экспортируемому документу

<syntaxhighlight lang="javascript">
ex.toXlsx(filePath: string): Generator;
</syntaxhighlight>

<b><code>ex.toXlsxAsync() EXP</code></b>

Асинхронно экспортирует документ в формат xlsx. Недоступно для вызова из планировщика (пока не обновлен экспорт до новой версии)

<code>param: filePath</code> Путь к экспортируемому документу

<code>param: callback</code> Обработчик завершения операции

<syntaxhighlight lang="javascript">
ex.toXlsxAsync(filePath: string, callback: (err?: Error, generator?: Generator) => void): void;
</syntaxhighlight>

<b><code>ex.destroy()</code></b>

Удаляет экземпляр документа, желательно вызывать, чтобы не занимать зря память.

<syntaxhighlight lang="javascript">
ex.destroy(): void;
</syntaxhighlight>

<b><code>ex.toXml()</code></b>

Экспортирует документ в файл XML (win1251)

<code>param: filePath</code> Путь к экспортируемому документу

<syntaxhighlight lang="javascript">
ex.toXml(filePath: string): Generator;
</syntaxhighlight>

<b><code>ex.getXml()</code></b>

Экспортирует документ в строку XML

<syntaxhighlight lang="javascript">
ex.getXml(): string;
</syntaxhighlight>

==Пространоство имен <code>Container</code>==

===Входной параметр для исполняемой задачи элемента контейнера===

<syntaxhighlight lang="javascript">
interface InputParameter {
  name: string;
  value: null | number | boolean | string | Date;
}
</syntaxhighlight>

===<code>Container.createRecord()</code>===
Создает экземпляр класса Record

<code>recordName: string</code> Имя основной записи

<code>recordColumnsName: string[]</code> Имена колонок для таблицы основных записей

<syntaxhighlight lang="javascript">
Container.createRecord(recordName: string, recordColumnsName: string[]): Record;
</syntaxhighlight>

===<code>Container.log()</code>===
Запись сообщения в журнал действий контейнера (QT_LOG)

<code>messageData</code> Контент для записи

<syntaxhighlight lang="javascript">
Container.log(messageData: any): void;
</syntaxhighlight>

===Класс <code>Container.Record</code>===
<b><code>constructor()</code></b>

<code>recordName: string</code> Имя основной записи в контейнере задач

<code>recordColumnsName: Array<string></code> Имена колонок для таблицы элементов контейнера

<syntaxhighlight lang="javascript">
new Container.Record(recordName: string, recordColumnsName: Array<string>);
</syntaxhighlight>

<b><code>ex.setExecutedTask()</code></b>
Устанавливает задачу на исполнение для элементов основной записи контейнера

<code>name: string</code> Имя задачи (из дизайнера задач) для исполнения при выборе элемента

<syntaxhighlight lang="javascript">
ex.setExecutedTask(name: string): void;
</syntaxhighlight>

<b><code>ex.setName()</code></b>
<code>name: string</code> Имя задачи (из дизайнера задач) для исполнения при выборе элемента

<syntaxhighlight lang="javascript">
ex.setName(name: string): void;
</syntaxhighlight>

<b><code>addItem()</code></b>
Добавление элемента в контейнер

<code>columnsValue: Array<null | number | boolean | string | Date></code> Значение колонок таблицы добавляемого элемента

<code>inputParameters:Array<InputParameter> | null</code> Значение входных параметров для исполняемой задачи

<syntaxhighlight lang="javascript">
ex.addItem(columnsValue: Array<null | number | boolean | string | Date>, inputParameters?: Array<InputParameter> | null): void;
</syntaxhighlight>

<b><code>save()</code></b>
Производит сохранение сформированной записи в базу данных

<code>return: boolean</code> Результат сохранения (успешно или нет)

<syntaxhighlight lang="javascript">
ex.save(): boolean;
</syntaxhighlight>

==Пространство имен Scheduler==

===<code>Scheduler.evalTask()</code>===
Исполняет задание планировщика по его имени

<code>name: string</code> Имя задачи

<syntaxhighlight lang="javascript">
Scheduler.evalTask(name: string): void;
</syntaxhighlight>

==Пространство имен <code>Forms</code>==

Даёт доступ к различным частям ЛИС, в основном позволяет открыть какой-либо журнал или калькулятор.

===Базовые типы, принятые в пространстве имен===

<syntaxhighlight lang="javascript">
enum CalculatorFormType {
  /**
   * Стандартный калькулятор
   */
  DEFAULT,
  /**
   * Табличный калькулятор
   */
  TABLE,
}
</syntaxhighlight>

<syntaxhighlight lang="javascript">
type Names =
  'ЛЖ' |
  'ОА' |
  'ЖРО1' |
  'ЖРО2' |
  'Химпосуда 2.0' |
  'Методы' |
  'Методики' |
  'КонтрольныеТочки' |
  'Лаборатории' |
  'УнивСправочник' |
  'ВЛК2Алгоритмы' |
  'ВЛК2Процедуры' |
  'ХимВ-ва2' |
  'КаталогРеактивов2' |
  'РеактивыФирм2' |
  'ЖУХР2' |
  'Растворы2' |
  'ЖурналПриготовленияРастворов2' |
  'КГ' |
  'ГХ' |
  'СМК2_Документ';
</syntaxhighlight>

===<code>Forms.openContainer()</code>===
Открывает контейнер задач ЛИС

<syntaxhighlight lang="javascript">
Forms.openContainer(): void;
</syntaxhighlight>

===<code>Forms.openForm()</code>===
Открывает указанную форму ЛЖ на конкретной записи

<code>formName: string</code> Имя формы для открытия

<code>recordId: number</code> Идентификатор записи (0 для открытия последней записи)

<syntaxhighlight lang="javascript">
Forms.openForm(formName: Names, recordId: number | 0): void;
</syntaxhighlight>

===<code>Forms.openSmkJournal()</code>===
Открывает указанный журнал СМК на указанной записи

<code>usId: number</code> Идентификатор универсального справочника для журнала СМК

<code>recordId: number</code> Идентификатор записи в данном журнале СМК

<syntaxhighlight lang="javascript">
function openSmkJournal(usId: number, recordId: number): void;
</syntaxhighlight>

===<code>Forms.openLj()</code>===
Открывает указанный ЛЖ на последней записи

<code>journalName: string</code> Имя лабораторного журнала

<syntaxhighlight lang="javascript">
Forms.openLj(journalName: string): void;
</syntaxhighlight>

===<code>Forms.openLjRecord()</code>===
Открывает ЛЖ на основе записи из Journal_table_r

<code>recordId: number</code> Идентификатор записи ЛЖ

<syntaxhighlight lang="javascript">
Forms.openLjRecord(recordId: number): void;
</syntaxhighlight>

===<code>Forms.openCalculator()</code>===
Открывает калькулятор параллельного определения результата ЛЖ

<code>parallelResultId: number</code> Идентификатор параллельного определения

<code>return: number</code> Результат вычислений калькулятора

<syntaxhighlight lang="javascript">
Forms.openCalculator(parallelResultId: number, calculatorFormType: CalculatorFormType): number;
</syntaxhighlight>

===<code>Forms.openIndicatorsDistributionDialog()</code>===
Открывает диалог распределение показателей для записи в ЛЖ

<code>journalRecordId: number</code> Идентификатор записи ЛЖ

<code>return: {isDialogCanceled: boolean, indicators: Indicator[]}</code> Возвращает статус закрытия диалога (был ли отменен) и список показателей

<syntaxhighlight lang="javascript">
Forms.openIndicatorsDistributionDialog(journalRecordId: number): { 
      isDialogCanceled: boolean;
      indicators: Indicator[];
    }
</syntaxhighlight>

===<code>Forms.showPopup()</code>===
Выводит всплывающее уведомление в нижней правой части экрана

<code>content: any</code> Данные для вывода в всплывающем сообщении

<code>options: PopupOptions</code> Параметры всплывающего сообщения

<syntaxhighlight lang="javascript">
interface PopupOptions {
  showingTimeMs: number;
}
</syntaxhighlight>

<syntaxhighlight lang="javascript">
Forms.showPopup(content: any, options?: PopupOptions): void;
</syntaxhighlight>

==Пространство имен ProbeDivider==

Предоставляет функционал для работы с Делителем проб.

===<code>ProbeDivider.run()</code>===
Вызывает заданный делитель проб ЛИС для указанной записи в журнале

<code>sourceRecordId: number</code> Идентификатор записи в журнале (таблица Journal_table)

<code>dividerName: string</code> Имя делителя

<code>return: number</code> Идентификатор созданной записи

<syntaxhighlight lang="javascript">
ProbeDivider.run(sourceRecordId: number, dividerName: string): number;
</syntaxhighlight>

===<code>ProbeDivider.countDone()</code>===
Возвращает количество уже имеющихся записей, созданных указанным делителем на указанной записи в журнале

<code>sourceRecordId: number</code> Идентификатор записи в журнале (таблица Journal_table)

<code>dividerName: string</code> Имя делителя

<code>return: number</code> Количество готовых записей

<syntaxhighlight lang="javascript">
ProbeDivider.countDone(sourceRecordId: number, dividerName: string): number;
</syntaxhighlight>

==Пространство имен <code>Calculator</code>==

Простой и быстрый доступ к калькулятору результата (создает новый)

===<code>Calculator.init()</code>===
Инициализация калькулятора

<code>journalResultId: number</code> Идентификатор результата в ЛЖ

<syntaxhighlight lang="javascript">
Calculator.init(journalResultId: number): void;
</syntaxhighlight>

===<code>Calculator.set()</code>===
Установка переменной калькулятора

<code>variableName: string</code> Имя переменной калькулятора

<code>value: number | string | Date | TypedValue</code> Устанавливаемое значение

<syntaxhighlight lang="javascript">
Calculator.set(variableName: string, value: number | string | Date | TypedValue): void;
</syntaxhighlight>

===<code>Calculator.flush()</code>===
Утверждение изменений

<code>throws {CalculationError}</code>

<syntaxhighlight lang="javascript">
Calculator.flush(): void
</syntaxhighlight>

===<code>Calculator.partialFlush()</code>===
Сохранение значений переменных калькулятора с установкой расчетного или пользовательского значения, без расчета среднего.

<syntaxhighlight lang="javascript">
Calculator.flush(parallelId: number, useCustomParallelValue: boolean, customParallelValue: number): void
</syntaxhighlight>

<code>jrParallelId - [jrparallel].[num_rec].</code> Если такого значения нет у результата анализа - добавляется новое параллельное.
<code>useCustomParallelValue</code> - признак использования пользовательского значения параллельного измерения
<code>customParallelValue</code> - пользовательское значение параллельного измерения

Независимо от значения <code>useCustomParallelValue</code> будет выполнен расчет выражения формулы - для заполнения значениями левых переменных. Если <code>useCustomParallelValue</code>, то ошибки при расчете формулы игнорируются.

==Пространство имен <code>Round</code>==

Округляет числа в соответствии с методикой

===<code>Round.byMethodicAsNumber()</code>===
Производит округление по методике (возвращает число)

<code>value: number</code> Округляемое значение

<code>methodicId: number</code> Идентификатор методики

<code>return: number | null;</code> Возвращает округленный результат

<syntaxhighlight lang="javascript">
Round.byMethodicAsNumber(value: number, methodicId: number): number | null;
</syntaxhighlight>

===<code>Round.byMethodicAsString()</code>===
Производит округление по методике

<code>value: number</code> Округляемое значение

<code>methodicId: number</code> Идентификатор методики

<code>return: string | null;</code> Возвращает округленный результат

<syntaxhighlight lang="javascript">
Round.byMethodicAsString(value: number, methodicId: number): string | null;
</syntaxhighlight>

==Класс <code>Lj</code>==

===Методы экземпляра (ex)===
<b><code>constructor()</code></b>
<code>journal: string | number</code> Имя формы журнала или идентификатор журнала (не формы!)

<syntaxhighlight lang="javascript">
constructor(journal: string | number);
</syntaxhighlight>

<code>ex.id READONLY</code>
Идентификатор журнала

<syntaxhighlight lang="javascript">
ex.id: number;
</syntaxhighlight>

<b><code>ex.recordsByCipher()</code></b>
Идентификаторы записей с указанным шифром

<code>cipher: string</code> Шифр пробы

<code>return: number[]</code> Идентификаторы записей с указанным шифром

<syntaxhighlight lang="javascript">
ex.recordsByCipher(cipher: string): number[];
</syntaxhighlight>

<b><code>ex.addRecord()</code></b>
Создает новую запись в журнале и возвращает её идентификатор

<code>controlPointId</code> Идентификатор контрольной точки

<code>isProtected</code> В данный момент неизвестно, уточнить

<code>indicators</code> Информация о принудительно выставляемых показателях

<code>date</code> Дата и время отбора пробы

<code>isSpecial</code> В данный момент неизвестно, уточнить

<code>return: number</code> Идентификатор записи журнала

<syntaxhighlight lang="javascript">
ex.addRecord(controlPointId: number, isProtected?: boolean, indicators?: Indicator[], date?: Date, isSpecial?: boolean): RecordManager;
</syntaxhighlight>

===Статические методы (методы класса)===
<b><code>Lj.getIdByName()</code></b>
Возвращаем идентификатор журнала (для базовой лаборатории пользователя) по его имени

<code>name: string</code> Имя журнала

<code>return: number</code> Идентификатор журнала

<syntaxhighlight lang="javascript">
Lj.getIdByName(name: string): number;
</syntaxhighlight>

==Класс <code>RecordManager</code>==

===Методы экземпляра (ex)===
<code>recordId: number</code> Идентификационный записи в журнале (таблица journal_table)

<syntaxhighlight lang="javascript">
ex.constructor(recordId: number);
</syntaxhighlight>

<b><code>ex.id READONLY</code></b>

Идентификатор текущей записи

<syntaxhighlight lang="javascript">
ex.id: number;
</syntaxhighlight>

<b><code>ex.cipher</code></b>

Установка и получение шифра пробы

<syntaxhighlight lang="javascript">
ex.cipher: string;
</syntaxhighlight>

<b><code>ex.takingDate</code></b>

Установка и получение даты отбора пробы

<syntaxhighlight lang="javascript">
ex.takingDate: Date;
</syntaxhighlight>

<b><code>ex.takingTime</code></b>

Установка и получение времени отбора пробы

<syntaxhighlight lang="javascript">
ex.takingTime: Date;
</syntaxhighlight>

<b><code>ex.setProperty()</code></b>

Устанавливает значение в указанное поле информации о пробе

<code>propertyName: string</code> Имя поля

<code>value: null | undefined | number | boolean | string | Date</code> Значение

<syntaxhighlight lang="javascript">
ex.setProperty(propertyName: string, value: null | undefined | number | boolean | string | Date): void;
</syntaxhighlight>

<b><code>ex.getProperty()</code></b>

Возвращает значение указанного поля из информации о пробе

<code>propertyName: string</code> Имя поля

<code>return: null | undefined | number | boolean | string | Date</code> Значение

<syntaxhighlight lang="javascript">
ex.getProperty(propertyName: string): null | undefined | number | boolean | string | Date;
</syntaxhighlight>

<b><code>ex.getMeasureManager()</code></b>

Возвращает объект для работы с показателем с заданным именем в установленной записи ЛЖ

<code>indicatorName: string</code> Имя показателя

<code>return: MeasureManager</code> Объект для работы с показателем

<syntaxhighlight lang="javascript">
ex.getMeasureManager(indicatorName: string): MeasureManager;
</syntaxhighlight>

<b><code>ex.setRawField()</code></b>

Изменяет поле информации о пробе (напрямую в таблице journal_table)

<code>name: string</code> Имя поля для модификации из таблицы journal_table

<code>value: null | undefined | number | boolean | string | Date</code> Устанавливаемое значение

<syntaxhighlight lang="javascript">
ex.setRawField(name: string, value: null | undefined | number | boolean | string | Date): void
</syntaxhighlight>

<b><code>ex.setControlPoint()</code></b>

Смена контрольной точки

<code>controlPointId: number</code> Идентификатор контрольной точки

<code>indicators: Indicator[]</code> Информация о принудительно выставляемых показателях

<syntaxhighlight lang="javascript">
ex.setControlPoint(controlPointId: number, indicators?: Indicator[]): void;
</syntaxhighlight>

<b><code>ex.remove()</code></b>

Удаляет текущую запись

<syntaxhighlight lang="javascript">
ex.remove(): void;
</syntaxhighlight>

==Класс <code>MeasureManager</code>==

<b><code>constructor()</code></b>

<code>measureId: number</code> Идентификатор результата

<syntaxhighlight lang="javascript">
constructor(measureId: number);
</syntaxhighlight>

<b><code>ex.takingDateBegin</code></b>

Дата начала анализа

<syntaxhighlight lang="javascript">
ex.takingDateBegin: Date;
</syntaxhighlight>

<b><code>ex.takingDateEnd</code></b>

Дата окончания анализа

<syntaxhighlight lang="javascript">
ex.takingDateEnd: Date;
</syntaxhighlight>

<b><code>ex.takingTimeBegin</code></b>

Время начала анализа

<syntaxhighlight lang="javascript">
ex.takingTimeBegin: Date;
</syntaxhighlight>

<b><code>ex.takingTimeEnd</code></b>

Время окончания анализа

<syntaxhighlight lang="javascript">
ex.takingTimeEnd: Date;
</syntaxhighlight>

<b><code>ex.id READONLY</code></b>

Содержит идентификатор результата

<syntaxhighlight lang="javascript">
ex.id: number;
</syntaxhighlight>

<b><code>ex.executor</code></b>

Имя исполнителя анализа

<syntaxhighlight lang="javascript">
ex.executor: string;
</syntaxhighlight>

<b><code>ex.methodicName READONLY</code></b>

Содержит идентификатор результата

<syntaxhighlight lang="javascript">
ex.methodicName: string;
</syntaxhighlight>

<b><code>ex.calculateAverage()</code></b>

Пересчитать средний результат в ЛЖ

<code>parametersRecount: ParametersRecount</code> Параметры для расчета среднего результата в ЛЖ

<syntaxhighlight lang="javascript">
interface ParametersRecount {
  calculateMedian: boolean;
  checkAcceptability: boolean;
}
</syntaxhighlight>

<syntaxhighlight lang="javascript">
ex.calculateAverage(parametersRecount?: ParametersRecount): void;
</syntaxhighlight>

<b><code>ex.setParallel()</code></b>

Установка параллельного измерения

<code>value: number</code> Значение

<code>throws {CalculationError}</code>

<syntaxhighlight lang="javascript">
ex.setParallel(value: number): void;
</syntaxhighlight>

<b><code>ex.setParallels()</code></b>

Установка нескольких параллельных измерений

<code>values: number[]</code> Массив значений

<code>rewrite: boolean</code> Необходимость удалить старые измерения

<code>throws {CalculationError}</code>

<syntaxhighlight lang="javascript">
ex.setParallels(values: number[], rewrite?: boolean): void;
</syntaxhighlight>

<b><code>ex.setParallelAsync()</code></b>

Асинхронная установка Установка параллельного измерения

<code>value: number</code> Значение результата

<code>callback</code> Обработчик завершения операции

<syntaxhighlight lang="javascript">
ex.setParallelAsync(value: number, callback: (err?: CalculationError | Error) => void): void;
</syntaxhighlight>

<b><code>ex.updateParallel()</code></b>

Замена существующего значения параллельного измерения

<code>parallelNum</code> - [jrparallel].[n]

<code>value</code> - значение параллельного измерения

<syntaxhighlight lang="javascript">
ex.updateParallel(parallelNum: number, value: number): void;
</syntaxhighlight>

Обновляет <code>journal_result.jtxt</code> и <code>journal_result.cdesc</code> После установки выполняется попытка(!) расчета среднего. Ошибки расчета среднего игнорируются и не возвращаются!

<b><code>ex.setAverage()</code></b>

Установка определенных полей записи результата анализа (journal_result) с логированием

<syntaxhighlight lang="javascript">
interface AverageParam {
  name: 'string';           // имя поля journal_result
  value: string | number;  // значение (если null - то значение поля в БД тоже сбрасывается в null)
}
</syntaxhighlight>

<syntaxhighlight lang="javascript">
ex.setAverage(params: AverageParam): void;
</syntaxhighlight>

Доступны поля:

*«Норматив сходимости» - Journal_result.Dabs
*«Норматив сходимости (относительное значение)» - Journal_result.Drel
*«Фактическая сходимость» - Journal_result.Razmah
*«Результаты анализа»
*«Среднее значение показателя (безусловно)» - Journal_result.CasIs -> в параллельное, если их нет
*«Значение показателя (среднее)» - Journal_result.C
*«Значение показателя (среднее, округлённое)» - Journal_result.StrC
*«Среднее значение показателя или мин.» - Journal_result.xom - CFT_REAL
*«Среднее значение показателя или 0, если \<мин.» - Journal_result.Cnu - CFT_REAL
*«Погрешность»
*«Погрешность» - Journal_result.dc
*«Погрешность (округлённая)» - Journal_result.StrD
Если указано значение поля из группы «Результаты анализа» - проверяется наличие параллельных измерений.

Если параллельных нет: если передается значение CasIs - то оно добавляется в параллельные, иначе ошибка.

Если передается значение CasIs то дополнительно рассчитывается норма.

<b><code>ex.getAverageResult()</code></b>

Получение среднего результата измерения

<syntaxhighlight lang="javascript">
ex.getAverageResult(): void;
</syntaxhighlight>

<b><code>ex.getCalculator()</code></b>

Инициализация калькулятора

<code>return: MeasureCalculator</code>

<syntaxhighlight lang="javascript">
ex.getCalculator(): MeasureCalculator;
</syntaxhighlight>

<b><code>ex.setAnalysisState()</code></b>

Меняет состояние анализа (таблица journal_result, поле state)

<code>analysisState: AnalysisState</code> Состояние анализа

<syntaxhighlight lang="javascript">
ex.setAnalysisState(analysisState: AnalysisState): void
</syntaxhighlight>

<b><code>ex.setRawField()</code></b>

Изменяет поля результата анализа (напрямую в таблице journal_result)

<code>name: string</code> Имя поля для модификации из таблицы Journal_result

<code>value: null | undefined | number | boolean | string | Date</code> Устанавливаемое значение

<syntaxhighlight lang="javascript">
ex.setRawField(name: string, value: null | undefined | number | boolean | string | Date): void
</syntaxhighlight>

value: 0 | 1 | 2 Состояние измерения

<syntaxhighlight lang="javascript">
0 - выполняется
1 - готово
2 - невозможно
</syntaxhighlight>

<syntaxhighlight lang="javascript">
ex.setRawField(name: 'state', value: 0 | 1 | 2): void
</syntaxhighlight>

<b><code>ex.linkEquipmentToResult()</code></b>

Привязывает оборудование ко вкладке "Ресурсы" для выбранного показателя

<code>equipment: number[]</code> Массив с id оборудования

<syntaxhighlight lang="javascript">
ex.linkEquipmentToResult(equipment: number[]): void
</syntaxhighlight>

<b><code>ex.unlinkEquipmentFromResultAll()</code></b>

Отвязывает оборудование ко вкладке "Ресурсы" для выбранного показателя

<syntaxhighlight lang="javascript">
```ts ex.unlinkEquipmentFromResultAll(): void

## Класс `ParallelMeasurementManager`

### `constructor()`

`parallelId: number` Идентификатор параллельного измерения

```ts
constructor(parallelId: number);
</syntaxhighlight>

<b><code>ex.id READONLY</code></b>

Идентификатор параллельного измерения

<syntaxhighlight lang="javascript">
ex.id: number;
</syntaxhighlight>

Рассчитать результат с уже имеющимися показателями.

<code>calculatorVariables: CalculatorVariable[]</code> перезаписать значения выбранных полей

<code>calculatorFormType: Forms.CalculatorFormType</code> тип калькулятора

<syntaxhighlight lang="javascript">
ex.calculateParallel(calculatorVariables: CalculatorVariable[], calculatorFormType: Forms.CalculatorFormType): void;
</syntaxhighlight>