Documentation
Table of Contents
> אובייקט לוח המחוונים של תבנית
האובייקטים הבאים קשורים ישירות ל'לוח המחוונים של התבניות' ממשק API.
לוח המחוונים של תבניות
לאובייקט לוח המחוונים של התבנית יש את המאפיינים הבאים.
| Property | Type | תיאור |
|---|---|---|
| dashboardid | string | (לקריאה בלבד) מזהה של לוח המחוונים של התבנית. |
| שם (חובה) |
מחרוזת | שם לוח המחוונים של התבניות. |
| templateid (נדרש) |
מחרוזת | מזהה התבנית שאליה שייך לוח המחוונים. |
| display_period | integer | תקופת ברירת המחדל להצגת דף (בשניות). ערכים אפשריים: 10, 30, 60, 120, 600, 1800, 3600. ברירת מחדל: 30. |
| auto_start | integer | התחל אוטומטית של מצגת. ערכים אפשריים: 0 - אל תפעיל אוטומטית מצגת; 1 - (ברירת מחדל) התחל אוטומטית של מצגת. |
| uuid | string | מזהה ייחודי אוניברסלי, המשמש לקישור לוחות מחוונים של תבניות מיובאות לאלה שכבר קיימים. נוצר אוטומטית, אם לא ניתן. |
שימו לב שעבור שיטות מסוימות (עדכון, מחק) שילוב הפרמטרים הנדרש/אופציונלי שונה.
דף לוח המחוונים של תבנית
לאובייקט עמוד לוח המחוונים של התבנית יש את המאפיינים הבאים.
| Property | Type | תיאור |
|---|---|---|
| dashboard_pageid | string | (לקריאה בלבד) מזהה דף לוח המחוונים. |
| name | string | שם דף לוח המחוונים. ברירת מחדל: מחרוזת ריקה. |
| display_period | מספר שלם | תקופת הצגת דף לוח המחוונים (בשניות). ערכים אפשריים: 0, 10, 30, 60, 120, 600, 1800, 3600. ברירת מחדל: 0 (ישתמש בתקופת ברירת המחדל של תצוגת העמוד). |
| widgets | מערך | מערך של יישומון לוח המחוונים של תבנית. |
ווידג'ט של לוח המחוונים של תבנית
לאובייקט הווידג'ט של לוח המחוונים של התבנית יש את המאפיינים הבאים.
| Property | Type | תיאור |
|---|---|---|
| widgetid | string | (לקריאה בלבד) מזהה הווידג'ט של לוח המחוונים. |
| סוג (נדרש) |
מחרוזת | סוג הווידג'ט של לוח המחוונים. ערכים אפשריים: שעון - שעון; גרף - גרף (קלאסי); graphprototype - גרף אב טיפוס; פריט - ערך פריט; טקסט רגיל - טקסט רגיל; כתובת אתר - URL; |
| name | string | שם ווידג'ט מותאם אישית. |
| x | integer | מיקום אופקי מהצד השמאלי של לוח המחוונים. ערכים חוקיים נעים בין 0 ל-23. |
| y | integer | מיקום אנכי מהחלק העליון של לוח המחוונים. ערכים חוקיים נעים בין 0 ל-62. |
| width | integer | רוחב הווידג'ט. ערכים חוקיים נעים בין 1 ל-24. |
| height | integer | גובה הווידג'ט. ערכים חוקיים נעים בין 2 ל-32. |
| view_mode | integer | מצב תצוגת הווידג'ט. ערכים אפשריים: 0 - (ברירת מחדל) תצוגת ווידג'ט ברירת מחדל; 1 - עם כותרת נסתרת; |
| fields | array | מערך של שדה הווידג'ט של לוח המחוונים של תבנית. |
שדה הווידג'ט של לוח המחוונים של תבנית
לאובייקט שדה הווידג'ט של לוח המחוונים של התבנית יש את המאפיינים הבאים.
| Property | Type | תיאור |
|---|---|---|
| סוג (נדרש) |
מספר שלם | סוג שדה הווידג'ט. ערכים אפשריים: 0 - מספר שלם; 1 - מחרוזת; 4 - פריט ; 5 - אב טיפוס של פריט; 6 - גרף; 7 - אב טיפוס של גרף. |
| name | string | שם שדה יישומון. |
| ערך (נדרש) |
מעורב | ערך שדה ווידג'ט בהתאם לסוג. |