嵌入式 JavaScript 事件

创建嵌入功能后（可通过公开、私有、单点登录 (SSO) 或通过 API 完成），您可以通过 JavaScript 与这些 iframe 进行交互。您可以根据嵌入项的状态使页面更加动态，甚至从网页更改嵌入的项。

请注意，Looker 无法控制浏览器将事件发送到 Web 应用的顺序。这意味着，无法保证在各个浏览器或平台上的事件顺序。请务必正确编写您的 JavaScript，以考虑不同浏览器的事件处理方式。

对于 Looker 嵌入式内容，您可以通过两种方式使用 JavaScript：

使用 Looker 的嵌入式软件开发套件 (SDK)（如嵌入 SDK 文档页面所述）
使用 JavaScript 事件，如本页使用 JavaScript 访问事件部分所述

准备工作

您需要先执行一些操作，然后才能与嵌入式 iframe 交互：

向 iframe 添加 ID
将嵌入网域添加到 iframe src 属性
将嵌入域名添加到许可名单

向 iframe 添加 ID

您稍后需要执行的一项操作是验证您处理的信息是否确实来自 Looker 的 iframe。为方便起见，请务必向 iframe 添加 ID（如果您尚未添加）。在以下示例中，我们添加了 id="looker"：

<iframe id="looker" src="https://instance_name.looker.com/embed/dashboards/1"></iframe>

将嵌入网域添加到 iframe `src` 属性

在 iframe 的 src 中，添加使用 iframe 的网域。在以下示例中，我们添加了 ?embed_domain=https://mywebsite.com"：

<iframe
  id="looker"
  src="https://instance_name.looker.com/embed/dashboards/1?embed_domain=https://mywebsite.com">
</iframe>

如果您使用的是 SSO 嵌入，请务必将 embed_domain 添加到嵌入网址。

请勿在embed_domain中添加尾随斜杠 (/)。

将嵌入网域添加到许可名单

最后，您需要在 Looker 的管理面板的嵌入页面，将使用 iframe 的网域添加到许可名单：

输入使用 iframe 的网域。输入之后，请务必按 Tab 键，使域名显示在框中。请勿在域名网址末尾添加斜杠 (/)。
点击更新按钮。

您可以使用许可名单中的 * 通配符来创建网域模式。例如，https://*.mycompany.com 将同时允许 https://analytics.mycompany.com 和 https://data.mycompany.com。

从 iframe 中检索数据

完成准备步骤后，您就可以通过监听 postMessage 事件来访问在 Looker iframe 和您的网域之间传递的事件。

