创建嵌入操作(可公开、不公开、使用签名嵌入或通过 API 完成)后,您可以使用 JavaScript 与这些 iframe 进行互动。您可以根据嵌入内容的状态使页面更具动态性,甚至可以从网页中更改嵌入的内容。
请注意,Looker 无法控制浏览器向 Web 应用分派事件的顺序。这意味着,无法保证各个浏览器或平台中的事件顺序。请务必编写适当的 JavaScript 代码,以应对不同浏览器的事件处理。
您可以通过以下任一方式对 Looker 嵌入的内容使用 JavaScript:
- 使用 Looker 的嵌入式软件开发套件 (SDK),详情请参阅嵌入 SDK 文档页面
- 使用 JavaScript 事件(请参阅本页的在 JavaScript 中访问事件部分)
准备工作
您需要先按以下步骤操作,然后才能与嵌入式 iframe 进行交互:
向 iframe 添加 ID
之后,在从 iframe 中检索数据时,您需要验证您处理的信息是否确实来自 Looker 的 iframe。为了方便起见,请务必向您的 iframe 添加 ID(如果您尚未添加)。在以下示例中,您要通过向 iframe 添加 id="looker"
来将 ID 设置为 looker
:
<iframe id="looker" src="https://instance_name.looker.com/embed/dashboards/1"></iframe>
将嵌入网域添加到 iframe src
属性
在 iframe 的 src
属性中,添加使用该 iframe 的网域。在以下示例中,您可以在 src
属性中的网址末尾添加 ?embed_domain=https://myownpersonaldomain.com"
,从而将 myownpersonaldomain.com
指定为网域:
<iframe
id="looker"
src="https://instance_name.looker.com/embed/dashboards/1?embed_domain=https://myownpersonaldomain.com">
</iframe>
如果您使用的是签名嵌入,请务必将 embed_domain
添加到嵌入网址中。
如果您使用的是 Embed SDK,请将 sdk=2
添加到嵌入网址的末尾。sdk=2
参数表示该 SDK 存在,且 Looker 可以充分利用该 SDK 提供的其他功能,例如在 Looker iframe 和您的网域之间传递 JavaScript 事件。SDK 无法自行添加此参数,因为它是签名网址的一部分。例如:
<iframe
id="looker"
src="https://instance_name.looker.com/embed/dashboards/1?embed_domain=https://myownpersonaldomain.com&sdk=2">
</iframe>
将嵌入网域添加到许可名单
最后,您需要按照以下步骤,在 Looker 管理面板的嵌入页面中将使用了 iframe 的网域添加到许可名单中:
在嵌入式网域许可名单字段中,输入要使用 iframe 的网域,然后按 Tab 键,以使该网域显示在字段内的框中。
点击更新。
您可以使用许可名单中的 *
通配符创建网域模式。例如,https://*.myownpersonaldomain.com
将同时允许 https://analytics.myownpersonaldomain.com
和 https://data.myownpersonaldomain.com
。
如果您在 Looker 23.8 或更高版本中使用无 Cookie 嵌入,则可以在获取无 Cookie 会话时指定嵌入网域。这是使用管理 > 嵌入面板将嵌入网域添加到许可名单的替代方法。如果您决定使用此功能,请参阅安全最佳实践。
从 iframe 中检索数据
完成准备步骤后,您可以通过监听 postMessage
事件来访问在 Looker iframe 和您的网域之间传递的事件。
如本页的事件类型参考部分所述,嵌入式 iframe 可能会创建几种事件类型。
在 JavaScript 中访问事件
下例就展示了如何在原生 JavaScript 中监听这些事件,然后将其记录到控制台中:
window.addEventListener("message", function(event) {
if (event.source === document.getElementById("looker").contentWindow) {
if (event.origin === "https://instance_name.looker.com") {
console.log(JSON.parse(event.data));
}
}
});
以下示例展示了如何在 jQuery 中监听这些事件,然后将其记录到控制台中:
$(window).on("message", function(event) {
if (event.originalEvent.source === $("#looker")[0].contentWindow) {
if (event.origin === "https://instance_name.looker.com") {
console.log(JSON.parse(event.data));
}
}
});
事件类型摘要表
下表汇总了事件类型。选择事件类型,查看事件的详细信息。
事件类型 | 事件原因 |
---|---|
dashboard:loaded |
在功能块未设置为自动运行的信息中心上,信息中心及其元素已加载,但查询尚未运行。 |
dashboard:run:start |
信息中心已开始加载,其图块已开始加载和查询数据。 |
dashboard:run:complete |
信息中心已完成运行,并且所有功能块均已加载和查询完毕。 |
dashboard:download |
已开始下载信息中心 PDF 文件。 |
dashboard:edit:start |
ADD 22.20
信息中心已切换到修改模式。成功保存信息中心后,将触发 dashboard:save:complete 事件。 |
dashboard:edit:cancel |
ADD 22.20 处于修改模式的信息中心已退出修改模式且未保存。 |
dashboard:save:complete |
已修改并保存一个信息中心。 |
dashboard:delete:complete |
已删除信息中心。 |
dashboard:tile:start |
功能块已开始加载或查询数据。 |
dashboard:tile:complete |
功能块已完成查询运行。 |
dashboard:tile:download |
功能块数据已开始下载。 |
dashboard:tile:explore |
一位用户点击了信息中心图块中的从这里探索选项。 |
dashboard:tile:view |
用户点击了信息中心图块中的查看原始 Look 选项。 |
dashboard:filters:changed |
信息中心的过滤条件已被应用或更改。 |
look:ready |
Look 已开始加载查询数据,无论查询是否会运行。 |
look:run:start |
Look 已开始加载查询数据,并且该查询已开始运行。 |
look:run:complete |
Look 已完成运行查询。 |
look:save:complete |
已修改并保存一个 Look。 |
look:delete:complete |
一个 Look 已移至回收站文件夹中。 |
drillmenu:click |
一位用户点击了使用 link LookML 参数创建的信息中心内的深入分析菜单。 |
drillmodal:download |
一位用户从信息中心图块打开了一个深入分析对话框,然后点击了下载选项。 |
drillmodal:explore |
一位用户点击了深入分析对话框中的从这里探索选项。 |
explore:ready |
探索已开始加载查询数据,无论查询是否会运行。 |
explore:run:start |
“探索”部分已开始加载查询数据,且该查询开始运行。 |
explore:run:complete |
探索已完成查询运行。 |
explore:state:changed |
“探索”页面的网址已因用户操作而发生变化。 |
page:changed |
用户导航到了 iframe 中的新网页。 |
page:properties:changed |
信息中心 iframe 的高度已更改。 |
session:tokens |
Looker 客户端需要令牌才能继续。 |
session:status |
发送有关会话状态的信息。 |
env:client:dialog |
打开的对话框(例如深入分析对话框)可能部分不在视图范围内。此事件使托管应用能够将对话框滚动到视野范围内。 |
事件类型参考文档
嵌入式 iframe 可能会创建许多不同类型的事件:
dashboard:loaded
在图块未设置为自动运行的信息中心内,此事件在信息中心及其元素加载之后、查询运行之前创建。
type: "dashboard:loaded",
status: "complete",
dashboard: {
id: 1,
title: "Business Pulse",
canEdit: true,
dashboard_filters: {
"date": "Last 6 Years",
"state": ""
},
absoluteUrl: "https://self-signed.looker.com:9999/embed/dashboards/1?embed_domain=https%3A%2F%2Fself-signed.looker.com%3A9999&date=Last+6+Years&state=",
url: "/embed/dashboards/1?embed_domain=https%3A%2F%2Fself-signed.looker.com%3A9999&date=Last+6+Years&state=",
options: {
layouts: [
{
id: 1,
dashboard_id: 1,
type: "newspaper",
active: true,
column_width: null,
width: null,
deleted: false,
dashboard_layout_components: [
{
id: 1,
dashboard_layout_id: 1,
dashboard_element_id: 1,
row: 0,
column: 0,
width: 8,
height: 4,
deleted: false
},
{
id: 2,
dashboard_layout_id: 1,
dashboard_element_id: 2,
row: 0,
column: 8,
width: 8,
height: 4,
deleted: false
}
]
}
],
elements: {
1: {
title: "Total Orders",
title_hidden: false,
vis_config: {
type: "single_value",
font_size: "medium",
title: "Total Orders"
}
},
2: {
title: "Average Order Profit",
title_hidden: false,
vis_config: {
type: "single_value",
title: "Average Order Profit"
}
}
}
}
}
属性 | 形式 | 说明 |
---|---|---|
status |
字符串 | 指明信息中心及其元素是否已成功加载。 |
dashboard.id |
数字/字符串 | 信息中心的 ID。 |
dashboard.title |
字符串 | 标题,如信息中心的顶部所示。 |
dashboard.canEdit |
布尔值 |
ADD 22.20
true 后,用户可以修改信息中心。 |
dashboard.dashboard_filters |
对象 | 应用于信息中心的过滤条件。此对象的格式如下:{"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
dashboard.absoluteUrl |
字符串 | 完整的信息中心网址。 |
dashboard.url |
字符串 | 相对的信息中心网址(只是路径)。 |
dashboard.options |
对象 | 信息中心布局、信息中心布局组件以及信息中心元素属性和值。您可以使用 dashboard:options:set 事件为 options 对象中返回的所有属性提供更新后的值。 |
dashboard:run:start
此事件在信息中心开始加载时创建,此时其图块将开始加载和查询数据。
type: "dashboard:run:start",
dashboard: {
id: 23,
title: "My Dashboard",
canEdit: true,
url: "/embed/dashboards/...",
absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
dashboard_filters: {
"Date": "Last 28 days",
"Total Orders": "Greater than 100"
}
}
属性 | 形式 | 说明 |
---|---|---|
dashboard.id |
数字/字符串 | 信息中心的 ID。 |
dashboard.title |
字符串 | 标题,如信息中心的顶部所示。 |
dashboard.canEdit |
布尔值 |
ADD 22.20
true 后,用户可以修改信息中心。 |
dashboard.url |
字符串 | 相对的信息中心网址(只是路径)。 |
dashboard.absoluteUrl |
字符串 | 完整的信息中心网址。 |
dashboard.dashboard_filters |
对象 | 应用于信息中心的过滤条件。此对象的格式如下:{"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
dashboard:run:complete
当信息中心完成运行且所有功能块加载和查询均已完成时,系统将创建此事件。无论是否成功加载所有图块,都会创建此事件。
type: "dashboard:run:complete",
status: "complete",
dashboard: {
id: 23,
title: "My Dashboard",
canEdit: true,
url: "/embed/dashboards/...",
absoluteUrl: "https://my.looker.com/embed/dashboards/...",
dashboard_filters: {
"Date": "Last 28 days",
"Total Orders": "Greater than 100"
}
options: {
layouts: [
{
id: 1,
dashboard_id: 1,
type: "newspaper",
active: true,
column_width: null,
width: null,
deleted: false,
dashboard_layout_components: [
{
id: 1,
dashboard_layout_id: 1,
dashboard_element_id: 1,
row: 0,
column: 0,
width: 8,
height: 4,
deleted: false
},
{
id: 2,
dashboard_layout_id: 1,
dashboard_element_id: 2,
row: 0,
column: 8,
width: 8,
height: 4,
deleted: false
}
]
}
],
elements: {
1: {
title: "Total Orders",
title_hidden: false,
vis_config: {
type: "single_value",
font_size: "medium",
title: "Total Orders"
}
},
2: {
title: "Average Order Profit",
title_hidden: false,
vis_config: {
type: "single_value",
title: "Average Order Profit"
}
}
}
}
}
属性 | 形式 | 说明 |
---|---|---|
status |
字符串 | 指明信息中心及其元素是否已成功运行。如果信息中心及其元素成功运行,则 status 会返回 "complete" ;否则,status 会返回 "error" 。如果正在运行的信息中心是通过界面或通过 dashboard:stop 操作停止的,status 将返回 "stopped" 。 |
dashboard.id |
数字/字符串 | 信息中心的 ID。 |
dashboard.title |
字符串 | 标题,如信息中心的顶部所示。 |
dashboard.canEdit |
布尔值 |
ADD 22.20
true 后,用户可以修改信息中心。 |
dashboard.url |
字符串 | 相对的信息中心网址(只是路径)。 |
dashboard.absoluteUrl |
字符串 | 完整的信息中心网址。 |
dashboard.dashboard_filters |
对象 | 应用于信息中心的过滤条件。此对象的格式如下:{"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
dashboard.options |
对象 | 信息中心布局、信息中心布局组件以及信息中心元素属性和值。您可以使用 dashboard:options:set 操作为 options 对象中返回的所有属性提供更新后的值。 |
dashboard.tileStatuses |
对象数组 | 提供图块状态的对象数组。对象属性包括:
|
dashboard:download
当信息中心的 PDF 文件开始下载时,系统就会创建此事件。
type: "dashboard:download",
dashboard: {
id: 23,
title: "My Dashboard",
canEdit: true,
url: "/embed/dashboards/...",
absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
dashboard_filters: {
"Date": "Last 28 days",
"Total Orders": "Greater than 100"
}
}
fileFormat: "pdf"
属性 | 形式 | 说明 |
---|---|---|
dashboard.id |
数字/字符串 | 信息中心的 ID。 |
dashboard.title |
字符串 | 标题,如信息中心的顶部所示。 |
dashboard.canEdit |
布尔值 |
ADD 22.20
true 后,用户可以修改信息中心。 |
dashboard.url |
字符串 | 相对的信息中心网址(只是路径)。 |
dashboard.absoluteUrl |
字符串 | 完整的信息中心网址。 |
dashboard.dashboard_filters |
对象 | 应用于信息中心的过滤条件。此对象的格式如下:{"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
fileFormat |
字符串 | 下载信息中心的格式(目前只有 "pdf" )。 |
dashboard:edit:start
ADD 22.20 当信息中心切换到修改模式时,系统会创建此事件。
type: "dashboard:edit:start",
dashboard: {
id: 23,
title: "My Dashboard",
canEdit: true,
url: "/embed/dashboards/...",
absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
dashboard_filters: {
"Date": "Last 28 days",
"Total Orders": "Greater than 100"
}
}
属性 | 形式 | 说明 |
---|---|---|
dashboard.id |
数字/字符串 | 信息中心的 ID。 |
dashboard.title |
字符串 | 标题,如信息中心的顶部所示。 |
dashboard.canEdit |
布尔值 |
ADD 22.20
true 后,用户可以修改信息中心。 |
dashboard.url |
字符串 | 相对的信息中心网址(只是路径)。 |
dashboard.absoluteUrl |
字符串 | 完整的信息中心网址。 |
dashboard.dashboard_filters |
对象 | 应用于信息中心的过滤条件。此对象的格式如下:{"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
dashboard:edit:cancel
ADD 22.20 当处于修改模式的信息中心退出修改模式且未保存时,系统会创建此事件。
type: "dashboard:edit:cancel",
dashboard: {
id: 23,
title: "My Dashboard",
canEdit: true,
url: "/embed/dashboards/...",
absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
dashboard_filters: {
"Date": "Last 28 days",
"Total Orders": "Greater than 100"
}
}
属性 | 形式 | 说明 |
---|---|---|
dashboard.id |
数字/字符串 | 信息中心的 ID。 |
dashboard.title |
字符串 | 标题,如信息中心的顶部所示。 |
dashboard.canEdit |
布尔值 |
ADD 22.20
true 后,用户可以修改信息中心。 |
dashboard.url |
字符串 | 相对的信息中心网址(只是路径)。 |
dashboard.absoluteUrl |
字符串 | 完整的信息中心网址。 |
dashboard.dashboard_filters |
对象 | 应用于信息中心的过滤条件。此对象的格式如下:{"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
dashboard:save:complete
当您修改并保存信息中心时,系统就会创建此事件。
type: "dashboard:save:complete",
dashboard: {
id: 23,
title: "My Dashboard",
canEdit: true,
dashboard_filters: {
"Date": "Last 28 days",
"Total Orders": "Greater than 100"
}
absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
url: "/embed/dashboards/...",
options: {
layouts: [
{
id: 1,
dashboard_id: 1,
type: "newspaper",
active: true,
column_width: null,
width: null,
deleted: false,
dashboard_layout_components: [
{
id: 1,
dashboard_layout_id: 1,
dashboard_element_id: 1,
row: 0,
column: 0,
width: 8,
height: 4,
deleted: false
},
{
id: 2,
dashboard_layout_id: 1,
dashboard_element_id: 2,
row: 0,
column: 8,
width: 8,
height: 4,
deleted: false
}
]
}
],
elements: {
1: {
title: "Total Orders",
title_hidden: false,
vis_config: {
type: "single_value",
font_size: "medium",
title: "Total Orders"
}
},
2: {
title: "Average Order Profit",
title_hidden: false,
vis_config: {
type: "single_value",
title: "Average Order Profit"
}
}
}
}
}
属性 | 形式 | 说明 |
---|---|---|
dashboard.id |
数字/字符串 | 信息中心的 ID。 |
dashboard.title |
字符串 | 标题,如信息中心的顶部所示。 |
dashboard.canEdit |
布尔值 |
ADD 22.20
true 后,用户可以修改信息中心。 |
dashboard.dashboard_filters |
对象 | 应用于信息中心的过滤条件。此对象的格式如下:{"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
dashboard.absoluteUrl |
字符串 | 完整的信息中心网址。 |
dashboard.url |
字符串 | 相对的信息中心网址(只是路径)。 |
dashboard.options |
对象 | 信息中心布局、信息中心布局组件以及信息中心元素属性和值。您可以使用 dashboard:options:set 事件为 options 对象中返回的所有属性提供更新后的值。 |
dashboard:delete:complete
当删除信息中心时,系统会创建此事件。
type: "dashboard:delete:complete",
dashboard: {
id: 23,
title: "My Dashboard",
canEdit: true,
dashboard_filters: {
"Date": "Last 28 days",
"Total Orders": "Greater than 100"
}
absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
url: "/embed/dashboards/...",
options: {
layouts: [
{
id: 1,
dashboard_id: 1,
type: "newspaper",
active: true,
column_width: null,
width: null,
deleted: false,
dashboard_layout_components: [
{
id: 1,
dashboard_layout_id: 1,
dashboard_element_id: 1,
row: 0,
column: 0,
width: 8,
height: 4,
deleted: false
},
{
id: 2,
dashboard_layout_id: 1,
dashboard_element_id: 2,
row: 0,
column: 8,
width: 8,
height: 4,
deleted: false
}
]
}
],
elements: {
1: {
title: "Total Orders",
title_hidden: false,
vis_config: {
type: "single_value",
font_size: "medium",
title: "Total Orders"
}
},
2: {
title: "Average Order Profit",
title_hidden: false,
vis_config: {
type: "single_value",
title: "Average Order Profit"
}
}
}
}
}
属性 | 形式 | 说明 |
---|---|---|
dashboard.id |
数字/字符串 | 信息中心的 ID。 |
dashboard.title |
字符串 | 标题,如信息中心的顶部所示。 |
dashboard.canEdit |
布尔值 |
ADD 22.20
true 后,用户可以修改信息中心。 |
dashboard.dashboard_filters |
对象 | 应用于信息中心的过滤条件。此对象的格式如下:{"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
dashboard.absoluteUrl |
字符串 | 完整的信息中心网址。 |
dashboard.url |
字符串 | 相对的信息中心网址(只是路径)。 |
dashboard.options |
对象 | 信息中心布局、信息中心布局组件以及信息中心元素属性和值。您可以使用 dashboard:options:set 事件为 options 对象中返回的所有属性提供更新后的值。 |
dashboard:tile:start
当功能块开始加载或查询数据时,系统会创建此事件。
type: "dashboard:tile:start",
dashboard: {
id: 23,
title: "My Dashboard",
canEdit: true,
url: "/embed/dashboards/...",
absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
dashboard_filters: {
"Date": "Last 28 days",
"Total Orders": "Greater than 100"
}
}
tile: {
id: 123,
title: "Quarterly Sales",
listen: {
"Date": "order.date",
"Total Orders": "order.count"
}
}
属性 | 形式 | 说明 |
---|---|---|
dashboard.id |
数字/字符串 | 图块所属的信息中心的 ID。 |
dashboard.title |
字符串 | 信息中心标题,如图块所属的信息中心顶部所示。 |
dashboard.canEdit |
布尔值 |
ADD 22.20
true 后,用户可以修改信息中心。 |
dashboard.url |
字符串 | 图块所属的相对信息中心网址(只是路径)。 |
dashboard.absoluteUrl |
字符串 | 图块所属的完整信息中心网址。 |
dashboard.dashboard_filters |
对象 | 应用于功能块所属信息中心的过滤条件。此对象的格式如下:{"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
tile.id |
整数 | 事件(而非功能块)的 ID 号。 |
tile.title |
字符串 | 功能块标题,如功能块顶部所示。 |
tile.listen |
对象 | 全局信息中心过滤条件与此图块监听。此对象的格式如下:{"Filter Label": "Filter Field", ...} |
dashboard:tile:complete
当功能块运行完查询后,系统会创建此事件。
type: "dashboard:tile:complete",
dashboard: {
id: 23,
title: "My Dashboard",
canEdit: true,
url: "/embed/dashboards/...",
absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
dashboard_filters: {
"Date": "Last 28 days",
"Total Orders": "Greater than 100"
}
}
status: "complete",
truncated: false,
tile: {
id: 123,
title: "Quarterly Sales",
listen: {
"Date": "order.date",
"Total Orders": "order.count"
}
}
属性 | 形式 | 说明 |
---|---|---|
dashboard.id |
数字/字符串 | 图块所属的信息中心的 ID。 |
dashboard.title |
字符串 | 信息中心标题,如图块所属的信息中心顶部所示。 |
dashboard.canEdit |
布尔值 |
ADD 22.20
true 后,用户可以修改信息中心。 |
dashboard.url |
字符串 | 图块所属的相对信息中心网址(只是路径)。 |
dashboard.absoluteUrl |
字符串 | 图块所属的完整信息中心网址。 |
dashboard.dashboard_filters |
对象 | 应用于功能块所属信息中心的过滤条件。此对象的格式如下:{"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
status |
字符串 | 功能块查询是否成功完成。可能的值是 "complete" 或 "error" 。 |
truncated |
布尔值 | 功能块查询结果是否因查询返回的行数超过查询行数上限而被截断。行数上限可以是用户指定的行数上限,也可以是 Looker 默认行数上限(5,000)。 |
tile.id |
整数 | 事件(而非功能块)的 ID 号。 |
tile.title |
字符串 | 功能块标题,如功能块顶部所示。 |
tile.listen |
对象 | 全局信息中心过滤条件与此图块监听。此对象的格式如下:{"Filter Label": "Filter Field", ...} |
tile.errors |
对象数组 | 在 status 属性为 "error" 时填充。提供错误详情的对象数组,包括错误消息文本、更详细的错误说明以及产生错误的图块的 SQL 查询。 |
dashboard:tile:download
此事件在功能块的数据开始下载时创建。
type: "dashboard:tile:download",
dashboard: {
id: 23,
title: "My Dashboard",
canEdit: true,
url: "/embed/dashboards/...",
absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
dashboard_filters: {
"Date": "Last 28 days",
"Total Orders": "Greater than 100"
}
}
tile: {
id: 123,
title: "Quarterly Sales"
listen: {
"Date": "order.date",
"Total Orders": "order.count"
}
}
fileFormat: "pdf"
属性 | 形式 | 说明 |
---|---|---|
dashboard.id |
数字/字符串 | 图块所属的信息中心的 ID。 |
dashboard.title |
字符串 | 信息中心标题,如图块所属的信息中心顶部所示。 |
dashboard.canEdit |
布尔值 |
ADD 22.20
true 后,用户可以修改信息中心。 |
dashboard.url |
字符串 | 图块所属的相对信息中心网址(只是路径)。 |
dashboard.absoluteUrl |
字符串 | 图块所属的完整信息中心网址。 |
dashboard.dashboard_filters |
对象 | 应用于功能块所属信息中心的过滤条件。此对象的格式如下:{"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
tile.id |
整数 | 事件(而非功能块)的 ID 号。 |
tile.title |
字符串 | 功能块标题,如功能块顶部所示。 |
tile.listen |
对象 | 全局信息中心过滤条件与此图块监听。此对象的格式如下:{"Filter Label": "Filter Field", ...} |
fileFormat |
字符串 | 下载的功能块的格式(目前只有 "pdf" )。 |
dashboard:tile:explore
当用户点击信息中心图块中的从这里探索选项时,系统就会创建此事件。
type: "dashboard:tile:explore",
label: 'Explore From Here',
url: '/embed/explore/model/view...',
dashboard: {
id: 23,
title: "My Dashboard",
canEdit: true,
url: "/embed/dashboards/...",
absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
dashboard_filters: {
"Date": "Last 28 days",
"Total Orders": "Greater than 100"
}
}
tile: {
id: 123,
title: "Quarterly Sales",
listen: {
"Date": "order.date",
"Total Orders": "order.count"
}
}
属性 | 形式 | 说明 |
---|---|---|
label |
字符串 | 按钮标签。 |
url |
字符串 | 要查看的探索的相对网址(只是路径)。 |
dashboard.id |
数字/字符串 | 图块所属的信息中心的 ID。 |
dashboard.title |
字符串 | 信息中心标题,如图块所属的信息中心顶部所示。 |
dashboard.canEdit |
布尔值 |
ADD 22.20
true 后,用户可以修改信息中心。 |
dashboard.url |
字符串 | 图块所属的相对信息中心网址(只是路径)。 |
dashboard.absoluteUrl |
字符串 | 图块所属的完整信息中心网址。 |
dashboard.dashboard_filters |
对象 | 应用于功能块所属信息中心的过滤条件。此对象的格式如下:{"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
tile.id |
整数 | 事件(而非功能块)的 ID 号。 |
tile.title |
字符串 | 功能块标题,如功能块顶部所示。 |
tile.listen |
对象 | 全局信息中心过滤条件与此图块监听。此对象的格式如下:{"Filter Label": "Filter Field", ...} |
dashboard:tile:view
当用户点击信息中心图块中的查看原始 Look 选项时,系统就会创建此事件。
type: "dashboard:tile:view",
label: 'View Original Look',
url: '/embed/look/...',
dashboard: {
id: 23,
title: "My Dashboard",
canEdit: true,
url: "/embed/dashboards/...",
absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
dashboard_filters: {
"Date": "Last 28 days",
"Total Orders": "Greater than 100"
}
}
tile: {
id: 123,
title: "Quarterly Sales",
listen: {
"Date": "order.date",
"Total Orders": "order.count"
}
}
属性 | 形式 | 说明 |
---|---|---|
label |
字符串 | 按钮标签。 |
url |
字符串 | 要查看的 Look 的相对网址(只是路径)。 |
dashboard.id |
数字/字符串 | 图块所属的信息中心的 ID。 |
dashboard.title |
字符串 | 信息中心标题,如图块所属的信息中心顶部所示。 |
dashboard.canEdit |
布尔值 |
ADD 22.20
true 后,用户可以修改信息中心。 |
dashboard.url |
字符串 | 图块所属的相对信息中心网址(只是路径)。 |
dashboard.absoluteUrl |
字符串 | 图块所属的完整信息中心网址。 |
dashboard.dashboard_filters |
对象 | 应用于功能块所属信息中心的过滤条件。此对象的格式如下:{"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
tile.id |
整数 | 事件(而非功能块)的 ID 号。 |
tile.title |
字符串 | 功能块标题,如功能块顶部所示。 |
tile.listen |
对象 | 全局信息中心过滤条件与此图块监听。此对象的格式如下:{"Filter Label": "Filter Field", ...} |
dashboard:filters:changed
应用或更改信息中心的过滤条件时,系统会创建此事件。
type: "dashboard:filters:changed",
dashboard: {
id: 23,
title: "My Dashboard",
canEdit: true,
url: "/embed/dashboards/...",
absoluteUrl: "https://instance_name.looker.com/embed/dashboards/...",
dashboard_filters: {
"Date": "Last 28 days",
"Total Orders": "Greater than 100"
}
options: {
layouts: [
{
id: 1,
dashboard_id: 1,
type: "newspaper",
active: true,
column_width: null,
width: null,
deleted: false,
dashboard_layout_components: [
{
id: 1,
dashboard_layout_id: 1,
dashboard_element_id: 1,
row: 0,
column: 0,
width: 8,
height: 4,
deleted: false
},
{
id: 2,
dashboard_layout_id: 1,
dashboard_element_id: 2,
row: 0,
column: 8,
width: 8,
height: 4,
deleted: false
}
]
}
],
elements: {
1: {
title: "Total Orders",
title_hidden: false,
vis_config: {
type: "single_value",
font_size: "medium",
title: "Total Orders"
}
},
2: {
title: "Average Order Profit",
title_hidden: false,
vis_config: {
type: "single_value",
title: "Average Order Profit"
}
}
}
}
}
属性 | 形式 | 说明 |
---|---|---|
dashboard.id |
数字/字符串 | 信息中心的 ID。 |
dashboard.title |
字符串 | 标题,如信息中心的顶部所示。 |
dashboard.canEdit |
布尔值 |
ADD 22.20
true 后,用户可以修改信息中心。 |
dashboard.url |
字符串 | 相对的信息中心网址(只是路径)。 |
dashboard.absoluteUrl |
字符串 | 完整的信息中心网址。 |
dashboard.dashboard_filters |
对象 | 应用于信息中心的过滤条件。此对象的格式如下:{"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
dashboard.options |
对象 | 信息中心布局、信息中心布局组件以及信息中心元素属性和值。您可以使用 dashboard:options:set 事件为 options 对象中返回的所有属性提供更新后的值。 |
look:ready
当 Look 开始加载查询数据时,无论是否运行查询,都会创建此事件。
type: "look:ready",
look: {
url: "/embed/looks/...",
absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
}
}
属性 | 形式 | 说明 |
---|---|---|
look.url |
字符串 | 相对 Look 网址(即路径) |
look.absoluteUrl |
字符串 | 完整的 Look 网址 |
look:run:start
当 Look 开始加载查询数据并且查询开始运行时,系统就会创建此事件。
type: "look:run:start",
look: {
url: "/embed/looks/...",
absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
}
}
属性 | 形式 | 说明 |
---|---|---|
look.url |
字符串 | 相对 Look 网址(即路径) |
look.absoluteUrl |
字符串 | 完整的 Look 网址 |
look:run:complete
当 Look 运行完查询后,系统就会创建此事件。
type: look:run:complete
look: {
url: "/embed/looks/...",
absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
}
}
属性 | 形式 | 说明 |
---|---|---|
look.url |
字符串 | 相对 Look 网址(即路径) |
look.absoluteUrl |
字符串 | 完整的 Look 网址 |
look:save:complete
系统会在修改并保存 Look 时创建此事件。当用户执行以下某项任务时,系统就会创建此事件:
- 点击 Edit 按钮以修改 Look,然后点击保存
- 使用 Save > Save as... 菜单选项保存 Look
- 将 Look 从一个文件夹移动到另一个文件夹
如果使用保存 > 保存到现有信息中心或修改设置菜单选项保存 Look,则不会创建此事件。
type: look:save:complete
look: {
url: "/embed/looks/...",
absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
spaceId: 123
}
}
属性 | 形式 | 说明 |
---|---|---|
look.url |
字符串 | 相对 Look 网址(即路径) |
look.absoluteUrl |
字符串 | 完整的 Look 网址 |
look.spaceID |
整数 | 存储该 Look 的文件夹 ID |
look:delete:complete
当 Look 移至回收站文件夹时,系统就会创建此事件。
type: look:delete:complete
look: {
url: "/embed/looks/...",
absoluteUrl: "https://instance_name.looker.com/embed/looks/...",
}
}
属性 | 形式 | 说明 |
---|---|---|
look.url |
字符串 | 相对 Look 网址(即路径) |
look.absoluteUrl |
字符串 | 完整的 Look 网址 |
drillmenu:click
当用户点击使用 link
LookML 参数创建的信息中心内的深入分析菜单时,系统就会创建此事件。例如,以下 LookML 创建了一个深入分析菜单,用户可以在其中查看按 state
维度过滤的数据:
dimension: state {
type: string
sql: ${TABLE}.state ;;
link: {
label: "Filter by {{ state | encode_uri }}"
url: "filter::q={{ state | encode_uri }}"
icon_url: "https://google.com/favicon.ico"
}
}
当 state
过滤条件设置为 Illinois
时,drillmenu:click
事件会向 iframe 的主机返回以下内容:
type: "drillmenu:click",
label: "Filter by Illinois",
link_type: "url",
modal: false,
target: '_self',
url: "#filter::state=Illinois"
context: ' '
属性 | 形式 | 说明 |
---|---|---|
label |
字符串 | 深入分析菜单上显示的链接标签 |
link_type |
字符串 | 链接目标的对象类型 |
modal |
布尔值 | 是否使用深入分析对话框而非浏览器导航 |
target |
字符串 | 如果链接目标页面将替换当前的 iframe,则为 _self ;如果链接目标页面会打开一个新窗口,则为 _blank |
url |
字符串 | 链接目标的网址 |
context |
字符串 | 某些类型的可视化图表使用的内部属性 |
在 iframe 中沙盒化可阻止展开细目菜单点击操作在新窗口中打开。在 iframe 代码内使用以下沙盒值:
sandbox = "allow-same-origin allow-scripts"
drillmodal:download
当用户从信息中心图块打开深入分析对话框并点击下载选项时,即会创建此事件。
{
type: "drillmodal:download",
dashboard: {
id: 23,
title: "My Dashboard",
url: "/embed/dashboards/…",
absoluteUrl: "https://instance_name.looker.com/embed/dashboards/…",
dashboard_filters: {
"Date": "Last 28 days",
"Total Orders": "Greater than 100"
}
}
drillExploreUrl: "/embed...",
fileFormat: "pdf"
}
属性 | 形式 | 说明 |
---|---|---|
dashboard.id |
数字/字符串 | 图块所属的信息中心的 ID。 |
dashboard.title |
字符串 | 信息中心标题,如图块所属的信息中心顶部所示。 |
dashboard.url |
字符串 | 图块所属的相对信息中心网址(只是路径)。 |
dashboard.absoluteUrl |
字符串 | 图块所属的完整信息中心网址。 |
dashboard.dashboard_filters |
对象 | 应用于功能块所属信息中心的过滤条件。此对象的格式如下:{"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
drillExploreUrl |
字符串 | 要下载的相对探索网址(仅路径)。 |
fileFormat |
字符串 | 数据下载的文件格式。 |
drillmodal:explore
当用户点击深入分析对话框中的从这里探索选项时,即会创建此事件。
type: "drillmodal:explore",
label: "Explore From Here",
url: "/embed/explore/model/view..."
属性 | 形式 | 说明 |
---|---|---|
label |
字符串 | 深入分析菜单上显示的按钮标签 |
url |
字符串 | 要查看的相对探索网址(仅路径) |
explore:ready
当探索开始加载查询数据时,无论查询是否运行,都会创建此事件。
type: "explore:ready",
explore: {
url: "/embed/explore/...",
absoluteUrl: "https://instance_name.looker.com/embed/explore/...",
}
}
属性 | 形式 | 说明 |
---|---|---|
explore.url |
字符串 | 相对的“探索”网址(即路径) |
explore.absoluteUrl |
字符串 | 完整的“探索”网址 |
explore:run:start
当探索开始加载查询数据且查询开始运行时,系统会创建此事件。
type: "explore:run:start",
explore: {
url: "/embed/explore/...",
absoluteUrl: "https://instance_name.looker.com/embed/explore/...",
}
}
属性 | 形式 | 说明 |
---|---|---|
explore.url |
字符串 | 相对的“探索”网址(即路径) |
explore.absoluteUrl |
字符串 | 完整的“探索”网址 |
explore:run:complete
当探索运行完查询后,系统就会创建此事件。
type: "explore:run:complete",
explore: {
url: "/embed/explore/...",
absoluteUrl: "https://instance_name.looker.com/embed/explore/...",
}
}
属性 | 形式 | 说明 |
---|---|---|
explore.url |
字符串 | 相对的“探索”网址(即路径) |
explore.absoluteUrl |
字符串 | 完整的“探索”网址 |
explore:state:changed
当“探索”页面的网址因用户的操作而发生变化时,系统就会创建此事件。
type: "explore:state:changed",
explore: {
url: "/embed/explore/...",
absoluteUrl: "https://instance_name.looker.com/embed/explore/..."
}
属性 | 形式 | 说明 |
---|---|---|
explore.url |
字符串 | 相对的“探索”网址(即路径) |
explore.absoluteUrl |
字符串 | 完整的“探索”网址 |
page:changed
当用户导航到 iframe 中的新网页时,系统就会创建此事件。
type: "page:changed",
page: {
type: "dashboard",
url: "/embed/dashboards/...",
absoluteUrl: "https://instance_name.looker.com/embed/dashboards/..."
}
属性 | 形式 | 说明 |
---|---|---|
page.type |
字符串 | 用户刚刚转到的网页类型,例如 "dashboard" 、"look" 或 "explore" |
page.url |
字符串 | 刚刚被导航到的网页的相对网址(只是路径) |
page.absoluteUrl |
字符串 | 刚刚转到的网页的完整网址 |
page:properties:changed
当信息中心 iframe 的高度发生变化时,系统就会创建此事件。它不适用于 Look 或探索,因为这些项目会自动根据 iframe 的大小调整其高度。
type: "page:properties:changed",
height: 1000
属性 | 形式 | 说明 |
---|---|---|
height |
整数 | 信息中心 iframe 的高度(以像素为单位) |
session:tokens
此事件表示 Looker 客户端需要令牌才能继续。此事件在创建 iframe 后立即创建,并在会话期间定期创建。
{
"type": "session:tokens",
"api_token": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL3NlbGYtc2lnbmVkLmxvb2tlci5jb206OTk5OSIsImV4cCI6MTY3MDYyNjMzMCwic3ViIjoiYVdrNWFGUzM4RnRwNzFFWXhuS3ZaMXdKRmV3ZjB2VzYtTV9zLWtCcHE1dXIiLCJ0b2tlbl90eXBlIjoiYXBpX3Rva2VuIiwicmFuZG9taXplciI6IkxjYnpOeDNTVjNOb3o3UVlqTVJjNmhlMkdodjh1a2UwWUhiZWNRMHVCYm1KIn0.CBv1__QGc_H7bKNe31SHMMQCsc5ya1xOiEv1UDWAyxM",
"api_token_ttl": 463,
"navigation_token": "eyJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJodHRwczovL3NlbGYtc2lnbmVkLmxvb2tlci5jb206OTk5OSIsImV4cCI6MTY3MDYyNjMzMCwic3ViIjoiYVdrNWFGUzM4RnRwNzFFWXhuS3ZaMXdKRmV3ZjB2VzYtTV9zLWtCcHE1dXIiLCJ0b2tlbl90eXBlIjoibmF2aWdhdGlvbl90b2tlbiIsInJhbmRvbWl6ZXIiOiJHVVNlc00tdTRPRDlNdktodFJDU2pEcVFhUkJNeTh5dm42Q1FDUXhuLTNxMiJ9.sWo7LUEI5LeragVmeDamUR7u2myXpFJ0aqK_IIALUqI",
"navigation_token_ttl": 463,
"session_reference_token_ttl": 2924
}
属性 | 形式 | 说明 |
---|---|---|
authentication_token |
字符串 | 身份验证令牌。在创建 iframe 时包含。不包含在对生成令牌的请求的响应中或会话已过期。 |
authentication_token_ttl |
数字 | 身份验证令牌存留时间(以秒为单位)。在创建 iframe 时包含。不包含在对生成令牌的请求的响应中或会话已过期。 |
api_token |
字符串 | API 令牌。如果会话已过期,则不会包含在内。 |
api_token_ttl |
数字 | API 令牌存留时间(以秒为单位)。如果会话已过期,则不会包含在内。 |
navigation_token |
字符串 | 导航令牌。如果会话已过期,则不会包含在内。 |
navigation_token_ttl |
数字 | 导航令牌存留时间(以秒为单位)。如果会话已过期,则不会包含在内。 |
session_references_token_ttl |
数字 | 会话存留时间(以秒为单位)。会话过期时,此值将为 0。要恢复,嵌入应用必须获取新的会话。 |
session:status
当嵌入式 Looker 应用处理会话令牌请求时,系统就会生成该事件。
{
"type": "session:status",
"session_ttl": 0,
"expired": true,
"interrupted": false
}
属性 | 形式 | 说明 |
---|---|---|
session_ttl |
数字 | 会话存留时间(以秒为单位)。 |
expired |
布尔值 | 如果为 true ,则表示会话已过期。 |
interrupted |
布尔值 | 如果为 true ,则表示会话令牌请求未得到响应。这可能表示服务器暂时不可用。 |
recoverable |
布尔值 | 只有在中断时填充的是 true 。指示是否可以恢复会话。值为 false 可能表示嵌入应用存在问题。 |
env:client:dialog
当打开的对话框(例如,深入分析对话框)可能部分不可见时,就会生成该事件。此事件使托管应用能够通过 env:host:scroll
操作将对话框滚动到视野范围内。
{
type: "env:client:dialog",
dialogType: 'drilling',
placement: 'cover',
open: true
}
属性 | 形式 | 说明 |
---|---|---|
type |
字符串 | env:client:dialog 表示对话框已打开或关闭。目前仅支持深入分析对话框,但将来可能会添加其他对话框。深入分析对话框的顶部可能未显示在视图中,因为该对话框覆盖了 iframe 视口。此事件允许托管应用滚动到对话框顶部。 |
dialogType |
字符串 | 对话框的类型。目前,只有打开或关闭“深入分析”对话框类型才会触发此事件。 |
placement |
字符串 | 对话框的位置。“深入分析”类型的对话框始终使用“封面”placement 。 |
open |
布尔值 | 指示对话框是打开还是滚动的。 |
更改 iframe
准备好进行数据检索的 iframe 后,您可以按照以下步骤对 iframe 进行更改:
使用 JSON 编写请求
您可以对 iframe 进行一些更改,并以 JSON 格式提交这些更改。本页的操作参考文档部分介绍了可用的选项。不要忘记使用 JSON.stringify
将您的操作转换为 JSON,如下所示:
var my_request = JSON.stringify(
{
type: "dashboard:run"
}
);
将请求发布到 iframe 的 contentWindow
属性
最后,将消息发布到 iframe 的 contentWindow
,如下所示:
var my_iframe = document.getElementById("my_iframe_id");
my_iframe.contentWindow.postMessage(my_request, 'https://instance_name.looker.com');
操作摘要表格
下表总结了这些操作。选择一项操作即可查看有关该操作的详细信息。
操作 | 操作说明 |
---|---|
dashboard:load |
在 iframe 中加载新的信息中心,替换现有信息中心。 |
dashboard:run |
在 iframe 中运行信息中心。 |
dashboard:edit |
ADD 22.20 将信息中心切换到修改模式。 |
dashboard:filters:update |
更新 iframe 中现有的信息中心过滤条件。 |
dashboard:options:set |
将新值写入信息中心布局和信息中心元素属性。 |
dashboard:schedule_modal:open |
打开调度器,允许用户将 Looker 内容传送到各种目标位置。 |
dashboard:stop |
停止正在运行或重新加载数据的信息中心。 |
look:run |
在 iframe 中运行 Look。 |
look:filters:update |
更新 iframe 中现有的 Look 过滤器。 |
explore:run |
在 iframe 中运行探索。 |
explore:filters:update |
更新或移除 iframe 中现有的“探索”过滤条件。 |
session:tokens:request |
发送令牌以响应 session:tokens:request 事件。 |
env:host:scroll |
将有关主机 iframe 当前滚动位置的信息发送到嵌入式 Looker 应用。 |
操作参考文档
以下是您可发布到嵌入式 iframe 中的操作:
dashboard:load
执行此操作可在 iframe 中加载新信息中心,替换现有信息中心。新的信息中心将开始执行查询,就像打开新的信息中心页面一样。
{
type: "dashboard:load",
id: "101",
pushHistory: false
}
属性 | 形式 | 说明 |
---|---|---|
type |
字符串 | 使用 dashboard:load 类型表示要将新信息中心加载到 iframe 中。 |
id |
字符串 | 要加载的信息中心的 ID。 |
pushHistory |
布尔值 | 如果为 true ,则加载的信息中心会创建新的浏览器历史记录条目,并且用户可以使用浏览器的返回按钮返回到上一个信息中心。如果为 false ,系统会替换当前信息中心,且无法使用浏览器导航返回该信息中心。 |
dashboard:run
使用此操作在 iframe 中运行信息中心。此操作与点击信息中心内的运行或重新加载数据按钮相同。
{
type: "dashboard:run"
}
属性 | 形式 | 说明 |
---|---|---|
type |
字符串 | 使用 dashboard:run 类型表示您要运行信息中心。 |
dashboard:edit
ADD 22.20 使用此操作可将 iframe 中的现有信息中心切换到修改模式。此操作与从信息中心菜单中选择修改信息中心相同。
{
type: "dashboard:edit"
}
属性 | 形式 | 说明 |
---|---|---|
type |
字符串 | 使用 dashboard:edit 类型表示要将信息中心切换到修改模式。 |
dashboard:filters:update
执行此操作可更新 iframe 中现有的信息中心过滤条件。您无法使用此方法向信息中心添加新的过滤器。
{
type: "dashboard:filters:update",
filters: {
"Sale date": "Last 28 days",
"Sale amount": "Greater than 100"
}
}
属性 | 形式 | 说明 |
---|---|---|
type |
字符串 | 使用 dashboard:filters:update 类型表示您想要更新信息中心使用的过滤条件。 |
filters |
对象 | 您要应用到信息中心的新过滤条件。此对象的格式如下:{"Filter name 1": "value 1", "Filter name 2": "value 2", ...} |
dashboard:options:set
此操作在 dashboard:run:complete
事件发生后可用。
嵌入器会创建消息并将其发送至 iframe,但直到发生 dashboard:run:complete
后,信息中心才会响应。dashboard:options:set
操作会将新值写入信息中心布局和信息中心元素属性。只有 dashboard:run:complete
事件的 options
属性中已返回的属性才能使用 dashboard:options:set
更新。系统会忽略 dashboard:run:complete
事件的 options
属性之前未返回的任何属性集。
{
type: "dashboard:options:set",
layouts: [
{
id: 1,
dashboard_id: 1,
type: "newspaper",
active: true,
column_width: null,
width: null,
deleted: false,
dashboard_layout_components: [
{
id: 1,
dashboard_layout_id: 1,
dashboard_element_id: 1,
row: 0,
column: 0,
width: 8,
height: 4,
deleted: false
},
{
id: 2,
dashboard_layout_id: 1,
dashboard_element_id: 2,
row: 0,
column: 8,
width: 8,
height: 4,
deleted: false
}
]
}
],
elements: {
1: {
title: "Total Orders",
title_hidden: false,
vis_config: {
type: "single_value",
font_size: "medium",
title: "Total Orders"
}
},
2: {
title: "Average Order Profit",
title_hidden: false,
vis_config: {
type: "single_value",
title: "Average Order Profit"
}
}
}
}
属性 | 形式 | 说明 |
---|---|---|
type |
字符串 | 使用 dashboard:options:set 类型表示您要向信息中心布局和信息中心元素属性写入新值。 |
layouts |
对象 | dashboard:run:complete 事件中的 options 属性返回的信息中心布局属性。其格式类似于:
|
layouts.dashboard_layout_components |
对象 | dashboard:run:complete 事件中的 options 属性返回的一个或多个信息中心布局组件对象。其格式类似于:
|
elements |
对象 | dashboard:run:complete 事件中的 options 属性返回的一个或多个信息中心元素对象。其格式类似于:id: { title: "string", title_hidden: boolean, vis_config: { type: "string", title: "string" }} |
dashboard:schedule_modal:open
执行此操作可打开调度器,以便用户将 Looker 内容传送到各种目标位置。
{
type: "dashboard:schedule_modal:open"
}
属性 | 形式 | 说明 |
---|---|---|
type |
字符串 | 使用 dashboard:schedule_modal:open 类型表示您要打开 Schedule 对话框。 |
dashboard:stop
使用此方法可停止正在运行的信息中心或重新加载数据的信息中心。此操作与点击信息中心内的取消按钮相同。停止使用 dashboard:stop
的信息中心会发送 dashboard:run:complete
事件,并将 status:
设置为 "stopped"
。
{
type: "dashboard:stop"
}
属性 | 形式 | 说明 |
---|---|---|
type |
字符串 | 使用 dashboard:stop 类型表示要停止正在运行的信息中心。 |
look:run
使用此操作运行在 iframe 中基于 Look 的查询。此操作类似于点击 Look 中的 Run 按钮,不同之处在于 look:run
始终会直接查询数据库,并且不会从 Looker 缓存中检索数据。
{
type: "look:run"
}
属性 | 形式 | 说明 |
---|---|---|
type |
字符串 | 使用 look:run 类型表示您要运行 Look。 |
look:filters:update
执行此操作后,您可以在 iframe 中更新现有的 Look 过滤条件。您无法使用此方法向 Look 中添加新的过滤条件。
{
type: "look:filters:update",
filters: {
"orders.created_at": "90 days",
"products.department": "sweaters"
}
}
属性 | 形式 | 说明 |
---|---|---|
type |
字符串 | 使用 look:filters:update 类型表示您要更新 Look 使用的过滤条件。 |
filters |
对象 | 您要应用于 Look 的新过滤条件。此对象的格式如下:{"view_name.field_name_1": "value 1", "view_name.field_name_1": "value 2", ...} |
explore:run
使用此操作在 iframe 中运行探索。此操作类似于点击“探索”中的 Run 按钮,不同之处在于 explore:run
始终会直接查询数据库,而不会从 Looker 缓存中检索数据。
{
type: "explore:run"
}
属性 | 形式 | 说明 |
---|---|---|
type |
字符串 | 使用 explore:run 类型表示您要运行“探索”。 |
explore:filters:update
执行此操作可更新或移除 iframe 中现有的“探索”过滤条件。如果添加的新过滤条件引用了有效字段,系统会将新过滤条件添加到探索中。
{
type: "explore:filters:update",
filters: {
"orders.created_at": "90 days",
"orders.status": "complete"
}
deleteFilters: ["products.department"]
}
属性 | 形式 | 说明 |
---|---|---|
type |
字符串 | 使用 explore:filters:update 类型表示您要更新“探索”使用的过滤条件。 |
filters |
对象 | 要应用于“探索”的新过滤条件。如果 filters 包含的过滤条件当前不存在于“探索”中,但引用了有效字段,系统会将该过滤条件添加到“探索”中。此对象的格式如下:{"view_name.field_name_1": "value 1", "view_name.field_name_1": "value 2", ...} |
deleteFilters |
数组 | 您要从“探索”中移除的现有过滤条件。数组的格式为:["view_name.field_name_1", "view_name.field_name_2", ...] |
session:tokens:request
使用此操作发送令牌以响应 session:tokens:request
请求。
{
type: "session:tokens:request",
}
属性 | 形式 | 说明 |
---|---|---|
type |
字符串 | 使用 session:tokens:request 类型表示您要发送令牌来响应 session:tokens:request 事件。 |
env:host:scroll
使用此方法可将有关主机 iframe 当前滚动位置的信息发送到嵌入式 Looker 应用。
{
type: "env:host:scroll",
offsetTop: 10,
offsetLeft: 10,
scrollX: 5,
scrollY: 5
}
属性 | 形式 | 说明 |
---|---|---|
type |
字符串 | 使用 env:host:scroll 类型表示您要将有关主机 iframe 当前滚动位置的信息发送到嵌入式 Looker 应用。 |
offsetTop |
数字 | iframe 的上偏移值。 |
offsetLeft |
数字 | iframe 的左侧偏移量。 |
scrollX |
数字 | 应用主机的 scrollX 位置。 |
scrollY |
数字 | 应用主机的滚动 Y 位置。 |