Справочник по манифесту визуализации сообщества

Манифест предоставляет информацию о вашей визуализации и определяет расположение ресурсов вашей визуализации. Он должен называться 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 Идентификатор компонента. Это должна быть непустая строка без пробелов.
components[].name string Имя визуализации.
components[].description string Описание визуализации.
components[].iconUrl string Значок для визуализации.
components[].infoUrl string ( Необязательно ) Ссылка, по которой пользователи могут перейти, чтобы узнать больше о компоненте.
components[].resource object Ресурсы визуализации.
components[].resource.js string Расположение файла JavaScript визуализации в облачном хранилище Google. Например, 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 ( Необязательно ) Местоположение CSS-файла визуализации в Google Cloud Storage. Например, 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"
      }
    }
  ]
}