קובץ עזר למניפסט חזותי של הקהילה

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