Embed report builders through a web component
<head>
of your index.html
Attribute Name | Type | Description |
---|---|---|
jwt (recommended) | string | This is the embed secret (JWT) for the report builder. We recommend you use this attribute instead of the report-builder-token . Read more about embed secrets here. |
report-builder-token | string | This is a string with two values concatenated together: (1) the report_builder_id and (2) the customer_token . You should concatenate them with a colon between them like so: "<report_builder_id>:<customer_token>" . We recommend you use the jwt instead of this attribute, but it is still supported. |
environment | string | This lets you specify the environment version that the web component is being embedded in: “production”, “staging”, “development”, etc. If environment is not specified, it will render the most recent saved version of the report builder. |
variables | string | This argument allows you to pass in values for variables on your report builder. This will result in default values for any variables and UI dropdowns on the report builder. Note that you must pass in a stringified JSON object using JSON.stringify(variablesObject) , unless you are embedding directly in an HTML file. |
locale-code | string | An optional argument that overrides any text localization settings for your team. This will localize your report builder’s numbers and dates to the desired locale, if supported. Check out support languages here. |
currency-code | string | An optional argument that overrides any currency localization settings for your team. This will localize your report builder’s currency symbols and format to the desired locale, if supported. Check out support currencies here. |
timezone | string | An optional argument that allows you to specify a timezone to display dates in. Valid values can be found here. |
theme | string | An optional argument that lets you manage multiple style/theme profiles within Explo. If not provided, uses the “default” theme. |
explo-report-builder
component. You may need to exclude this block from your
lint rules (e.g. @typescript-eslint/no-namespace)