תיאור
צריך להשתמש ב-API system.display
כדי לשלוח שאילתות על מטא-נתונים של תצוגה.
הרשאות
system.display
סוגים
ActiveState
'טיפוסים בני מנייה (enum)' שמציינים אם המסך זוהה ונמצא בשימוש על ידי המערכת. המסך נחשב כ'לא פעיל' אם המערכת לא זיהתה אותו (ייתכן שהוא מנותק או נחשב מנותק בגלל מצב שינה וכו'). המצב הזה משמש לשמירת המסך הקיים כשכל המסכים מנותקים, למשל.
טיפוסים בני מנייה (enum)
Bounds
תכונות
-
גובה
מספר
גובה המסך בפיקסלים.
-
שמאלה
מספר
קואורדינטת ה-x של הפינה השמאלית העליונה.
-
ראשונה
מספר
קואורדינטת ה-y של הפינה השמאלית העליונה.
-
רוחב
מספר
רוחב התצוגה בפיקסלים.
DisplayLayout
תכונות
-
id
מחרוזת
המזהה הייחודי של המסך.
-
היסט
מספר
ההיסט של המסך לאורך הקצה המחובר. הערך 0 מציין שהפינות העליונות או השמאליות ביותר מיושרות.
-
parentId
מחרוזת
המזהה הייחודי של מסך ההורה. אם זהו השורש, ריק.
-
position
מיקום הפריסה של המסך הזה ביחס להורה. המערכת תתעלם ממנו בתור הבסיס.
DisplayMode
תכונות
-
deviceScaleFactor
מספר
גורם קנה המידה של המכשיר במצב תצוגה.
-
גובה
מספר
הגובה של מצב התצוגה בפיקסלים בלתי תלויים במכשיר (גלויים למשתמש).
-
heightInNativePixels
מספר
הגובה של מצב התצוגה בפיקסלים מקוריים.
-
isInterlaced
בוליאני אופציונלי
Chrome 74 ומעלהTrue אם המצב הזה הוא משולבת, FALSE אם לא צוין.
-
isNative
boolean
True אם המצב הוא המצב המקורי של המסך.
-
isSelected
boolean
True אם מצב התצוגה נבחר כרגע.
-
refreshRate
מספר
Chrome 67 ומעלהקצב הרענון של מצב התצוגה בהרץ.
-
uiScale
מספר אופציונלי
הוצא משימוש מאז Chrome 70שימוש באפליקציה
displayZoomFactor
גורם קנה המידה של ממשק המשתמש במצב תצוגה.
-
רוחב
מספר
רוחב מצב התצוגה בפיקסלים בלתי תלויים במכשיר (גלויים למשתמש).
-
widthInNativePixels
מספר
רוחב מצב התצוגה בפיקסלים מקוריים.
DisplayProperties
תכונות
-
boundsOriginX
מספר אופציונלי
אם ההגדרה הזו מוגדרת, מקור הגבולות הלוגיים של המסך מתעדכנים לאורך ציר ה-X. הבקשה הופעלה יחד עם
boundsOriginY
. אם הוא לא מוגדר, הערךboundsOriginY
מוגדר כברירת מחדל. הערה: כשמעדכנים את מקור התצוגה, המערכת מחילה מגבלות מסוימות, ולכן מקור הגבול הסופי עשוי להיות שונה מזה שהוגדר. ניתן לאחזר את הגבולות הסופיים באמצעותgetInfo
. לא ניתן לשנות את מקור הגבולות במסך הראשי. -
boundsOriginY
מספר אופציונלי
אם המדיניות מוגדרת, מקור הגבולות הלוגיים של התצוגה יתעדכן לאורך ציר ה-Y. עיינו בתיעוד של הפרמטר
boundsOriginX
. -
displayMode
DisplayMode אופציונלי
Chrome 52 ומעלהאם המדיניות מוגדרת, מצב התצוגה יתעדכן למצב שתואם לערך הזה. אם הפרמטרים האחרים אינם חוקיים, הפרמטר הזה לא ייושם. אם מצב התצוגה לא תקין, המערכת לא תחיל אותו ותוגדר שגיאה, אבל מאפיינים אחרים עדיין יוחלו.
-
displayZoomFactor
מספר אופציונלי
Chrome 65 ומעלהאם המדיניות מוגדרת, הזום התצוגה מתעדכנת. הזום הזה מבצע פריסה מחדש וצביעה מחדש וכתוצאה מכך מתקבל זום איכותי יותר בהשוואה לביצוע הגדלת פיקסל אחרי פיקסל.
-
isPrimary
בוליאני אופציונלי
אם קובעים את ההגדרה True, המסך הופך לראשי. אין-אופציה אם היא מוגדרת כ-False. הערה: אם המדיניות מוגדרת, המסך נחשב לתצוגה ראשית בכל המאפיינים האחרים (כלומר, יכול להיות שהערך של הפרמטר
isUnified
יהיה מוגדר ומקור הגבולות לא יוכל לעשות זאת). -
isUnified
בוליאני אופציונלי
Chrome 59 ומעלהChrome OS בלבד. אם המדיניות מוגדרת כ-True, מצב התצוגה משתנה ל'שולחן עבודה מאוחד' (לפרטים, אפשר לעיין ב-
enableUnifiedDesktop
). אם המדיניות מוגדרת כ-False, מצב שולחן העבודה המאוחד יהיה מושבת. האפשרות הזאת תקפה רק במסך הראשי. אם מציינים ערך, אי אפשר לציין mirroringSourceId. המערכת תתעלם ממאפיינים אחרים. אם לא מציינים את הנתונים האלה, אין לכך השפעה. -
mirroringSourceId
מחרוזת אופציונלי
הוצא משימוש מאז Chrome 68שימוש ב-
setMirrorMode
.Chrome OS בלבד. אם המדיניות מוגדרת ולא ריקה, הפעלת שיקוף מסך במסך הזה בלבד. אחרת, השבתה של שיקוף מסך בכל המסכים. הערך הזה צריך לציין את המזהה של תצוגת המקור לשקף, שאינו יכול להיות זהה למזהה שהועבר אל setDisplayProperties. אם המדיניות מוגדרת, לא ניתן להגדיר נכסים אחרים.
-
סריקת יתר
Insets אופציונלי
אם המדיניות מוגדרת, היא מגדירה את תוספת סריקות היתר של התצוגה לערכים שסופקו. חשוב לשים לב שערכי סריקת יתר לא יכולים להיות שליליים או גדולים מחצי מגודל המסך. לא ניתן לשנות את סריקת היתר בצג הפנימי.
-
סבב
מספר אופציונלי
אם המדיניות מוגדרת, סיבוב המסך יעדכן. הערכים המשפטיים הם [0, 90, 180, 270]. הסיבוב מוגדר בכיוון השעון, ביחס למיקום האנכי של המסך.
DisplayUnitInfo
תכונות
-
activeStateChrome 117 ומעלה
התכונה פעילה אם המערכת מזהה את המסך ומשתמשת בו.
-
availableDisplayZoomFactors
מספר[]
Chrome 67 ומעלהרשימה של ערכי גורם זום שניתן להגדיר עבור המסך.
-
גבולות
הגבולות הלוגיים של המסך.
-
displayZoomFactor
מספר
Chrome 65 ומעלההיחס בין המרחק מהתצוגה הנוכחית לבין הזום המוגדר כברירת מחדל. לדוגמה, ערך 1 שווה ערך לזום ב-100%, וערך 1.5 שווה זום של 150%.
-
dpiX
מספר
מספר הפיקסלים לאינץ' לאורך ציר ה-X.
-
dpiY
מספר
מספר הפיקסלים לאינץ' לאורך ציר ה-Y.
-
Eidid
Edid אופציונלי
Chrome 67 ומעלההערה: האפשרות הזו זמינה רק באפליקציות "קיוסק" של ChromeOS ובממשק המשתמש באינטרנט.
-
hasTouchSupport
boolean
Chrome 57 ומעלהTrue אם למסך הזה משויך מכשיר לקליטת נתוני מגע.
-
id
מחרוזת
המזהה הייחודי של המסך.
-
isEnabled
boolean
True אם המסך הזה מופעל.
-
isPrimary
boolean
True אם זה המסך הראשי.
-
isUnified
boolean
Chrome 59 ומעלהTrue בכל המסכים במצב שולחן עבודה מאוחד. לעיון בתיעוד של
enableUnifiedDesktop
. -
mirroringDestinationIds
מחרוזת[]
Chrome 64 ומעלהChrome OS בלבד. המזהים של המסכים שאליהם שיקוף המסך של המקור. ריקה אם אין שיקוף מסך. הערך הזה יוגדר לערך זהה בכל המסכים. אי אפשר לכלול
mirroringSourceId
. -
mirroringSourceId
מחרוזת
Chrome OS בלבד. המזהה של המסך שמסתנכרן אם שיקוף המסך מופעל. אם זה לא המצב, הוא ריק. ההגדרה הזו תהיה מוגדרת לכל המסכים (כולל המסך שמסתנכרן בענן ובמחשב).
-
modesChrome 52 ומעלה
הרשימה של מצבי התצוגה הזמינים. המצב הנוכחי יהיה isSelected=true. התכונה הזו זמינה רק ב-ChromeOS. המערכת תגדיר מערך ריק בפלטפורמות אחרות.
-
name
מחרוזת
שם ידידותי למשתמש (למשל, "צג HP LCD").
-
סריקת יתר
ערכי המסך שנמצאים בתוך גבולות המסך. גלויה כרגע רק ב-ChromeOS. יוגדרו כרכיבי inset ריקים בפלטפורמות אחרות.
-
סבב
מספר
הסיבוב של המסך במעלות, בכיוון השעון, ביחס למיקום האנכי. גלויה כרגע רק ב-ChromeOS. יוגדר כ-0 בפלטפורמות אחרות. הערך 1- יפורש כסיבוב אוטומטי כשהמכשיר נמצא במצב טאבלט פיזי.
-
workArea
אזור העבודה שניתן להשתמש בו בגבולות התצוגה. אזור העבודה לא כולל אזורים במסך ששמורים למערכת ההפעלה, למשל סרגל משימות ומרכז האפליקציות.
Edid
תכונות
-
manufacturerId
מחרוזת
קוד יצרן בן 3 תווים. פרטים נוספים זמינים בסעיף 3.4.1, עמוד 21. נדרש בגרסה 1.4.
-
productId
מחרוזת
קוד בגודל 2 בייט שהוקצה על ידי היצרן, סעיף 3.4.2, דף 21. נדרש בגרסה 1.4.
-
yearOfManufacture
מספר
שנת היצרן, סעיף 3.4.4, דף 22. נדרש בגרסה 1.4.
GetInfoFlags
תכונות
-
singleUnified
בוליאני אופציונלי
אם המדיניות מוגדרת כ-True, רק
DisplayUnitInfo
אחד יוחזר על ידיgetInfo
במצב שולחן עבודה מאוחד (ראוenableUnifiedDesktop
). ברירת המחדל היא false.
Insets
תכונות
-
שנייה
מספר
המרחק של ציר ה-Y מהגבול התחתון.
-
שמאלה
מספר
המרחק של ציר ה-X מהגבול השמאלי.
-
ימינה
מספר
המרחק של ציר ה-X מהגבול הימני.
-
ראשונה
מספר
המרחק של ציר ה-Y מהגבול העליון.
LayoutPosition
מיקום הפריסה, כלומר קצה ההורה שאליו מחובר המסך.
טיפוסים בני מנייה (enum)
MirrorMode
מצב מראה, כלומר דרכים שונות לשיקוף המסך במסכים אחרים.
טיפוסים בני מנייה (enum)
"כבוי"
מציין את מצב ברירת המחדל (שולחן עבודה מורחב או מאוחד).
'רגיל'
מציין שתצוגת המקור המוגדרת כברירת מחדל תשקף את כל שאר המסכים.
'מעורב'
מציין שמסך המקור שצוין ישקף את מסכי היעד שסופקו. כל שאר המסכים המחוברים יורחבו.
MirrorModeInfo
תכונות
-
mirroringDestinationIds
string[] אופציונלי
המזהים של יעד שיקוף היעד יוצגו. תקף רק עבור 'מעורב'.
-
mirroringSourceId
מחרוזת אופציונלי
המזהה של תצוגת המקור לשיקוף. תקף רק עבור 'מעורב'.
-
אמצעי תחבורה
מצב השתקפות שיש להגדיר.
Point
תכונות
-
x
מספר
קואורדינטת ה-x של הנקודה.
-
שנה
מספר
קואורדינטת ה-y של הנקודה.
TouchCalibrationPair
תכונות
-
displayPoint
הקואורדינטות של נקודת התצוגה.
-
touchPoint
הקואורדינטות של נקודת המגע שמתאימות לנקודת התצוגה.
TouchCalibrationPairQuad
תכונות
-
pair1
נדרש צמד ראשון של נקודת מגע ונקודת תצוגה לכיול המגע.
-
pair2
זוג שני של נקודות מגע ונקודת תצוגה נדרש לכיול המגע.
-
pair3
נדרש זוג שלישי של נקודות מגע ונקודת תצוגה לכיול המגע.
-
pair4
נדרש זוג רביעי של נקודות מגע ונקודת תצוגה לכיול המגע.
שיטות
clearTouchCalibration()
chrome.system.display.clearTouchCalibration(
id: string,
)
איפוס של כיול המגע עבור המסך והחזרת המכשיר למצב ברירת המחדל על ידי ניקוי נתוני כיול המגע המשויכים למסך.
פרמטרים
-
id
מחרוזת
המזהה הייחודי של המסך.
completeCustomTouchCalibration()
chrome.system.display.completeCustomTouchCalibration(
pairs: TouchCalibrationPairQuad,
bounds: Bounds,
)
מגדירה את זוגות כיול המגע עבור מסך. הpairs
האלה ישמשו לכיול מסך המגע לתצוגה עם id
שנקרא startCustomTouchCalibration(). צריך תמיד לקרוא ל-startCustomTouchCalibration
לפני שמפעילים את השיטה הזו. אם כבר מתבצע כיול מגע אחר, תופיע הודעת שגיאה.
פרמטרים
-
זוגות
זוגות הנקודות ששימשו לכיול המסך.
-
גבולות
הגבולות של המסך כשבוצע כיול המגע. המערכת מתעלמת מהערכים
bounds.left
ו-bounds.top
.
enableUnifiedDesktop()
chrome.system.display.enableUnifiedDesktop(
enabled: boolean,
)
הפעלה/השבתה של תכונת שולחן העבודה המאוחד. אם הסנכרון פועל בזמן ששיקוף המסך פעיל, מצב שולחן העבודה לא ישתנה עד לכיבוי השיקוף. אחרת, מצב שולחן העבודה יעבור למצב מאוחד באופן מיידי. הערה: האפשרות הזו זמינה רק באפליקציות "קיוסק" של ChromeOS ובממשק המשתמש באינטרנט.
פרמטרים
-
פעיל
boolean
True אם צריך להפעיל את שולחן העבודה המאוחד.
getDisplayLayout()
chrome.system.display.getDisplayLayout(
callback?: function,
)
התכונה מבקשת את פרטי הפריסה של כל המסכים. הערה: האפשרות הזו זמינה רק באפליקציות "קיוסק" של ChromeOS ובממשק המשתמש באינטרנט.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:(layouts: DisplayLayout[]) => void
-
פריסות
-
החזרות
-
Promise<DisplayLayout[]>
Chrome 91 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
getInfo()
chrome.system.display.getInfo(
flags?: GetInfoFlags,
callback?: function,
)
המערכת מבקשת את המידע לגבי כל המסכים המחוברים.
פרמטרים
-
דגלים
GetInfoFlags אופציונלי
Chrome 59 ומעלהאפשרויות שמשפיעות על אופן החזרת המידע.
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:(displayInfo: DisplayUnitInfo[]) => void
-
displayInfo
-
החזרות
-
Promise<DisplayUnitInfo[]>
Chrome 91 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
overscanCalibrationAdjust()
chrome.system.display.overscanCalibrationAdjust(
id: string,
delta: Insets,
)
התאמת התוספות הנוכחיות של סריקות היתר במסך. בדרך כלל פעולה זו צריכה להזיז את התצוגה לאורך ציר (למשל, לשמאל-ימין יש אותו ערך) או לשנות את גודלה לאורך ציר (למשל, לחלק העליון+תחתון יש ערכים הפוכים). כל הפעלת Adjust נצברת עם קריאות קודמות מאז ההתחלה.
פרמטרים
-
id
מחרוזת
המזהה הייחודי של המסך.
-
delta
הסכום שיש לשנות את insets של סריקת היתר.
overscanCalibrationComplete()
chrome.system.display.overscanCalibrationComplete(
id: string,
)
השלמת התאמות של סריקת יתר עבור תצוגה על ידי שמירת הערכים הנוכחיים והסתרת שכבת-העל.
פרמטרים
-
id
מחרוזת
המזהה הייחודי של המסך.
overscanCalibrationReset()
chrome.system.display.overscanCalibrationReset(
id: string,
)
איפוס ההגדרות של סריקת יתר של תצוגה לערך האחרון שנשמר (כלומר לפני הקריאה ל-Start).
פרמטרים
-
id
מחרוזת
המזהה הייחודי של המסך.
overscanCalibrationStart()
chrome.system.display.overscanCalibrationStart(
id: string,
)
מתחיל כיול סריקת יתר למסך. פעולה זו תציג במסך שכבת-על שמציינת את תוספות היתר הנוכחיות. אם מתבצע כיול סריקת יתר עבור המסך id
, מתבצע איפוס של כיול.
פרמטרים
-
id
מחרוזת
המזהה הייחודי של המסך.
setDisplayLayout()
chrome.system.display.setDisplayLayout(
layouts: DisplayLayout[],
callback?: function,
)
הגדרת הפריסה של כל המסכים. כל המסכים שלא כלולים יכללו בפריסת ברירת המחדל. אם יש פריסה חופפת או לא חוקית מסיבה אחרת, היא תותאם לפריסה חוקית. לאחר תיקון הפריסה, יופעל אירוע onDisplayChanged. הערה: האפשרות הזו זמינה רק באפליקציות "קיוסק" של ChromeOS ובממשק המשתמש באינטרנט.
פרמטרים
-
פריסות
פרטי הפריסה, הנדרשים לכל המסכים, חוץ מהמסך הראשי.
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:() => void
החזרות
-
Promise<void>
Chrome 91 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
setDisplayProperties()
chrome.system.display.setDisplayProperties(
id: string,
info: DisplayProperties,
callback?: function,
)
עדכון המאפיינים של התצוגה שצוינה על ידי id
, בהתאם למידע שסופק ב-info
. אם הפעולה תיכשל, המערכת תגדיר את runtime.lastError
. הערה: האפשרות הזו זמינה רק באפליקציות "קיוסק" של ChromeOS ובממשק המשתמש באינטרנט.
פרמטרים
-
id
מחרוזת
המזהה הייחודי של המסך.
-
מידע
המידע על מאפייני תצוגה שצריך לשנות. מאפיין ישתנה רק אם יצוין ערך חדש עבורו ב-
info
. -
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:() => void
החזרות
-
Promise<void>
Chrome 91 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
setMirrorMode()
chrome.system.display.setMirrorMode(
info: MirrorModeInfo,
callback?: function,
)
הגדרת מצב התצוגה למצב השתקפות שצוין. כל שיחה מאפסת את המצב של שיחות קודמות. הקריאה ל-setDisplayProperties() תיכשל במסכים של יעדי שיקוף המסך. הערה: האפשרות הזו זמינה רק באפליקציות "קיוסק" של ChromeOS ובממשק המשתמש באינטרנט.
פרמטרים
-
מידע
המידע על מצב המראה שצריך להחיל על מצב התצוגה.
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:() => void
החזרות
-
Promise<void>
Chrome 91 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
showNativeTouchCalibration()
chrome.system.display.showNativeTouchCalibration(
id: string,
callback?: function,
)
מציג את חוויית המשתמש של כיול המגע המקורי של המסך, כאשר מזהה התצוגה הוא id
. תוצג במסך שכבת-על עם ההוראות הנדרשות להמשך. הקריאה החוזרת תופעל רק במקרה של כיול מוצלח. אם הכיול ייכשל, תופיע הודעת שגיאה.
פרמטרים
-
id
מחרוזת
המזהה הייחודי של המסך.
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:(success: boolean) => void
-
הצלחה
boolean
-
החזרות
-
Promise<boolean>
Chrome 91 ומעלההבטחות נתמכות רק במניפסט מגרסה V3 ואילך. בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).
startCustomTouchCalibration()
chrome.system.display.startCustomTouchCalibration(
id: string,
)
מתחיל כיול מגע מותאם אישית עבור מסך. צריך להפעיל את השיטה הזו כשמשתמשים בחוויית משתמש בהתאמה אישית לאיסוף נתוני כיול. אם כבר מתבצע כיול מגע אחר, תופיע הודעת שגיאה.
פרמטרים
-
id
מחרוזת
המזהה הייחודי של המסך.
אירועים
onDisplayChanged
chrome.system.display.onDisplayChanged.addListener(
callback: function,
)
מופעל כשמשהו משתנה בתצורת המסך.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:() => void