社群視覺呈現資訊清單參考資料

資訊清單提供視覺呈現相關資訊,並識別 視覺化資源的位置檔案名稱應為 manifest.json,且 位於做為 Component ID 的資料夾頂層。

必須定義下列欄位 (除非另有說明):

欄位名稱 類型 說明
name string 視覺化套件的名稱。
organization string 機構或開發人員的名稱。
description string 視覺化套件的說明。
logoUrl string 視覺化套件的標誌。
packageUrl string 使用者點選這個連結,即可進一步瞭解包裹
organizationUrl string (選用) 使用者可以點選這個連結,進一步瞭解機構組織或開發人員。
supportUrl string 連結至支援這個圖表的支援頁面或電子郵件。
privacyPolicyUrl string (選用) 隱私權政策連結。
termsOfServiceUrl string (選用) 服務條款連結。
devMode boolean (選用) 如果為 true,則略過快取。這個值預設為 false。詳情請參閱「關於快取」一文。
components Array(object) 套件內含的圖表。系統目前僅支援一個圖表。
components[].id string 元件 ID。必須是不含空格的非空白字串。
components[].name string 圖表的名稱。
components[].description string 視覺化內容的說明。
components[].iconUrl string 圖表的圖示。
components[].infoUrl string (選用) 使用者可以點選這個連結,進一步瞭解元件。
components[].resource object 視覺化資源。
components[].resource.js string Google Cloud Storage 中視覺化 JavaScript 檔案的位置。例如:gs://GCS_BUCKET_NAME/MY_VISUALIZATION.js
components[].resource.config string Google Cloud Storage 中的圖表設定檔位置。例如:gs://GCS_BUCKET_NAME/MY_CONFIG.json
components[].resource.css string (選用) Google Cloud Storage 中視覺化 CSS 檔案的位置。例如:gs://GCS_BUCKET_NAME/MY_CSS.css

manifest.json 資訊清單檔案範例

{
  "name": "ABC Visualizations Package",
  "organization": "ABC Inc.",
  "description": "A package of cool visualizations.",
  "logoUrl": "https://url",
  "organizationUrl": "https://url",
  "supportUrl": "https://url",
  "privacyPolicyUrl": "https://url",
  "termsOfServiceUrl": "https://url",
  "packageUrl": "https://url",
  "devMode": false,
  "components": [
    {
      "id": "treemap",
      "name": "Treemap",
      "description": "Zoomable treemap with filter interactions",
      "iconUrl": "https://url.png",
      "infoUrl": "https://url",
      "resource": {
        "js": "gs://myViz-bucket-treemap/viz.js",
        "config": "gs://myViz-bucket-treemap/viz-config.json",
        "css": "gs://myViz-bucket-treemap/viz.css"
      }
    },
    {
      "id": "histogram",
      "name": "Histogram",
      "description": "Histogram with filter interactions",
      "iconUrl": "https://url.png",
      "resource": {
        "js": "gs://myViz-bucket-histogram/viz.js",
        "config": "gs://myViz-bucket-histogram/viz-config.json",
        "css": "gs://myViz-bucket-histogram/viz.css"
      }
    }
  ]
}