Le fichier manifeste fournit des informations sur votre visualisation et identifie l'emplacement de vos ressources de visualisation. Il doit être nommé manifest.json
et situé au niveau supérieur du dossier utilisé comme Component ID
.
Sauf indication contraire, les champs suivants doivent être définis :
Nom du champ | Type | Description |
---|---|---|
name |
string |
Nom du package de visualisation. |
organization |
string |
Nom de l'organisation ou du développeur. |
description |
string |
Description du package de visualisation. |
logoUrl |
string |
Un logo pour le paquet de visualisation. |
packageUrl |
string |
Lien que les utilisateurs peuvent suivre pour en savoir plus sur le package |
organizationUrl |
string |
(Facultatif) Lien que les utilisateurs peuvent suivre pour en savoir plus sur l'organisation ou le développeur. |
supportUrl |
string |
Lien vers la page d'assistance ou l'e-mail pour soutenir cette visualisation. |
privacyPolicyUrl |
string |
(Facultatif) Lien vers les règles de confidentialité. |
termsOfServiceUrl |
string |
(Facultatif) Lien vers les conditions d'utilisation. |
devMode |
boolean |
(Facultatif) Si la valeur est "true", ignore la mise en cache. Cette valeur par défaut est false . Pour en savoir plus, consultez À propos de la mise en cache. |
components |
Array(object) |
Visualisations incluses dans le package. Pour le moment, une seule visualisation est acceptée. |
components[].id |
string |
ID du composant. Il doit s'agir d'une chaîne non vide sans espaces. |
components[].name |
string |
Nom de la visualisation. |
components[].description |
string |
Une description de la visualisation. |
components[].iconUrl |
string |
Une icône pour la visualisation. |
components[].infoUrl |
string |
(Facultatif) Lien que les utilisateurs peuvent suivre pour en savoir plus sur le composant. |
components[].resource |
object |
Ressources de visualisation |
components[].resource.js |
string |
Emplacement du fichier JavaScript de visualisation dans Google Cloud Storage. Exemple : gs://GCS_BUCKET_NAME/MY_VISUALIZATION.js . |
components[].resource.config |
string |
Emplacement du fichier de configuration de la visualisation dans Google Cloud Storage. Exemple : gs://GCS_BUCKET_NAME/MY_CONFIG.json . |
components[].resource.css |
string |
(Facultatif) L'emplacement du fichier CSS de visualisation dans Google Cloud Storage. Exemple : gs://GCS_BUCKET_NAME/MY_CSS.css . |
Exemple de fichier manifeste 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"
}
}
]
}