תיאור
שימוש ב-system.display
API כדי לשלוח שאילתות לגבי מטא-נתונים של תצוגה.
הרשאות
system.display
סוגים
ActiveState
enum שמציין אם המערכת מזהה את המסך ומשתמשת בו. המסך נחשב ל'לא פעיל' אם המערכת לא מזהה אותו (יכול להיות שהוא מנותק או נחשב כמנותק בגלל מצב שינה וכו'). המצב הזה משמש לשמירת התצוגה הקיימת כשכל המסכים מנותקים, למשל.
טיפוסים בני מנייה (enum)
"active"
"inactive"
Bounds
מאפיינים
-
גובה
number
הגובה של המסך בפיקסלים.
-
נשארו
number
הקואורדינטה x של הפינה השמאלית העליונה.
-
עליון
number
הקואורדינטה y של הפינה השמאלית העליונה.
-
רוחב
number
רוחב המסך בפיקסלים.
DisplayLayout
מאפיינים
-
id [מזהה]
מחרוזת
המזהה הייחודי של המסך.
-
לקזז
number
ההיסט של המסך לאורך הקצה המחובר. הערך 0 מציין שהפינות העליונות או הימניות מיושרות.
-
parentId
מחרוזת
המזהה הייחודי של המסך ההורה. השדה הזה ריק אם מדובר ברמה הבסיסית (root).
-
position
מיקום הפריסה של התצוגה הזו ביחס להורה. המערכת תתעלם מהם ברמה הבסיסית.
DisplayMode
מאפיינים
-
deviceScaleFactor
number
הגורם לקביעת קנה המידה של המכשיר במצב התצוגה.
-
גובה
number
הגובה של מצב התצוגה בפיקסלים שאינם תלויים במכשיר (גלוי למשתמש).
-
heightInNativePixels
number
הגובה של רכיב התצוגה בפיקסלים מקומיים.
-
isInterlaced
boolean אופציונלי
Chrome מגרסה 74 ואילךהערך True אם המצב הזה הוא משולב, ו-False אם לא צוין.
-
isNative
בוליאני
הערך יהיה True אם המצב הוא המצב המקורי של המסך.
-
isSelected
בוליאני
הערך True אם מצב התצוגה מסומן כרגע.
-
refreshRate
number
Chrome מגרסה 67 ואילךקצב הרענון של מצב התצוגה ב-Hz.
-
uiScale
מספר אופציונלי
הופסקה השימוש ב-Chrome 70שימוש ב-
displayZoomFactor
הגורם לקביעת קנה המידה של ממשק המשתמש במצב התצוגה.
-
רוחב
number
רוחב מצב התצוגה בפיקסלים (גלוי למשתמש) ללא תלות במכשיר.
-
widthInNativePixels
number
רוחב מצב התצוגה בפיקסלים מקומיים.
DisplayProperties
מאפיינים
-
boundsOriginX
מספר אופציונלי
אם הערך מוגדר, הוא מעדכן את המקור של גבולות המסך הלוגי לאורך ציר ה-x. חל יחד עם
boundsOriginY
. אם הפרמטר לא מוגדר ו-boundsOriginY
מוגדר, ערך ברירת המחדל הוא הערך הנוכחי. חשוב לזכור שכאשר מעדכנים את מקור התצוגה, חלות מגבלות מסוימות, כך שמקור הגבולות הסופי עשוי להיות שונה מהמקור שהוגדר. אפשר לאחזר את הגבולות הסופיים באמצעותgetInfo
. לא ניתן לשנות את מקור הגבולות במסך הראשי. -
boundsOriginY
מספר אופציונלי
אם ההגדרה מוגדרת, היא מעדכנת את המקור של גבולות המסך הלוגיים לאורך ציר ה-y. מידע נוסף זמין במסמכי התיעוד של הפרמטר
boundsOriginX
. -
displayMode
DisplayMode אופציונלי
Chrome מגרסה 52 ואילךאם הערך מוגדר, מצב התצוגה מתעדכן למצב שמתאים לערך הזה. אם פרמטרים אחרים לא תקינים, המערכת לא תחיל את ההגדרה הזו. אם מצב התצוגה לא חוקי, הוא לא יחול ותופיע שגיאה, אבל נכסים אחרים עדיין יחולו.
-
displayZoomFactor
מספר אופציונלי
Chrome מגרסה 65 ואילךאם ההגדרה מוגדרת, היא מעדכנת את הזום המשויך לתצוגה. התכונה הזו מבצעת סידור מחדש וצביעת מחדש, וכך מקבלים איכות טובה יותר של התצוגה המוגדלת בהשוואה להגדלה פשוטה של התמונה על ידי מתיחה בפיקסלים.
-
isPrimary
boolean אופציונלי
אם הערך הוא True, המסך הופך להיות ראשי. אם האפשרות מוגדרת כ-False, לא מתבצעת פעולה כלשהי. הערה: אם ההגדרה מוגדרת, המסך נחשב לראשי בכל שאר המאפיינים (כלומר, אפשר להגדיר את
isUnified
ולא ניתן להגדיר את מקור הגבולות). -
isUnified
boolean אופציונלי
גרסה 59 ואילך של ChromeChromeOS בלבד. אם ההגדרה מוגדרת כ-True, מצב התצוגה משתנה למצב Unified Desktop (פרטים מופיעים בקטע
enableUnifiedDesktop
). אם המדיניות מוגדרת כ-False, מצב Unified Desktop יושבת. האפשרות הזו תקפה רק למסך הראשי. אם מציינים את המאפיין הזה, אסור לציין את המאפיין mirroringSourceId והמערכת תתעלם ממאפיינים אחרים. אם לא מציינים את השדה הזה, אין לו השפעה. -
mirroringSourceId
מחרוזת אופציונלי
הוצאה משימוש החל מ-Chrome 68משתמשים ב-
setMirrorMode
.ChromeOS בלבד. אם הערך מוגדר ולא ריק, ההשתקפות מופעלת במסך הזה בלבד. אחרת, ההשתקפות תושבת בכל המסכים. הערך הזה צריך לציין את המזהה של מסך המקור שרוצים לשקף. המזהה הזה לא יכול להיות זהה למזהה שהוענק ל-setDisplayProperties. אם המאפיין מוגדר, לא ניתן להגדיר מאפיין אחר.
-
סריקת יתר
Insets אופציונלי
אם הערך מוגדר, הוא מגדיר את הקטעים הנוספים של תצוגת ה-overscan לפי הערכים שצוינו. הערה: ערכי 'הגדלת התצוגה' לא יכולים להיות שליליים או גדולים מחצי גודל המסך. אי אפשר לשנות את ה-overscan במסך הפנימי.
-
רוטציה
מספר אופציונלי
אם ההגדרה מוגדרת, היא מעדכנת את סיבוב המסך. הערכים החוקיים הם [0, 90, 180, 270]. הסיבוב מוגדר בכיוון השעון, ביחס למיקום האנכי של המסך.
DisplayUnitInfo
מאפיינים
-
activeStateגרסה 117 ואילך של Chrome
המצב פעיל אם המסך מזוהה והמערכת משתמשת בו.
-
availableDisplayZoomFactors
number[]
Chrome מגרסה 67 ואילךרשימה של ערכי גורם ההגדלה שאפשר להגדיר במסך.
-
גבולות
הגבולות הלוגיים של המסך.
-
displayZoomFactor
number
Chrome מגרסה 65 ואילךהיחס בין מרחק התצוגה הנוכחי לבין מרחק התצוגה שמוגדר כברירת מחדל. לדוגמה, הערך 1 שווה לזום של 100%, והערך 1.5 שווה לזום של 150%.
-
dpiX
number
מספר הפיקסלים לאינץ' לאורך ציר ה-x.
-
dpiY
number
מספר הפיקסלים לאינץ' לאורך ציר ה-y.
-
edid
Edid אופציונלי
Chrome מגרסה 67 ואילךהערה: האפשרות הזו זמינה רק לאפליקציות קיוסק ב-ChromeOS ולממשק המשתמש באינטרנט.
-
hasTouchSupport
בוליאני
Chrome מגרסה 57 ואילךהערך True אם למסך הזה משויך מכשיר קלט מגע.
-
id [מזהה]
מחרוזת
המזהה הייחודי של המסך.
-
isEnabled
בוליאני
הערך True אם המסך הזה מופעל.
-
isPrimary
בוליאני
הערך יהיה True אם זהו המסך הראשי.
-
isUnified
בוליאני
גרסה 59 ואילך של Chromeהערך True חל על כל המסכים במצב Unified Desktop. אפשר לעיין במסמכי התיעוד של
enableUnifiedDesktop
. -
mirroringDestinationIds
string[]
Chrome מגרסה 64 ואילךChromeOS בלבד. המזהים של המסכים שבהם מוצגת השתקפות של מסך המקור. השדה יהיה ריק אם לא מתבצעת שיקוף של מסכים. הערך הזה יוגדר לאותו ערך בכל המסכים. אסור לכלול את
mirroringSourceId
. -
mirroringSourceId
מחרוזת
ChromeOS בלבד. המזהה של המסך שמתבצעת בו שיקוף, אם השיקוף מופעל. אחרת, השדה ריק. ההגדרה הזו תוגדר לכל המסכים (כולל המסך שמוצגת בו ההשתקפות).
-
מצביםChrome מגרסה 52 ואילך
רשימת מצבי התצוגה הזמינים. במצב הנוכחי, הערך של isSelected יהיה true. התכונה הזו זמינה רק ב-ChromeOS. בפלטפורמות אחרות, הערך יוגדר למערך ריק.
-
שם
מחרוזת
השם הידידותי למשתמש (למשל, 'מסך LCD של HP').
-
סריקת יתר
החלק של המסך שמוגדר כחלק מהתצוגה. בשלב זה האפשרות הזו זמינה רק ב-ChromeOS. בפלטפורמות אחרות, הרכיב יוגדר כרכיב מוטמע ריק.
-
רוטציה
number
סיבוב המסך בכיוון השעון במעלות ביחס למצב האנכי. בשלב זה האפשרות הזו זמינה רק ב-ChromeOS. בפלטפורמות אחרות, הערך יהיה 0. הערך -1 יפורש כסיבוב אוטומטי כשהמכשיר נמצא במצב טאבלט פיזי.
-
workArea
אזור העבודה שאפשר להשתמש בו במסך, בתוך גבולות המסך. אזור העבודה לא כולל אזורים במסך ששמורים למערכת ההפעלה, למשל סרגל האפליקציות והמרכז להפעלת אפליקציות.
Edid
מאפיינים
-
manufacturerId
מחרוזת
קוד יצרן בן 3 תווים. ראו סעיף 3.4.1 בדף 21. חובה בגרסה 1.4.
-
productId
מחרוזת
קוד של 2 בייטים שהוקצה על ידי היצרן, סעיף 3.4.2, דף 21. חובה בגרסה 1.4.
-
yearOfManufacture
number
שנת היצרן, סעיף 3.4.4, דף 22. חובה בגרסה 1.4.
GetInfoFlags
מאפיינים
-
singleUnified
boolean אופציונלי
אם הערך מוגדר כ-true,
getInfo
תחזיר רקDisplayUnitInfo
אחד במצב Unified Desktop (ראוenableUnifiedDesktop
). ברירת המחדל היא false.
Insets
מאפיינים
-
תחתון
number
המרחק מציר ה-y מהגבול התחתון.
-
נשארו
number
המרחק מציר ה-x מהגבול הימני.
-
ימני
number
המרחק בקו x מהגבול הימני.
-
עליון
number
המרחק בציר y מהגבול העליון.
LayoutPosition
מיקום הפריסה, כלומר הקצה של הרכיב ההורה שאליו הצגה מצורפת.
טיפוסים בני מנייה (enum)
"top"
"right"
"bottom"
"left"
MirrorMode
מצב שיקוף, כלומר דרכים שונות לשיקוף מסך אחד למסכים אחרים.
טיפוסים בני מנייה (enum)
'off'
מציין את מצב ברירת המחדל (מצב מחשב מורחב או מצב Unified Desktop).
'normal'
מציין שצג המקור שמוגדר כברירת מחדל יועתק לכל שאר הצגים.
'mixed'
הערך הזה מציין שהתצוגה של המקור שצוינה תועתק לתצוגות היעד שצוינו. כל שאר המסכים המחוברים יורחבו.
MirrorModeInfo
מאפיינים
-
mirroringDestinationIds
string[] אופציונלי
המזהים של יעד ההשתקפות מוצגים. האפשרות הזו תקפה רק לאפשרות 'מעורב'.
-
mirroringSourceId
מחרוזת אופציונלי
המזהה של המסך של מקור ההשתקפות. האפשרות הזו תקפה רק לאפשרות 'מעורב'.
-
מצב
מצב המראה שצריך להגדיר.
Point
מאפיינים
-
x
number
קואורדינטת ה-x של הנקודה.
-
y
number
קואורדינטת ה-y של הנקודה.
TouchCalibrationPair
מאפיינים
-
displayPoint
הקואורדינטות של נקודת התצוגה.
-
touchPoint
הקואורדינטות של נקודת המגע שתואמות לנקודת התצוגה.
TouchCalibrationPairQuad
מאפיינים
-
pair1
הצמד הראשון של נקודת מגע ונקודת תצוגה שנדרש לצורך כיול המגע.
-
pair2
נדרש זוג שני של נקודות מגע ומסך כדי לבצע כיול מגע.
-
pair3
נקודה שלישית של מסך ונקודה שלישית של מגע נדרשות לצורך כיול המגע.
-
pair4
רביעיית הנקודות הרביעית של נקודת המגע והמסך הנדרשת לכיול המגע.
Methods
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 ולממשק המשתמש באינטרנט.
פרמטרים
-
פעיל
בוליאני
הערך יהיה True אם צריך להפעיל את שולחן העבודה המאוחד.
getDisplayLayout()
chrome.system.display.getDisplayLayout(
callback?: function,
)
הבקשה מבקשת את פרטי הפריסה של כל המסכים. הערה: האפשרות הזו זמינה רק לאפליקציות קיוסק ב-ChromeOS ולממשק המשתמש באינטרנט.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:(layouts: DisplayLayout[]) => void
-
layouts
-
החזרות
-
Promise<DisplayLayout[]>
Chrome מגרסה 91 ואילךיש תמיכה ב-Promises רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.
getInfo()
chrome.system.display.getInfo(
flags?: GetInfoFlags,
callback?: function,
)
הבקשה מתייחסת לכל מסכי הווידאו המחוברים.
פרמטרים
-
דגלים
GetInfoFlags אופציונלי
Chrome מגרסה 59 ואילךאפשרויות שמשפיעות על האופן שבו המידע מוחזר.
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:(displayInfo: DisplayUnitInfo[]) => void
-
displayInfo
-
החזרות
-
Promise<DisplayUnitInfo[]>
Chrome מגרסה 91 ואילךיש תמיכה ב-Promises רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.
overscanCalibrationAdjust()
chrome.system.display.overscanCalibrationAdjust(
id: string,
delta: Insets,
)
שינוי של קטעי הקצה הנוכחיים של 'חיתוך יתר' במסך. בדרך כלל, צריך להזיז את התצוגה לאורך ציר (למשל, ל-left+right יש אותו ערך) או לשנות את קנה המידה שלה לאורך ציר (למשל, ל-top+bottom יש ערכים מנוגדים). כל קריאה ל-Adjust מצטברת עם הקריאות הקודמות מאז Start.
פרמטרים
-
id [מזהה]
מחרוזת
המזהה הייחודי של המסך.
-
delta
הסכום שמשמש לשינוי הקטעים הנוספים של החיתוך.
overscanCalibrationComplete()
chrome.system.display.overscanCalibrationComplete(
id: string,
)
כדי להשלים את ההתאמות של ה-overscan לתצוגה, שומרים את הערכים הנוכחיים ומסתירים את שכבת-העל.
פרמטרים
-
id [מזהה]
מחרוזת
המזהה הייחודי של המסך.
overscanCalibrationReset()
chrome.system.display.overscanCalibrationReset(
id: string,
)
איפוס של הקטעים הנוספים של עיוות התמונה (overscan) בתצוגה לערך האחרון שנשמר (כלומר, לפני הקריאה ל-Start).
פרמטרים
-
id [מזהה]
מחרוזת
המזהה הייחודי של המסך.
overscanCalibrationStart()
chrome.system.display.overscanCalibrationStart(
id: string,
)
הפונקציה מתחילה את תהליך הכיול של צג לצורך ביטול עיוותים. תוצג שכבת-על במסך שמציינת את קטעי ה-overscan הנוכחיים. אם מתבצע כיול של 'הגדלת התצוגה' במסך id
, הפעולה הזו תגרום לאיפוס הכיול.
פרמטרים
-
id [מזהה]
מחרוזת
המזהה הייחודי של המסך.
setDisplayLayout()
chrome.system.display.setDisplayLayout(
layouts: DisplayLayout[],
callback?: function,
)
מגדירים את הפריסה לכל המסכים. בכל תצוגה שלא תכלול את הרכיבים האלה, המערכת תשתמש בפריסה שמוגדרת כברירת מחדל. אם פריסה מסוימת חופפת לפריסה אחרת או לא תקינה מסיבה אחרת, היא תותאם לפריסה תקינה. אחרי שהפריסה תיפתר, יופעל האירוע onDisplayChanged. הערה: האפשרות הזו זמינה רק לאפליקציות קיוסק ב-ChromeOS ולממשק המשתמש באינטרנט.
פרמטרים
-
layouts
פרטי הפריסה, הנדרשים לכל המסכים מלבד המסך הראשי.
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:() => void
החזרות
-
Promise<void>
Chrome מגרסה 91 ואילךיש תמיכה ב-Promises רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.
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 ואילךיש תמיכה ב-Promises רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.
setMirrorMode()
chrome.system.display.setMirrorMode(
info: MirrorModeInfo,
callback?: function,
)
הגדרת מצב התצוגה למצב ההשתקפות שצוין. בכל שיחה, המצב מתאפס מהשיחות הקודמות. קריאה ל-setDisplayProperties() תיכשל במסכים של יעד ההשתקפות. הערה: האפשרות הזו זמינה רק לאפליקציות קיוסק ב-ChromeOS ולממשק המשתמש באינטרנט.
פרמטרים
-
מידע
המידע של מצב המראה שצריך להחיל על מצב התצוגה.
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:() => void
החזרות
-
Promise<void>
Chrome מגרסה 91 ואילךיש תמיכה ב-Promises רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.
showNativeTouchCalibration()
chrome.system.display.showNativeTouchCalibration(
id: string,
callback?: function,
)
הצגת חוויית המשתמש של כיול המגע המקורי של המסך עם id
כמזהה המסך. תוצג שכבת-על במסך עם הוראות לפעולות הנדרשות. הקריאה החוזרת תופעל רק אם הכיול יושלם בהצלחה. אם התאמת המכשיר תיכשל, תופיע שגיאה.
פרמטרים
-
id [מזהה]
מחרוזת
המזהה הייחודי של המסך.
-
קריאה חוזרת (callback)
פונקציה אופציונלי
הפרמטר
callback
נראה כך:(success: boolean) => void
-
הצלחה
בוליאני
-
החזרות
-
Promise<boolean>
Chrome מגרסה 91 ואילךיש תמיכה ב-Promises רק ב-Manifest V3 ואילך. בפלטפורמות אחרות צריך להשתמש ב-callbacks.
startCustomTouchCalibration()
chrome.system.display.startCustomTouchCalibration(
id: string,
)
הפעלת כיול מגע בהתאמה אישית של מסך. צריך להפעיל את הפונקציה הזו כשמשתמשים בממשק משתמש מותאם אישית לאיסוף נתוני כיול. אם כבר מתבצעת כיול מגע אחר, תופיע שגיאה.
פרמטרים
-
id [מזהה]
מחרוזת
המזהה הייחודי של המסך.
אירועים
onDisplayChanged
chrome.system.display.onDisplayChanged.addListener(
callback: function,
)
האירוע מופעל כשמשהו משתנה בהגדרות התצוגה.
פרמטרים
-
קריאה חוזרת (callback)
פונקציה
הפרמטר
callback
נראה כך:() => void