המניפסט מספק מידע על התצוגה החזותית ומזהה את המיקום של משאבי התצוגה החזותית. הוא אמור לקבל את השם 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 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"
}
}
]
}