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

本页面介绍了如何创建自定义可视化类型,以便添加到 Looker Marketplace 中并可供其他 Looker 用户使用。您也可以直接在项目中创建自定义可视化图表,无需提供给其他 Looker 客户。

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

Looker Marketplace 是一个集中位置,您可以在其中查找、部署和管理许多类型的 Looker 内容,例如 Looker Blocks、应用、可视化图表和其他插件。

启用 Looker Marketplace 功能后,Looker 客户可以安装 Looker Marketplace 插件,其中包括要添加到 Looker 原生可视化库的可视化类型。Looker 团队支持通过 Marketplace 安装的可视化图表。

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

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

开发可视化类型

确定您想要开发的可视化类型。(确认此可视化图表尚未在市场中列出或未作为原生 Looker 可视化列出)。

搭配 Looker 可视化 API 搭配 JavaScript 环境,使用 JavaScript 开发自定义可视化内容。

为可视化图表创建 Looker 项目

创建 Looker 项目以代表您的自定义可视化。该项目应包含以下文件:

  • LICENSE 文件:列出分发许可的一个或多个许可,文本为“此 Looker 可视化随以下许可一起分发:”文本

  • 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: []
    }
  • Listing (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 实例”中进行测试:

  1. 转到“查看”或“探索”。
  2. 如果外观,请点击修改以修改外观。
  3. 点击可视化图表类型菜单中的三点状菜单,打开可视化图表的下拉列表。
  4. 选择您的自定义可视化图表。
  5. 点击保存将更改保存到 Look 中。请注意受此变更影响的所有信息中心。

Looker 需要在 Looker Marketplace 提供的可视化图表中提供以下函数:

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

提交可视化图表以供审核

可视化图表准备好提交后,请按照向 Looker 应用商店提交内容中的说明创建有关可视化图表的支持文档,将可视化图表提交给 Looker 团队进行审核,并发布到 Looker 市场。