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