请务必检查事件是否来自 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`	ADDED 22.20 信息中心已切换到修改模式。成功保存信息中心后，系统会触发 `dashboard:save:complete` 事件。旧版信息中心不支持此选项。
`dashboard:edit:cancel`	ADDED 22.20 处于修改模式的信息中心已从编辑模式退出，且未保存。旧版信息中心不支持此选项。
`dashboard:save:complete`	信息中心已修改并保存。
`dashboard:delete:complete`	已删除信息中心。
`dashboard:tile:start`	卡片已开始加载或查询数据。
`dashboard:tile:complete`	一个卡片已完成查询。
`dashboard:tile:download`	已开始下载卡片的数据。
`dashboard:tile:explore`	用户点击了信息中心图块中的从此处开始探索选项。
`dashboard:tile:view`	用户点击了信息中心图块中的 View Original Look 选项。
`dashboard:filters:changed`	信息中心的过滤条件已应用或更改。
`look:ready`	Look（查询）已开始加载查询数据，无论查询是否运行。
`look:run:start`	Look 已开始加载查询数据，并且查询已经开始运行。
`look:run:complete`	Look 已完成查询的运行。
`look:save:complete`	已修改并保存外观。
`look:delete:complete`	“查看”已移至回收站文件夹。
`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`	发送会话状态的相关信息。

事件类型参考

嵌入式 iframe 可创建许多不同类型的事件：

`dashboard:loaded`

在未设为自动运行卡片的信息中心内，系统会在信息中心及其元素加载后、运行查询之前创建此事件。

旧版信息中心不提供 options 属性。


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`	布尔值	ADDED 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`	布尔值	ADDED 22.20 当 `true` 时，用户可以修改信息中心。旧版信息中心不支持此选项。
`dashboard.url`	字符串	相对信息中心网址（仅路径）。
`dashboard.absoluteUrl`	字符串	完整的信息中心网址。
`dashboard.dashboard_filters`	对象	应用于信息中心的过滤条件。此对象的格式如下：`{"Filter name 1": "value 1", "Filter name 2": "value 2", ...}`

`dashboard:run:complete`

当信息中心运行完毕且所有图块都完成加载和查询时，系统会创建此事件。无论所有图块是否成功加载，系统都会创建此事件。

旧版信息中心不提供 options 和 tileStatuses 属性。

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`	布尔值	ADDED 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`	对象数组	提供图块状态的对象的数组。对象属性包括： `tileId` - 图块的 ID 编号。 `status` - 如果卡片查询成功运行，`status` 会返回 `"complete"`；否则，`status` 会返回 `"error"`。 `errors` - 当 `status` 属性为 `"error"` 时填充。一个对象数组，提供错误的详细信息，包括错误消息文本、对错误的更详细描述以及生成错误的卡片的 SQL 查询。旧版信息中心不支持此选项。

`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`	布尔值	ADDED 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`

ADDED 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`	布尔值	ADDED 22.20 当 `true` 时，用户可以修改信息中心。旧版信息中心不支持此选项。
`dashboard.url`	字符串	相对信息中心网址（仅路径）。
`dashboard.absoluteUrl`	字符串	完整的信息中心网址。
`dashboard.dashboard_filters`	对象	应用于信息中心的过滤条件。此对象的格式如下：`{"Filter name 1": "value 1", "Filter name 2": "value 2", ...}`

`dashboard:edit:cancel`

ADDED 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`	布尔值	ADDED 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`	布尔值	ADDED 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`	布尔值	ADDED 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`	数字/字符串	卡片所属的信息中心。
`dashboard.title`	字符串	信息中心标题，显示在卡片所属的信息中心顶部。
`dashboard.canEdit`	布尔值	ADDED 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`

此事件在卡片运行完查询后创建。

旧版信息中心不提供 errors 属性。

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`	数字/字符串	卡片所属的信息中心。
`dashboard.title`	字符串	信息中心标题，显示在卡片所属的信息中心顶部。
`dashboard.canEdit`	布尔值	ADDED 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 的默认行数上限（5000）。
`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`	数字/字符串	卡片所属的信息中心。
`dashboard.title`	字符串	信息中心标题，显示在卡片所属的信息中心顶部。
`dashboard.canEdit`	布尔值	ADDED 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`	数字/字符串	卡片所属的信息中心。
`dashboard.title`	字符串	信息中心标题，显示在卡片所属的信息中心顶部。
`dashboard.canEdit`	布尔值	ADDED 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`

当用户点击信息中心图块中的 View Original 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`	数字/字符串	卡片所属的信息中心。
`dashboard.title`	字符串	信息中心标题，显示在卡片所属的信息中心顶部。
`dashboard.canEdit`	布尔值	ADDED 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`

此事件在信息中心已应用或更改时创建。

旧版信息中心不提供 options 属性。

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`	布尔值	ADDED 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（修改）按钮以修改外观，然后点击 Save（保存）
使用 Save > Save As... 菜单选项保存外观
将样式从一个文件夹移至另一个文件夹

