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

資訊清單可提供視覺化內容的相關資訊,並識別視覺化資源的位置。檔案名稱應為 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"
      }
    }
  ]
}