Manifestreferenz für Community-Visualisierung

Das Manifest enthält Informationen zu Ihrer Visualisierung und gibt den Speicherort der Visualisierungsressourcen an. Sie sollte manifest.json heißen und sich auf der obersten Ebene des Ordners befinden, der als Component ID verwendet wird.

Die folgenden Felder müssen definiert werden (sofern nicht anders angegeben):

Feldname Typ Beschreibung
name string Name des Visualisierungspakets.
organization string Name der Organisation oder des Entwicklers.
description string Beschreibung des Visualisierungspakets.
logoUrl string Ein Logo für das Visualisierungspaket.
packageUrl string Ein Link, über den Nutzer mehr über das Paket erfahren können
organizationUrl string Optional: Ein Link, über den Nutzer mehr über die Organisation oder den Entwickler erfahren können.
supportUrl string Link zur Supportseite oder E-Mail, die diese Visualisierung unterstützt.
privacyPolicyUrl string Optional: Link zur Datenschutzerklärung
termsOfServiceUrl string (Optional) Link zu den Nutzungsbedingungen.
devMode boolean (Optional) Wenn dieser Wert "true" ist, wird das Caching übersprungen. Der Standardwert ist false. Weitere Informationen finden Sie unter Informationen zum Caching.
components Array(object) Die im Paket enthaltenen Visualisierungen. Derzeit wird nur eine Visualisierung unterstützt.
components[].id string Die ID der Komponente. Dies muss ein nicht leerer String ohne Leerzeichen sein.
components[].name string Der Name der Visualisierung.
components[].description string Eine Beschreibung der Visualisierung.
components[].iconUrl string Ein Symbol für die Visualisierung.
components[].infoUrl string Optional: Einen Link, über den Nutzer mehr über die Komponente erfahren können
components[].resource object Die Visualisierungsressourcen.
components[].resource.js string Der Speicherort der JavaScript-Visualisierungsdatei in Google Cloud Storage. Beispiel: gs://GCS_BUCKET_NAME/MY_VISUALIZATION.js.
components[].resource.config string Der Speicherort der Konfigurationsdatei für die Visualisierung in Google Cloud Storage. Beispiel: gs://GCS_BUCKET_NAME/MY_CONFIG.json.
components[].resource.css string (Optional) Der Speicherort der CSS-Datei für die Visualisierung in Google Cloud Storage. Beispiel: gs://GCS_BUCKET_NAME/MY_CSS.css.

Beispiel für eine manifest.json-Manifestdatei

{
  "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"
      }
    }
  ]
}