Module: document-event-manager

Provides support for firing custom notification events on wica-aware elements in the current document to update interested third-parties on the latest status received from the wica event stream.

Classes

DocumentEventManager

Type Definitions

OnWicaEvent

Provides a type definition for a JS CustomEvent object that is fired to inform observers of the latest metadata and value information received on a wica-aware element.
Properties:
Name Type Description
target Object A reference to the target element on which the event was dispatched.
detail Object An object providing the customised data payload for the event.
Properties
Name Type Description
channelName string The name of the channel associated with the element on which the event was fired. See WicaChannelName.
channelMetadata WicaChannelMetadata The most recent channel metadata. See WicaChannelMetadata.
channelValueArray Array.<WicaChannelValue> The latest channel values. See WicaChannelValue.
channelValueLatest WicaChannelValue The most recent channel value. See WicaChannelValue.