为 Looker Marketplace 开发自定义可视化图表

本页面介绍了如何创建可添加到 Looker Marketplace 并可供其他 Looker 用户访问的自定义可视化类型。您还可以直接在项目中创建自定义可视化图表，而不将其提供给其他 Looker 客户。

请注意，您必须是 Looker 合作伙伴网络的成员或 Looker 客户，才能向 Looker Marketplace 提交内容。

Looker Marketplace 是查找、部署和管理多种类型的 Looker 内容（例如 Looker BlocksTM、应用、可视化图表和其他插件）的中心位置。

启用 Looker Marketplace 功能后，Looker 客户就可以安装 Looker Marketplace 插件，其中包括要添加到 Looker 原生可视化库的可视化类型。

如需开发自定义可视化图表并通过 Looker Marketplace 将其提供给所有 Looker 客户，请按以下步骤操作：

  1. 开发可视化图表。
  2. 为可视化图表创建 Looker 项目。
  3. 将 Looker 项目推送到 Git 代码库。
  4. 测试可视化图表的功能。
  5. 将您的可视化图表提交到 Looker。

开发可视化类型

确定要开发的可视化图表类型。（确认此可视化图表尚未在 Marketplace 中或作为原生 Looker 可视化图表列出。）

在您的 JavaScript 环境中使用 Looker 可视化 API，以 JavaScript 开发自定义可视化图表。

为可视化图表创建 Looker 项目

创建一个 Looker 项目来表示您的自定义可视化图表。该项目应包含以下文件：

  • 许可文件：列出了随可视化图表分发的一个或多个许可，其中包含以下文本：

    This Looker visualization is distributed with the following license:...

  • README.md 文件：提供可视化图表及其工作原理的说明，以及任何其他信息。

  • JavaScript (.js) 文件：包含用于生成可视化图表的 JavaScript 代码的精简版本。在 Marketplace 中，JS 文件包含在项目中，这可以实现适当的版本控制和软件包管理。

  • 清单 (manifest.lkml) 文件：指定 id（唯一标识符）和 label（显示在此可视化图表的 Looker 界面中）。例如：

    constant: vis_id {
        value: "default_id"
        export: override_optional
    }
    constant: vis_label {
        value: "default_label"
        export: override_optional
    }
    visualization: {
        id: "@{vis_id}"
        label: "@{vis_label}"
        file: "my_local.js"
        sri_hash: "my_sri_hash"
        dependencies: []
    }
  • 产品详情 (marketplace.json) 文件：为自定义可视化图表配置 Marketplace 产品详情，并添加有关可视化图表在 Marketplace 中的显示方式的标签、image_uri 的位置、描述可视化图表用例的宣传口号，以及定义用户在安装期间输入的 Marketplace 字段常量。例如：
{
  "label": "Gauge Visualization",
  "category_label": "plug-ins",
  "branding": {
    "image_uri": "https://marketplace-api.looker.com/visualization-screenshots/gauge_icon.png",
    "tagline": "Use the Gauge visualization to display a measure and progress to a goal."
  },
   "constants": {
        "vis_label": {
            "label": "Visualization Label",
            "description": "This label will appear in the visualization selector in the Looker Explore UI."
        },
        "vis_id": {
            "label": "Visualization Id",
            "description": "This must be a unique ID across all visualizations.",
            "value_constraint": "visualization"
        }
    }
}

将项目推送到 Git

在可公开访问的 GitHub 代码库中托管您的可视化 LookML。假设您在 Looker 项目中创建了可视化图表，请按照以下步骤将其推送到新的仓库：

  1. 创建一个可公开访问的 GitHub 代码库。
  2. 将 Looker 项目的代码库网址设置为 GitHub 代码库的网址。
  3. 按照 Looker 中的 Git 提示验证、提交代码并将其部署到生产环境。

测试可视化图表的功能

通过将新的可视化图表应用于 Looker 实例上的相应“探索”或“Look”，测试新的可视化图表：

  1. 前往 Look 或探索。
  2. 如果是在 Look，请点击修改以修改该 Look。
  3. 点击“可视化图表类型”菜单中的三点状菜单，打开可视化图表的下拉列表。
  4. 选择您的自定义可视化图表。
  5. 点击保存以保存对 Look 所做的更改。记下可能受此变更影响的所有信息中心。

Looker 需要使用 Looker Marketplace 提供的可视化图表中的以下函数：

函数 需要
支持深入分析可视化图表 是
能够继承 Looker 的调色板 是
对浏览器和屏幕尺寸的响应 是
一致的字体系列：font-family：Helvetica、Arial、sans-serif 是
字体大小 是
能够在可视化配置面板中切换值标签和轴标签 是
直观呈现透视数据 是（如适用）
使用 updateAsync 函数或 is update function 根据用户互动情况更新可视化图表 是
清晰的错误消息（例如，此可视化图表需要 1 个维度和 2 个测量） 是
可视化图表配置面板中的所有选项都会对可视化图表做出明显更改 是
默认使用字段的 value 格式 是（如适用）
如果查询未返回任何结果，则会抛出错误 是

提交可视化图表以供审核

可视化图表可以提交后，请按照向 Looker Marketplace 提交内容中的说明为可视化图表创建支持文档，将可视化图表提交给 Looker 团队进行审核，然后将可视化图表发布到 Looker Marketplace。