如果使用保存 > 保存到现有信息中心或修改设置菜单选项保存 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 移至 Trash 文件夹时，系统便会创建此事件。

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`	数字/字符串	卡片所属的信息中心。
`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 的高度发生变化时，系统会创建此事件。不适用于 Looks 或探索，因为这些项目会自动根据 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`，则表示嵌入应用可能存在问题。

更改 iframe

准备好 iframe 以进行数据检索后，您可以通过以下步骤更改 iframe：

以 JSON 格式编写请求。
将请求发布到 iframe 的 contentWindow。

使用 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`	已添加 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` 事件。

操作参考文档

您可以将以下操作发布到嵌入式 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`

ADDED 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` 属性返回。格式如下： `id: "string", dashboard_id: "string", type: "newspaper", active: boolean, column_width: number, width: number`
`layouts.dashboard_layout_components`	对象	`dashboard:run:complete` 事件中的 `options` 属性返回的一个或多个信息中心布局组件对象。格式如下： `id: "string", dashboard_layout_id: "string", dashboard_element_id: "string", row: number, column: number, width: number, height: number, deleted: boolean,`
`elements`	对象	`dashboard:run:complete` 事件中的 `options` 属性返回的一个或多个信息中心元素对象。格式如下： `id: { title: "string"`

`dashboard:schedule_modal:open`

使用此操作打开调度程序，让用户能够将 Looker 内容传送到各种目的地。

旧版信息中心不支持此操作。

{
  type: "dashboard:schedule_modal:open"
}

属性	形式	说明
`type`	字符串	使用 `dashboard:schedule_modal:open` 类型表示您要打开计划对话框。

`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 中运行“探索”。这类似于在探索上按运行按钮，但 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` 事件。

嵌入式 JavaScript 事件

准备工作

向 iframe 添加 ID

将嵌入网域添加到 iframe src 属性

将嵌入网域添加到许可名单

从 iframe 中检索数据

使用 JavaScript 访问事件

事件类型摘要表

事件类型参考

dashboard:loaded

dashboard:run:start

dashboard:run:complete

dashboard:download

dashboard:edit:start

dashboard:edit:cancel

dashboard:save:complete

dashboard:delete:complete

dashboard:tile:start

dashboard:tile:complete

dashboard:tile:download

dashboard:tile:explore

dashboard:tile:view

dashboard:filters:changed

look:ready

look:run:start

look:run:complete

look:save:complete

look:delete:complete

drillmenu:click

drillmodal:download

drillmodal:explore

explore:ready

explore:run:start

explore:run:complete

explore:state:changed

page:changed

page:properties:changed

session:tokens

session:status

更改 iframe

使用 JSON 格式编写请求

将请求发布到 iframe 的 contentWindow 属性

操作摘要表

操作参考文档

dashboard:load

dashboard:run

dashboard:edit

dashboard:filters:update

dashboard:options:set

dashboard:schedule_modal:open

dashboard:stop

look:run

look:filters:update

explore:run

explore:filters:update

session:tokens:request

将嵌入网域添加到 iframe `src` 属性

`dashboard:loaded`

`dashboard:run:start`

`dashboard:run:complete`

`dashboard:download`

`dashboard:edit:start`

`dashboard:edit:cancel`

`dashboard:save:complete`

`dashboard:delete:complete`

`dashboard:tile:start`

`dashboard:tile:complete`

`dashboard:tile:download`

`dashboard:tile:explore`

`dashboard:tile:view`

`dashboard:filters:changed`

`look:ready`

`look:run:start`

`look:run:complete`

`look:save:complete`

`look:delete:complete`

`drillmenu:click`

`drillmodal:download`

`drillmodal:explore`

`explore:ready`

`explore:run:start`

`explore:run:complete`

`explore:state:changed`

`page:changed`

`page:properties:changed`

`session:tokens`

`session:status`

将请求发布到 iframe 的 `contentWindow` 属性

`dashboard:load`

`dashboard:run`

`dashboard:edit`

`dashboard:filters:update`

`dashboard:options:set`

`dashboard:schedule_modal:open`

`dashboard:stop`

`look:run`

`look:filters:update`

`explore:run`

`explore:filters:update`

`session:tokens:request`