清单提供了有关可视化图表的信息,并标识了可视化图表资源的位置。它应命名为 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 |
可视化 JavaScript 文件在 Google Cloud Storage 中的位置。例如 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"
}
}
]
}