Подключение пользовательской js-функции

Сигнатура пользовательской js-функции для аналитических панелей, регламентных отчётов и форм ввода:

function <Наименование функции>(пользовательские параметры, callback, args)
{
  ...
}

Параметры:

• пользовательские параметры. Значения пользовательских параметров в соответствии с сигнатурой вызываемой функции. Необязательный параметр;

• callback. Функция обратного вызова. Используется при настройке действия пользовательской кнопки в регламентных отчётах/формах ввода. Обязательный параметр.

• args. Аргументы функции. Позволяют получить доступ к объекту, из которого была выполнена js-функция. Особенности использования аргументов функции:

• для работы с аналитической панелью используйте компонент KapBox первым аргументом.

Пример js-функции, которая отображает количество блоков, содержащихся в аналитической панели, в информационном сообщении:

function countBlocks(args)
{
  activeSlideBlocks = args.KapBox.getActiveSlideBlocks();
  count = activeSlideBlocks.length;
  alert("Количество блоков слайда:  " + count);
}

• для работы с регламентным отчётом/формой ввода при настройке действия гиперссылки или пользовательской кнопки в качестве аргументов могут использоваться параметры:

• Report. Параметр для управления отчётом;

• ReportOdId. Идентификатор отчёта;

• DataEntryForm. Параметр для управления формой ввода;

• DataArea. Параметр для управления табличной областью в форме ввода.

Пример js-функции при использовании гиперссылки в форме ввода:

function addAttachmentsTB(row, col, args)
{
  var rep = args.Report;
  var da = args.DataArea;
  var grid = da.getGridView();
  var tabSheet = grid.getTabSheet();
  var tabSheetRange = tabSheet.getCell(row, col);
  attachFile(da, tabSheetRange);
}

Сигнатура пользовательской js-функции для веб-приложения и конструктора бизнес-приложений:

Platform.Events.on('<наименование события>',(args)=>
{
  ...
})

Параметры:

• наименование события. Доступна подписка на следующие события:

• startOpenPage. Обработка события начала отрисовки страницы;

• startOpenObject. Обработка события начала открытия объекта;

• startOpenFolder. Обработка события открытия папки в навигаторе объектов.

Обязательный параметр. Событие возвращает аргументы, которые затем можно использовать;

• args. Аргументы функции. Необязательный параметр. Позволяют получить информацию о событии:

• ref. Ссылка на DOM-вершину, в которой происходит событие. Используется для событий startOpenPage, startOpenObject, startOpenFolder;

• classNames. Классы корневой DOM-вершины. Используется для событий startOpenPage, startOpenObject, startOpenFolder;

• page. Тип открываемой страницы:

• login. Страница с отображением окна регистрации для входа в систему;

• navigator. В веб-приложении - страница с отображением навигатора объектов. В конструкторе бизнес-приложений - страница с отображением навигатора объектов или открытого объекта с навигационным меню;

• object. В веб-приложении - страница с отображением открытого объекта. В конструкторе бизнес-приложений - страница с отображением открытого объекта без навигационного меню. Объект без навигационного меню может быть открыт из другого объекта, например, из задачи ETL.

Используется для события startOpenPage;

• object. Описание объекта/папки. Используется для события startOpenObject/startOpenFolder;

• openMode. Режим открытия инструмента. Используется для события startOpenObject.

Примечание. При одновременной подписке на события startOpenPage и startOpenObject выполняется последовательная обработка событий: в процессе открытия объекта сначала обрабатывается событие начала отрисовки страницы, затем - начала открытия объекта.

Пример js-функции, которая обрабатывает событие при открытии объекта в веб-приложении/бизнес-приложении:

console.log(Platform.Events);
Platform.Events.on('startOpenObject', (args) =>
{
  console.log(args.object.key);
  console.log(args.classNames);
  console.log(args.openMode);
  var d = document.createElement("div");
  d.style="background-color: red;width: 10px;height: 10px;position: absolute;top: 18px;left: 10px;border-radius: 5px; z-index: 1";
  var rootNode = document.getElementsByClassName(args.classNames)[0];
  rootNode.style.position = 'relative';
  if (rootNode )
    rootNode.appendChild(d);
});