This event can only be processed by dashboards. Sending this event to an iframe that contains a non-dashboard Omni URL, such as an app, will have no effect on the embedded page.
Properties
An array of control specifications that define the control values to apply. Each entry is formatted as follows, url-encoded as it would appear in a signed embed URL:Omni reads only the
c-- entries from each string. It drops anything else, including a filter parameter, a non-string entry, or an invalid entry. If a message doesn’t have any control parameters, Omni ignores it.When to send this event
Send this event after Omni emitspage:ready or dashboard:ready. To apply controls each time a dashboard loads, send this event in response to dashboard:ready.
If the dashboard isn’t ready when the event arrives, Omni keeps the event and applies it when the dashboard is ready:
- If you send more than one event, Omni applies the events in the order that you sent them. If two events set the same control, the later event wins.
- If you send a
navigateevent, Omni discards the controls that wait for the page the user leaves. - If you send this event after a
navigateevent, Omni applies the controls to the dashboard where the navigation arrives.

