События компонента UI

Определяет свойства событий, которые могут быть сгенерированы UI компонентом. События определяются со свойствами, идентичными тем, которые присутствуют в Событиях моделей.

Реализация Событий компонента

События, определенные для UI компонента, аналогичны событиям модели, но могут быть вызваны из кода, определенного в свойстве Source.

Определение события

События UI компонента определяются так же, как и события модели. Имя события - это имя, на которое должна быть ссылка в Источник при запуске события. Предположим, что для UI-компонента определено событие со следующими параметрами:

Поле

Значение

Имя переменной

exampleEvent

Описание

Пример события

Формат

  • Минимальное количество записей: 1

  • Максимальное количество записей: 1

  • Поля:

    • Название: вход

    • Тип: String

    • Описание: вход

Уровень

Уведомление

Права для генерации

Наблюдатель

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

Срабатывание события

В функциональном компоненте React функция fireEvent(eventName, payload [, context]) может быть использована следующим образом для запуска события, определенного выше.

const Компонент: React.FC<CustomWrappedComponentProps> = ({ component, componentModel, exampleProperty = "Пример свойства" }) => { ... componentModel.setVariable("exampleEvent",[{input: "Пример значения для таблицы данных события"}]) ... };

Аргументы в примере следующие:

  • "exampleEvent" - имя свойства, определенного выше

  • [{input: "Пример значения для таблицы данных события"}] - таблица данных, соответствующая формату, определенному в событии Формат. В данном примере это таблица данных с одной строкой и полем с именем input, со значением "Пример значения для таблицы данных события".

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