chrome.system.display

תיאור

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

הרשאות

system.display

סוגים

ActiveState

‫Chrome 117 ואילך

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

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 אם המצב הזה הוא שזור, הערך 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 אבל לא את bounds origin).

  • isUnified

    ‫boolean אופציונלי

    ‫Chrome 59 ואילך

    ‫ChromeOS בלבד. אם קובעים את ההגדרה True, מצב התצוגה משתנה למצב 'שולחן עבודה מאוחד' (פרטים נוספים מופיעים במאמר בנושא enableUnifiedDesktop). אם המדיניות מוגדרת כ-False, מצב Unified Desktop מושבת. ההגדרה הזו תקפה רק לגבי המסך הראשי. אם מציינים את המאפיין הזה, אסור לציין את המאפיין 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. בפלטפורמות אחרות, הערך יהיה מערך ריק.

  • שם

    מחרוזת

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

  • סריקת יתר

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

    השוליים הפנימיים של הצג בתוך הגבולות של המסך. נכון לעכשיו, היא זמינה רק ב-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+‎

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

Enum

"top"

"right"

"bottom"

"left"

MirrorMode

‫Chrome 65+‎

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

Enum

‫off
מציין את מצב ברירת המחדל (מצב מסך מורחב או מצב Unified Desktop).

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

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

MirrorModeInfo

‫Chrome 65+‎

מאפיינים

  • mirroringDestinationIds

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

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

  • mirroringSourceId

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

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

  • מצב

    MirrorMode

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

Point

‫Chrome 57 ואילך

מאפיינים

  • x

    number

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

  • y

    number

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

TouchCalibrationPair

‫Chrome 57 ואילך

מאפיינים

  • displayPoint

    Point

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

  • touchPoint

    Point

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

TouchCalibrationPairQuad

‫Chrome 57 ואילך

מאפיינים

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

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

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

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

Methods

clearTouchCalibration()

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

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

פרמטרים

  • id [מזהה]

    מחרוזת

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

completeCustomTouchCalibration()

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

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

פרמטרים

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

  • גבולות

    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 ולממשק משתמש באינטרנט.

החזרות

getInfo()

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

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

פרמטרים

  • דיווחים

    ‫GetInfoFlags אופציונלי

    ‫Chrome 59 ואילך

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

החזרות

overscanCalibrationAdjust()

‫Chrome 53+‎ 
chrome.system.display.overscanCalibrationAdjust(
  id: string,
  delta: Insets,
): void

ההגדרה הזו משנה את השוליים של ה-overscan הנוכחיים בתצוגה. בדרך כלל, הערך הזה צריך להזיז את התצוגה לאורך ציר (למשל, הערכים של left [שמאלה] ו-right [ימינה] זהים) או לשנות את הגודל שלה לאורך ציר (למשל, הערכים של top [למעלה] ו-bottom [למטה] הפוכים). כל קריאה ל-Adjust היא מצטברת עם הקריאות הקודמות מאז ההתחלה.

פרמטרים

  • id [מזהה]

    מחרוזת

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

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

overscanCalibrationComplete()

‫Chrome 53+‎ 
chrome.system.display.overscanCalibrationComplete(
  id: string,
): void

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

פרמטרים

  • id [מזהה]

    מחרוזת

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

overscanCalibrationReset()

‫Chrome 53+‎ 
chrome.system.display.overscanCalibrationReset(
  id: string,
): void

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

פרמטרים

  • id [מזהה]

    מחרוזת

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

overscanCalibrationStart()

‫Chrome 53+‎ 
chrome.system.display.overscanCalibrationStart(
  id: string,
): void

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

פרמטרים

  • id [מזהה]

    מחרוזת

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

setDisplayLayout()

‫Chrome 53+‎ 
chrome.system.display.setDisplayLayout(
  layouts: DisplayLayout[],
): Promise<void>

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

פרמטרים

  • פריסות

    DisplayLayout[]

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

החזרות

  • Promise<void>

    ‫Chrome 91 ואילך

setDisplayProperties()

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

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

פרמטרים

  • id [מזהה]

    מחרוזת

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

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

החזרות

  • Promise<void>

    ‫Chrome 91 ואילך

setMirrorMode()

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

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

פרמטרים

  • מידע

    MirrorModeInfo

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

החזרות

  • Promise<void>

    ‫Chrome 91 ואילך

showNativeTouchCalibration()

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

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

פרמטרים

  • id [מזהה]

    מחרוזת

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

החזרות

  • Promise<boolean>

    ‫Chrome 91 ואילך

startCustomTouchCalibration()

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

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

פרמטרים

  • id [מזהה]

    מחרוזת

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

אירועים

onDisplayChanged

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

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

פרמטרים

  • callback

    פונקציה

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

    () => void