Last updated 20/07/2026
Overview
The
DIQ_Event
type represents the standard event message generated by a DimensionIQWidget
> instance
and distributed to other DimensionIQWidget
instances operating within a collaborative environment.
DIQ_Events provide a lightweight communication mechanism that allows multiple
DimensionIQWidget
instances to remain synchronized when changes occur within a shared project.
When an action occurs within a
DimensionIQWidget
instance, the widget generates a DIQ_Event
containing the event name
and
optional event-specific payload
data. The host application is responsible for receiving this event and forwarding it to other connected DimensionIQWidget
instances.
The host application does not need to interpret, process, or modify
DIQ_Event
messages. Events should be treated as opaque messages and forwarded exactly as received.
Each
DimensionIQWidget
instance is responsible for interpreting the event and determining whether it needs to refresh or update its local state.
Properties
| Property | Type | Required | Description |
|---|
name | string | Yes | Unique event identifier describing what occurred |
payload | string | No | Optional JSON-encoded string containing even-specific data |
Implementation Guidelines
Event Distribution
DIQ_Events are generated by an individual
DimensionIQWidget
instance when a change occurs.
In collaborative environments where multiple
DimensionIQWidget
instances are active, the host application is responsible for distributing the event to
the other connected widget instances.
The host application should forward the
DIQ_Event
exactly as received and should not modify the event name
or payload
.
Event Processing
The host application does not need to understand the meaning of a
DIQ_Event
or determine what action should be taken.
Event interpretation is handled by each receiving
DimensionIQWidget
instance. The widget determines whether the event applies to its current state and
whether any refresh or update operation is required.
Payload Handling
The optional
payload
property contains event-specific information encoded as a JSON string.
The host application should treat the
payload
as opaque data and forward it without parsing, modifying, or transforming its contents.
The structure and meaning of the payload are determined by the originating
DimensionIQWidget
and the specific event type.
Collaborative Synchronization
DIQ_Event
provides a transport independent mechanism for synchronizing multiple DimensionIQWidget
instances.
The host application is responsible only for delivering events between connected instances. The underlying transport mechanism may vary depending on the host implementation,
including REST, Server-Sent Events (SSE), WebSockets, or other messaging technologies.
Maintaining the original
DIQ_Event
structure ensures all connected DimensionIQWidget
instances receive consistent information and can maintain synchronized state.
Read-Only Behavior
DIQ_Event
messages should be considered read-only after being generated by DimensionIQ.
The host application should not modify, filter, interpret, or generate replacement events. Any event specific handling should occur within the receiving
DimensionIQWidget
instances.