Riferimento al manifest della visualizzazione della community

Il file manifest fornisce informazioni sulla visualizzazione e identifica i la posizione delle risorse di visualizzazione. Dovrebbe essere denominato manifest.json e che si trova al livello superiore della cartella utilizzata come Component ID.

Se non diversamente indicato, è necessario definire i seguenti campi:

Nome campo Tipo Descrizione
name string Nome del pacchetto di visualizzazione.
organization string Nome dell'organizzazione o dello sviluppatore.
description string Descrizione del pacchetto di visualizzazione.
logoUrl string Un logo per il pacchetto di visualizzazione.
packageUrl string Un link che gli utenti possono seguire per scoprire di più sul pacchetto
organizationUrl string (Facoltativo) Un link che gli utenti possono seguire per scoprire di più sull'organizzazione o sullo sviluppatore.
supportUrl string Link alla pagina o all'email di assistenza per ricevere supporto per questa visualizzazione.
privacyPolicyUrl string (Facoltativo) Link alle norme sulla privacy.
termsOfServiceUrl string (Facoltativo) Link ai Termini di servizio.
devMode boolean (Facoltativo) Se true, salta la memorizzazione nella cache. Per impostazione predefinita, questo valore è false. Per ulteriori dettagli, consulta l'articolo Informazioni sulla memorizzazione nella cache.
components Array(object) Le visualizzazioni incluse nel pacchetto. Al momento è supportata una sola visualizzazione.
components[].id string L'ID del componente. Deve essere una stringa non vuota e senza spazi.
components[].name string Il nome della visualizzazione.
components[].description string Una descrizione della visualizzazione.
components[].iconUrl string Un'icona per la visualizzazione.
components[].infoUrl string (Facoltativo) Un link che gli utenti possono seguire per scoprire di più sul componente.
components[].resource object Le risorse di visualizzazione.
components[].resource.js string La posizione del file JavaScript di visualizzazione in Google Cloud Storage. Ad es. gs://GCS_BUCKET_NAME/MY_VISUALIZATION.js.
components[].resource.config string La posizione del file di configurazione della visualizzazione in Google Cloud Storage. Ad es. gs://GCS_BUCKET_NAME/MY_CONFIG.json.
components[].resource.css string (Facoltativo) La posizione del file CSS di visualizzazione in Google Cloud Storage. Ad es. gs://GCS_BUCKET_NAME/MY_CSS.css.

Esempio di file manifest 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"
      }
    }
  ]
}