browser.system.display

תיאור

אפשר להשתמש ב-system.display API כדי לשלוח שאילתות לגבי מטא-נתונים מוצגים.

הרשאות

system.display

סוגים

ActiveState

‫Chrome 117 ואילך

ערך enum שקובע אם המערכת מזהה את התצוגה ומשתמשת בה. המסך נחשב 'לא פעיל' אם המערכת לא מזהה אותו (יכול להיות שהוא מנותק, או שהוא נחשב מנותק בגלל מצב שינה וכו'). המצב הזה משמש לשמירת התצוגה הקיימת כשכל המסכים מנותקים, למשל.

ספירה

‫'active'

'לא פעיל'

Bounds

מאפיינים

  • גובה

    number

    גובה המסך בפיקסלים.

  • שמאלה

    number

    הקואורדינטה x של הפינה השמאלית העליונה.

  • עליון

    number

    הקואורדינטה y של הפינה השמאלית העליונה.

  • רוחב

    number

    רוחב המסך בפיקסלים.

DisplayLayout

‫Chrome 53 ואילך

מאפיינים

  • id [מזהה]

    מחרוזת

    המזהה הייחודי של התצוגה.

  • לקזז

    number

    ההיסט של התצוגה לאורך הקצה המחובר. ‫0 מציין שהפינות העליונות או השמאליות ביותר מיושרות.

  • parentId

    מחרוזת

    המזהה הייחודי של התצוגה הראשית. ריק אם זה השורש.

  • position

    LayoutPosition

    מיקום הפריסה של התצוגה הזו ביחס לאלמנט האב. המערכת תתעלם מההגדרה הזו ברמת השורש.

DisplayMode

‫Chrome 52 ואילך

מאפיינים

  • deviceScaleFactor

    number

    הגורם לקביעת קנה המידה של המכשיר במצב התצוגה.

  • גובה

    number

    גובה מצב התצוגה בפיקסלים שאינם תלויים במכשיר (פיקסלים שגלויים למשתמש).

  • heightInNativePixels

    number

    גובה מצב התצוגה בפיקסלים מקוריים.

  • isInterlaced

    ‫boolean אופציונלי

    ‫Chrome 74 ואילך

    הערך True אם המצב הזה הוא interlaced, הערך False אם לא צוין.

  • isNative

    בוליאני

    הערך הוא True אם המצב הוא המצב המקורי של המסך.

  • isSelected

    בוליאני

    הערך True אם מצב התצוגה נבחר כרגע.

  • refreshRate

    number

    ‫Chrome 67 ואילך

    קצב הרענון של מצב התצוגה בהרץ.

  • 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 אופציונלי

    ‫Chrome 59+‎

    ‫ChromeOS בלבד. אם קובעים את ההגדרה True, מצב התצוגה משתנה למצב 'שולחן עבודה מאוחד' (פרטים נוספים מופיעים במאמר בנושא enableUnifiedDesktop). אם המדיניות מוגדרת כ-False, מצב שולחן העבודה המאוחד מושבת. ההגדרה הזו תקפה רק לגבי המסך הראשי. אם מציינים את המאפיין הזה, אסור לציין את המאפיין mirroringSourceId, והמערכת תתעלם ממאפיינים אחרים. אם לא מספקים את הערך הזה, אין לו השפעה.

  • mirroringSourceId

    מחרוזת אופציונלי

    הוצא משימוש מאז Chrome 68

    שימוש ב-setMirrorMode.

    ‫ChromeOS בלבד. אם ההגדרה מוגדרת ולא ריקה, היא מאפשרת שיקוף רק לתצוגה הזו. אחרת, שיקוף המסך מושבת בכל המסכים. הערך הזה צריך לציין את המזהה של תצוגת המקור לשיקוף, והוא לא יכול להיות זהה למזהה שמועבר אל setDisplayProperties. אם המאפיין הזה מוגדר, אי אפשר להגדיר מאפיינים אחרים.

  • סריקת יתר

    שוליים פנימיים אופציונלי

    אם ההגדרה הזו מוגדרת, היא קובעת את השוליים של ה-overscan בתצוגה לערכים שסופקו. שימו לב שערכי ה-overscan לא יכולים להיות שליליים או גדולים מחצי מגודל המסך. אי אפשר לשנות את ה-Overscan במסך הפנימי.

  • סיבוב

    מספר אופציונלי

    אם ההגדרה מוגדרת, היא מעדכנת את סיבוב התצוגה. הערכים החוקיים הם [0, 90, 180, 270]. הסיבוב מוגדר בכיוון השעון, ביחס למצב האנכי של המסך.

DisplayUnitInfo

מאפיינים

  • activeState

    ActiveState

    ‫Chrome 117 ואילך

    פעיל אם המערכת מזהה את הצג ומשתמשת בו.

  • availableDisplayZoomFactors

    number[]

    ‫Chrome 67 ואילך

    רשימה של ערכי גורם שינוי הגודל שאפשר להגדיר לתצוגה.

  • גבולות

    Bounds

    הגבולות הלוגיים של המסך.

  • 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

    בוליאני

    ‫Chrome 59+‎

    הערך הוא True לכל המסכים כשמצב Unified Desktop מופעל. אפשר לעיין במסמכי התיעוד של enableUnifiedDesktop.

  • mirroringDestinationIds

    string[]

    ‫Chrome 64+‎

    ‫ChromeOS בלבד. מזהים של המסכים שבהם מוצג שיקוף של מסך המקור. השדה ריק אם לא מתבצע שיקוף של מסכים. הערך הזה יהיה זהה לכל התצוגות. הדוגמאות לא יכולות לכלול mirroringSourceId.

  • mirroringSourceId

    מחרוזת

    ‫ChromeOS בלבד. מזהה המסך שמשוכפל אם השכפול מופעל, אחרת הערך ריק. ההגדרה הזו תהיה תקפה לכל המסכים (כולל המסך שמשוכפל).

  • מצבים

    DisplayMode[]

    ‫Chrome 52 ואילך

    רשימת מצבי התצוגה הזמינים. המאפיין isSelected=true יופיע במצב הנוכחי. התכונה זמינה רק ב-ChromeOS. בפלטפורמות אחרות, הערך יהיה מערך ריק.

  • שם

    מחרוזת

    השם הידידותי למשתמש (לדוגמה, 'HP LCD monitor').

  • סריקת יתר

    שוליים פנימיים

    השוליים הפנימיים של הצג בתוך הגבולות של המסך. התכונה הזו זמינה כרגע רק ב-ChromeOS. בפלטפורמות אחרות, הערך יהיה ריק.

  • סיבוב

    number

    סיבוב המסך בכיוון השעון במעלות ביחס למיקום האנכי. התכונה הזו זמינה כרגע רק ב-ChromeOS. בפלטפורמות אחרות, הערך יהיה 0. ערך של ‎-1 יפורש כסיבוב אוטומטי כשהמכשיר במצב פיזי של טאבלט.

  • workArea

    Bounds

    אזור העבודה שניתן לשימוש בצג, בתוך גבולות הצג. האזור 'הצגת העבודה' לא כולל אזורים במסך ששמורים למערכת ההפעלה, למשל סרגל האפליקציות והמרכז לשליטה באפליקציות.

Edid

‫Chrome 67 ואילך

מאפיינים

  • 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

‫Chrome 59+‎

מאפיינים

  • singleUnified

    ‫boolean אופציונלי

    אם הערך מוגדר כ-true, רק DisplayUnitInfo אחד יוחזר על ידי getInfo כשמצב Unified Desktop מופעל (ראו enableUnifiedDesktop). ברירת המחדל היא false.

Insets

מאפיינים

  • תחתון

    number

    המרחק בציר ה-y מהגבול התחתון.

  • שמאלה

    number

    המרחק מציר ה-x מהגבול השמאלי.

  • ימינה

    number

    המרחק בציר ה-x מהגבול הימני.

  • עליון

    number

    המרחק בציר ה-y מהגבול העליון.

LayoutPosition

‫Chrome 53 ואילך

מיקום הפריסה, כלומר הקצה של רכיב ההורה שאליו הצג מחובר.

ספירה

‫"top"

"right"

"bottom"

"left"

MirrorMode

Chrome 65+

מצב השתקפות במראה, כלומר דרכים שונות לשיקוף של מסך למסכים אחרים.

ספירה

‫off
מציין את מצב ברירת המחדל (מצב מורחב או מצב מאוחד של שולחן העבודה).

‫normal
מציין שברירת המחדל של התצוגה במקור תשוכפל לכל שאר המסכים.

‫mixed
מציין שהתצוגה של המקור שצוין תשוכפל לתצוגות של היעד שצוינו. כל שאר המסכים המחוברים יורחבו.

MirrorModeInfo

Chrome 65+

מאפיינים

  • mirroringDestinationIds

    string[] אופציונלי

    המזהים של מסכי היעד של השיתוף. ההגדרה הזו תקפה רק לערך 'מעורב'.

  • mirroringSourceId

    מחרוזת אופציונלי

    המזהה של התצוגה של מקור השיקוף. ההגדרה הזו תקפה רק לערך 'מעורב'.

  • מצב

    MirrorMode

    מצב המראה שצריך להגדיר.

Point

‫Chrome 57 ואילך

מאפיינים

  • x

    number

    קואורדינטת ה-x של הנקודה.

  • y

    number

    קואורדינטת ה-y של הנקודה.

TouchCalibrationPair

‫Chrome 57 ואילך

מאפיינים

  • displayPoint

    נקודה

    הקואורדינטות של נקודת התצוגה.

  • touchPoint

    נקודה

    הקואורדינטות של נקודת המגע שמתאימות לנקודת התצוגה.

TouchCalibrationPairQuad

‫Chrome 57 ואילך

מאפיינים

  • הזוג הראשון של נקודת מגע ונקודת תצוגה שנדרש לכיול המגע.

  • נדרשת נקודה שנייה של מגע ותצוגה לכיול המגע.

  • נדרשת נקודה שלישית של מגע ותצוגה לכיול המגע.

  • נדרשת נקודת מגע ותצוגה רביעית כדי לכייל את המגע.

Methods

clearTouchCalibration()

‫Chrome 57 ואילך 
chrome.system.display.clearTouchCalibration(
  id: string,
): void

הערה: האפשרות הזו זמינה רק באפליקציות קיוסק של ChromeOS. מאפס את כיול המגע של המסך ומחזיר אותו למצב ברירת המחדל על ידי ניקוי כל נתוני כיול המגע שמשויכים למסך.

פרמטרים

  • id [מזהה]

    מחרוזת

    המזהה הייחודי של המסך.

completeCustomTouchCalibration()

‫Chrome 57 ואילך 
chrome.system.display.completeCustomTouchCalibration(
  pairs: TouchCalibrationPairQuad,
  bounds: Bounds,
): void

הערה: האפשרות הזו זמינה רק באפליקציות קיוסק של ChromeOS. הגדרת זוגות של כיול מגע לתצוגה. הערכים האלה של pairs ישמשו לכיול מסך המגע לתצוגה באמצעות id שמופעל ב-startCustomTouchCalibration(). תמיד צריך להפעיל את startCustomTouchCalibration לפני שמפעילים את ה-method הזו. אם כיול אחר של מסך מגע כבר מתבצע, תופיע שגיאה.

פרמטרים

  • זוגות הנקודות שמשמשים לכיול המסך.

  • גבולות

    Bounds

    הגבולות של המסך בזמן ביצוע הכיול של מסך המגע. המערכת מתעלמת מהערכים של bounds.left ושל bounds.top.

enableUnifiedDesktop()

‫Chrome 46 ואילך 
chrome.system.display.enableUnifiedDesktop(
  enabled: boolean,
): void

הערה: האפשרות הזו זמינה רק באפליקציות קיוסק של ChromeOS. הפעלה או השבתה של התכונה 'שולחן עבודה מאוחד'. אם התכונה מופעלת בזמן שהשיקוף פעיל, מצב שולחן העבודה לא ישתנה עד שהשיקוף יושבת. אחרת, מצב שולחן העבודה ישתנה מיד למצב מאוחד.

פרמטרים

  • פעיל

    בוליאני

    הערך יהיה True אם צריך להפעיל את שולחן העבודה המאוחד.

getDisplayLayout()

‫Chrome 53 ואילך 
chrome.system.display.getDisplayLayout(): Promise<DisplayLayout[]>

הערה: האפשרות הזו זמינה רק באפליקציות קיוסק של ChromeOS. בקשה לקבלת מידע על הפריסה של כל המסכים.

החזרות

  • Promise<DisplayLayout[]>

    ‫Chrome 91 ואילך

    הבטחה שמושלמת עם התוצאות.

getInfo()

chrome.system.display.getInfo(
  flags?: GetInfoFlags,
): Promise<DisplayUnitInfo[]>

בקשה לקבלת מידע על כל מכשירי התצוגה שמחוברים.

פרמטרים

  • דגלים

    ‫GetInfoFlags אופציונלי

    ‫Chrome 59+‎

    אפשרויות שמשפיעות על אופן החזרת המידע.

החזרות

  • Promise<DisplayUnitInfo[]>

    ‫Chrome 91 ואילך

    הבטחה שמושלמת עם התוצאות.

overscanCalibrationAdjust()

‫Chrome 53 ואילך 
chrome.system.display.overscanCalibrationAdjust(
  id: string,
  delta: Insets,
): void

הערה: האפשרות הזו זמינה רק באפליקציות קיוסק של ChromeOS. הגדרת השוליים של התצוגה שמוצגת. בדרך כלל, הערך הזה צריך להזיז את התצוגה לאורך ציר (למשל, הערכים של left+right זהים) או לשנות את קנה המידה שלה לאורך ציר (למשל, הערכים של top+bottom הפוכים). כל קריאה של Adjust היא מצטברת עם הקריאות הקודמות מאז ההפעלה.

פרמטרים

  • id [מזהה]

    מחרוזת

    המזהה הייחודי של המסך.

  • הסכום שבו יש לשנות את השוליים של אזור התצוגה.

overscanCalibrationComplete()

‫Chrome 53 ואילך 
chrome.system.display.overscanCalibrationComplete(
  id: string,
): void

הערה: האפשרות הזו זמינה רק באפליקציות קיוסק של ChromeOS. כדי להשלים את ההתאמות של ה-overscan בתצוגה, שומרים את הערכים הנוכחיים ומסתירים את שכבת-העל.

פרמטרים

  • id [מזהה]

    מחרוזת

    המזהה הייחודי של המסך.

overscanCalibrationReset()

‫Chrome 53 ואילך 
chrome.system.display.overscanCalibrationReset(
  id: string,
): void

הערה: האפשרות הזו זמינה רק באפליקציות קיוסק של ChromeOS. מאפס את השוליים של ה-overscan בתצוגה לערך האחרון שנשמר (כלומר, לפני שהופעלה הפונקציה Start).

פרמטרים

  • id [מזהה]

    מחרוזת

    המזהה הייחודי של המסך.

overscanCalibrationStart()

‫Chrome 53 ואילך 
chrome.system.display.overscanCalibrationStart(
  id: string,
): void

הערה: האפשרות הזו זמינה רק באפליקציות קיוסק של ChromeOS. מתחיל כיול של overscan בצג. תוצג שכבת-על במסך שתציין את שוליים הפנימיים הנוכחיים של ה-overscan. אם הכיול של ה-overscan בתצוגה id נמצא בתהליך, הפעולה הזו תאפס את הכיול.

פרמטרים

  • id [מזהה]

    מחרוזת

    המזהה הייחודי של המסך.

setDisplayLayout()

‫Chrome 53 ואילך 
chrome.system.display.setDisplayLayout(
  layouts: DisplayLayout[],
): Promise<void>

הערה: האפשרות הזו זמינה רק באפליקציות קיוסק של ChromeOS. הגדרת הפריסה לכל המסכים. כל תצוגה שלא נכללת תשתמש בפריסת ברירת המחדל. אם פריסה מסוימת חופפת לפריסה אחרת או לא תקינה מסיבה אחרת, היא תותאם לפריסה תקינה. אחרי שהפריסה תיפתר, יופעל אירוע onDisplayChanged.

פרמטרים

  • פריסות

    DisplayLayout[]

    מידע על הפריסה, שנדרש לכל התצוגות חוץ מהתצוגה הראשית.

החזרות

  • Promise<void>

    ‫Chrome 91 ואילך

    אובייקט Promise שמוחזר כשהפונקציה מסתיימת.

setDisplayProperties()

chrome.system.display.setDisplayProperties(
  id: string,
  info: DisplayProperties,
): Promise<void>

הערה: האפשרות הזו זמינה רק באפליקציות קיוסק של ChromeOS. מעדכן את המאפיינים של התצוגה שצוינה על ידי id, בהתאם למידע שסופק ב-info. אם הפעולה תיכשל, הערך runtime.lastError יוגדר.

פרמטרים

  • id [מזהה]

    מחרוזת

    המזהה הייחודי של המסך.

  • המידע על מאפייני התצוגה שצריך לשנות. מאפיין ישתנה רק אם צוין עבורו ערך חדש ב-info.

החזרות

  • Promise<void>

    ‫Chrome 91 ואילך

    אובייקט Promise שמוחזר כשהפונקציה מסתיימת.

setMirrorMode()

Chrome 65+ 
chrome.system.display.setMirrorMode(
  info: MirrorModeInfo,
): Promise<void>

הערה: האפשרות הזו זמינה רק באפליקציות קיוסק של ChromeOS. מגדיר את מצב התצוגה למצב השתקפות במראה שצוין. בכל שיחה, המצב מתאפס מהשיחות הקודמות. הקריאה ל-setDisplayProperties() תיכשל במסכים שמשמשים כיעד לשיקוף.

פרמטרים

  • מידע

    MirrorModeInfo

    המידע על מצב השיקוף שצריך להחיל על מצב התצוגה.

החזרות

  • Promise<void>

    ‫Chrome 91 ואילך

    אובייקט Promise שמוחזר כשהפונקציה מסתיימת.

showNativeTouchCalibration()

‫Chrome 57 ואילך 
chrome.system.display.showNativeTouchCalibration(
  id: string,
): Promise<boolean>

הערה: האפשרות הזו זמינה רק באפליקציות קיוסק של ChromeOS. הצגת חוויית המשתמש של כיול המגע המקורי במסך עם id כמזהה המסך. יוצג כיסוי על המסך עם ההוראות הנדרשות להמשך. ההתקשרות חזרה תופעל רק אם הכיול יצליח. אם הכיול ייכשל, תופיע שגיאה.

פרמטרים

  • id [מזהה]

    מחרוזת

    המזהה הייחודי של המסך.

החזרות

  • Promise<boolean>

    ‫Chrome 91 ואילך

    אובייקט promise שמוביל להודעה לפונקציית קריאה חוזרת (caller) שהכיול של מסך המגע הסתיים. הערך הבוליאני מציין אם הכיול הצליח או לא.

startCustomTouchCalibration()

‫Chrome 57 ואילך 
chrome.system.display.startCustomTouchCalibration(
  id: string,
): void

הערה: האפשרות הזו זמינה רק באפליקציות קיוסק של ChromeOS. מפעיל כיול מגע בהתאמה אישית למסך. צריך להפעיל את הפונקציה הזו כשמשתמשים בממשק משתמש מותאם אישית לאיסוף נתוני כיול. אם כיול אחר של מסך מגע כבר מתבצע, תופיע שגיאה.

פרמטרים

  • id [מזהה]

    מחרוזת

    המזהה הייחודי של המסך.

אירועים

onDisplayChanged

chrome.system.display.onDisplayChanged.addListener(
  callback: function,
)

מופעל כשמשהו משתנה בהגדרות התצוגה.

פרמטרים

  • callback

    פונקציה

    הפרמטר callback נראה כך: 

    () => void