Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

SimpleEventBus is a global variable for the event stream. See Global Client Events for more information on the usage of these methodsДанный класс содержит методы для работы с потоком событий. О системных коробочных событиях, с которыми этот класс может взаимодействовать, подробно написано в статье Глобальные клиентские события.

on(eventType, callback)


A subscription to an eventИспользуйте метод, чтобы подписаться на событие

ParametersПараметры:

NN
NameНазваниеTypeТипMandatoryОбязательныйЗначение по умолчаниюDefault Value
eventTypeStringYДаНет
callbackcallbackFunctionYДаНет

ReturnВозвращаемое значение:

TypeТипDescriptionОписание
ObjectContains the unsubscribe methodОбъект, содержащий метод отписки от события.

ExampleПример:

Code Block
languagejs
titleon()
linenumberstrue
const obj = SimpleEventBus.on('myEvent', (data) => { alert(data); }) 
obj.unsubscribe();

emit(eventType, data)

This method starts an event. Use it in client scripts of the widgets.

Parameters:


Используйте этот метод в клиентских скриптах или виджетах для инициализации события.

Параметры:

NN
НазваниеТипОбязательныйЗначение по умолчаниюNameTypeMandatoryDefault Value
eventTypeStringYДаНет
dataAnyNНетНет

ReturnВозвращаемое значение:

TypeТипDescriptionОписание
VoidThis method does not return a valueМетод не возвращает значение.

ExampleПример:

Code Block
languagejs
titleemit()
linenumberstrue
const obj = SimpleEventBus.emit('myEvent', 'text')

deleteEvent(eventType)


Deletes an eventИспользуйте этот метод для удаления события.

ParameterПараметр:

NameНазваниеTypeТипMandatoryОбязательныйЗначение по умолчаниюDefault Value
eventTypeStringYДаNНет

ReturnВозвращаемое значение:

TypeТип DescriptionОписание
VoidThis method does not return a valueМетод не возвращает значение.

ExampleПример:

Code Block
languagejs
titledeleteEvent()
linenumberstrue
const obj = SimpleEventBus.deleteEvent('myEvent')

reset()

This method resets all events and subscriptions.
Return:

TypeDescriptionVoidThis method does not return a value.

Используйте этот метод для сброса всех событий и подписок.

Возвращаемое значение:

ТипОписание
VoidМетод не возвращает значение.

ПримерExample:

Code Block
languagejs
titledeleteEventlinenumberstruereset()
SimpleEventBus.reset()


Table of Contents
classfixedPosition