為 Looker Marketplace 開發自訂視覺化效果

本頁面說明如何建立可新增至 Looker Marketplace 並供其他 Looker 使用者存取的自訂圖表類型。您也可以直接在專案中建立自訂圖表，而不向其他 Looker 客戶提供。

請注意，您必須是 Looker 合作夥伴網路成員或 Looker 客戶，才能將內容提交至 Looker Marketplace。

Looker Marketplace 可讓您集中一處搜尋、部署及管理多種 Looker 內容，例如 Looker Blocks™、應用程式、圖表和其他外掛程式。

啟用 Looker 市集功能後，Looker 客戶就能安裝 Looker 市集外掛程式，其中包含可新增至 Looker 原生圖表資料庫的圖表類型。

如要開發自訂圖表，並透過 Looker Marketplace 向所有 Looker 客戶提供，請按照下列步驟操作：

  1. 開發視覺化內容。
  2. 為視覺化內容建立 Looker 專案。
  3. 將 Looker 專案推送至 Git 存放區。
  4. 測試視覺化資訊的功能。
  5. 將視覺化報表提交至 Looker。

開發視覺化類型

找出您要開發的視覺化圖表類型。(請確認此圖表未列於Marketplace或原生 Looker 圖表中)。

使用 Looker Visualization API 和 JavaScript 環境，在 JavaScript 中開發自訂視覺化資料。

為圖表建立 Looker 專案

建立 Looker 專案來呈現自訂圖表。專案應包含下列檔案：

  • LICENSE 檔案：列出可用於發布圖表的授權，使用以下文字：

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

  • README.md 檔案：提供圖像化視覺化內容的說明、運作方式和其他資訊。

  • JavaScript (.js) 檔案：包含用於產生視覺化內容的 JavaScript 程式碼精簡版本。透過市集，JS 檔案會納入專案中，方便您妥善管理版本和套件。

  • 資訊清單 (manifest.lkml) 檔案：指定 id (專屬 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 執行個體中適當的 Explore 或 Look，以便進行測試：

  1. 前往 Look 或「探索」。
  2. 如果是造型，請按一下「編輯」來編輯造型。
  3. 按一下圖表類型選單中的三點圖示選單，開啟圖表的下拉式清單。
  4. 選取自訂視覺化資料。
  5. 按一下「儲存」，即可儲存外觀變更。請注意可能受到這項異動影響的任何資訊主頁。

Looker 需要在 Looker Marketplace 提供的圖表中使用以下函式：

函式 必填
支援深入查看圖表 是
可繼承 Looker 的調色盤 是
根據瀏覽器和螢幕大小調整顯示方式 是
一致的字型系列：font-family：Helvetica、Arial、sans-serif 是
字型大小 是
可在視覺化設定面板中切換值標籤和軸標籤 是
樞紐資料的視覺化 是 (如適用)
使用 updateAsync 函式或 is update function，根據使用者互動性更新視覺化呈現 是
清楚的錯誤訊息 (例如「此視覺化資料需要 1 個維度和 2 個指標」) 是
視覺化呈現設定面板中的所有選項都會對視覺化呈現做出明顯變更 是
預設使用欄位的 value 格式 是 (如適用)
查詢未傳回任何結果時會擲回錯誤 是

將圖表送交審查

完成圖表製作後，請按照「將內容提交至 Looker Marketplace」一文的操作說明，為圖表建立輔助說明文件，將圖表提交給 Looker 團隊進行審查，並將圖表發布至 Looker Marketplace。