Custom JS Events
Outgoing JS Events to Emit
Emit any of these events to Explo’s iFrame or Web Component to programmatically interact with the embed.
updateExploDashboardVariable
Description: Update the value of a variable in the dashboard.
Parameters:
Parameter | Type | Description |
---|---|---|
varName | string | Name of the variable |
value | any | Value to update the variable with |
Example:
exploIframe.contentWindow.postMessage(
{
event: "updateExploDashboardVariable",
detail: { varName: "exampleVariable", value: "newValue" },
},
"*"
);
updateExploDashboardVariables
Description: Update the value of multiple variables in the dashboard.
Parameters:
Parameter | Type | Description |
---|---|---|
variables | { varName: string; value: any }[] | A list of the variable updates |
Example:
exploIframe.contentWindow.postMessage(
{
event: "updateExploDashboardVariables",
detail: {
variables: [
{ varName: "exampleVariable1", value: "newValue1" },
{ varName: "exampleVariable2", value: "newValue2" },
],
},
},
"*"
);
updateCustomerJwt
Description: Update the customer’s JWT to a new value.
Example:
exploIframe.contentWindow.postMessage(
{
event: "updateCustomerJwt",
detail: { jwt: "new_jwt" },
},
"*"
);