chrome.system.display

תיאור

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

הרשאות

system.display

סוגים

ActiveState

Chrome 117 ואילך

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

Enum

"פעיל"

"לא פעיל"

Bounds

מאפיינים

  • גובה

    number

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

  • שמאלי

    number

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

  • עליון

    number

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

  • רוחב

    number

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

DisplayLayout

Chrome 53+

מאפיינים

  • id [מזהה]

    מחרוזת

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

  • לקזז

    number

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

  • parentId

    מחרוזת

    המזהה הייחודי של מסך ההורה. ריק אם זהו השורש.

  • position

    LayoutPosition

    מיקום הפריסה של המסך הזה ביחס לתבנית ההורה. המערכת תתעלם ממנו עבור הרמה הבסיסית (root).

DisplayMode

Chrome 52+

מאפיינים

  • deviceScaleFactor

    number

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

  • גובה

    number

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

  • heightInNativePixels

    number

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

  • isInterlaced

    ערך בוליאני אופציונלי

    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+

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

  • ראשי

    ערך בוליאני אופציונלי

    אם המדיניות מוגדרת כ-True, המסך יהיה ראשי. No-op אם המדיניות מוגדרת כ-False. הערה: אם המדיניות מוגדרת, התצוגה תיחשב כראשית עבור כל שאר הנכסים (כלומר, יכול להיות שהערך isUnified יוגדר וייתכן שמקור הגבולות לא יוגדר).

  • isUnified

    ערך בוליאני אופציונלי

    Chrome 59+

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

  • mirroringSourceId

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

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

    שימוש ב-setMirrorMode.

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

  • סריקת יתר

    תוספות תוכן אופציונליות

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

  • סבב

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

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

DisplayUnitInfo

מאפיינים

  • activeState

    ActiveState

    Chrome 117 ואילך

    התכונה פעילה אם המערכת מזהה את המסך ומשתמשת בו.

  • availableDisplayZoomFactors

    מספר[]

    Chrome 67 ואילך

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

  • גבולות

    גבולות

    הגבולות הלוגיים של התצוגה.

  • displayZoomFactor

    number

    Chrome 65+

    היחס בין מרחק התצוגה הנוכחי לבין מרחק התצוגה שמוגדר כברירת מחדל. לדוגמה, ערך 1 מקביל לזום של 100%, וערך 1.5 זהה לזום של 150%.

  • dpiX

    number

    מספר הפיקסלים לאינץ' לאורך ציר ה-X.

  • dpiY

    number

    מספר הפיקסלים לאינץ' לאורך ציר ה-Y.

  • EDID

    Edid אופציונלי

    Chrome 67 ואילך

    הערה: האפשרות הזו זמינה רק לאפליקציות "קיוסק" של Chrome OS ולממשק המשתמש באינטרנט.

  • hasTouchSupport

    בוליאני

    Chrome 57 ומעלה

    הערך הוא True אם למסך הזה משויך מכשיר לקלט מגע.

  • id [מזהה]

    מחרוזת

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

  • isEnabled

    בוליאני

    True אם המסך הזה מופעל.

  • ראשי

    בוליאני

    True אם זהו המסך הראשי.

  • isUnified

    בוליאני

    Chrome 59+

    True לכל המסכים במצב שולחן עבודה מאוחד. עיון במסמכי התיעוד של enableUnifiedDesktop.

  • mirroringDestinationIds

    String[]

    Chrome מגרסה 64 ואילך

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

  • mirroringSourceId

    מחרוזת

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

  • אמצעי הגעה

    DisplayMode[]

    Chrome 52+

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

  • שם

    מחרוזת

    שם ידידותי למשתמש (למשל, "צג HP LCD").

  • סריקת יתר

    תוספות תוכן

    כניסת המסך לגבולות המסך. גלויה כרגע רק ב-ChromeOS. תוגדר להתקנות ריקות בפלטפורמות אחרות.

  • סבב

    number

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

  • workArea

    גבולות

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

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

    ערך בוליאני אופציונלי

    אם המדיניות מוגדרת כ-True, רק DisplayUnitInfo יחיד יוחזר על ידי getInfo במצב של שולחן עבודה מאוחד (ראו enableUnifiedDesktop). ברירת המחדל היא False.

Insets

מאפיינים

  • תחתון

    number

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

  • שמאלי

    number

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

  • ימני

    number

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

  • עליון

    number

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

LayoutPosition

Chrome 53+

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

Enum

"למעלה"

"ימין"

"למטה"

"שמאל"

MirrorMode

Chrome 65+

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

Enum

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

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

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

MirrorModeInfo

Chrome 65+

מאפיינים

  • mirroringDestinationIds

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

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

  • mirroringSourceId

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

    המזהה של תצוגת המקור המשקף. תקף רק לקטע 'מעורב'.

  • מצב

    MirrorMode

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

Point

Chrome 57 ומעלה

מאפיינים

  • x

    number

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

  • y

    number

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

TouchCalibrationPair

Chrome 57 ומעלה

מאפיינים

  • displayPoint

    נקודה

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

  • touchPoint

    נקודה

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

TouchCalibrationPairQuad

Chrome 57 ומעלה

מאפיינים

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

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

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

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

שיטות

clearTouchCalibration()

Chrome 57 ומעלה 
chrome.system.display.clearTouchCalibration(
  id: string,
)

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

פרמטרים

  • id [מזהה]

    מחרוזת

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

completeCustomTouchCalibration()

Chrome 57 ומעלה 
chrome.system.display.completeCustomTouchCalibration(
  pairs: TouchCalibrationPairQuad,
  bounds: Bounds,
)

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

פרמטרים

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

  • גבולות

    גבולות

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

enableUnifiedDesktop()

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

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

פרמטרים

  • פעיל

    בוליאני

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

getDisplayLayout()

הבטחה Chrome 53 ואילך 
chrome.system.display.getDisplayLayout(
  callback?: function,
)

המערכת תבקש את פרטי הפריסה בכל המסכים. הערה: האפשרות הזו זמינה רק לאפליקציות "קיוסק" של Chrome OS ולממשק המשתמש באינטרנט.

פרמטרים

  • קריאה חוזרת (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

החזרות

  • Promise<DisplayUnitInfo[]>

    Chrome מגרסה 91 ואילך

    הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

overscanCalibrationAdjust()

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

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

פרמטרים

  • id [מזהה]

    מחרוזת

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

  • הסכום לשינוי ערכי inscan.

overscanCalibrationComplete()

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

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

פרמטרים

  • id [מזהה]

    מחרוזת

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

overscanCalibrationReset()

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

מאפס את הרכיבים הפנימיים של סריקת יתר במסך לערך האחרון שנשמר (כלומר לפני הקריאה להתחלה).

פרמטרים

  • id [מזהה]

    מחרוזת

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

overscanCalibrationStart()

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

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

פרמטרים

  • id [מזהה]

    מחרוזת

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

setDisplayLayout()

הבטחה Chrome 53 ואילך 
chrome.system.display.setDisplayLayout(
  layouts: DisplayLayout[],
  callback?: function,
)

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

פרמטרים

  • פריסות

    DisplayLayout[]

    פרטי הפריסה, שנדרשים לכל המסכים, מלבד המסך הראשי.

  • קריאה חוזרת (callback)

    פונקציה אופציונלית

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

    () => void

החזרות

  • הבטחה<Empty>

    Chrome מגרסה 91 ואילך

    הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

setDisplayProperties()

הבטחה 
chrome.system.display.setDisplayProperties(
  id: string,
  info: DisplayProperties,
  callback?: function,
)

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

פרמטרים

  • id [מזהה]

    מחרוזת

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

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

  • קריאה חוזרת (callback)

    פונקציה אופציונלית

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

    () => void

החזרות

  • הבטחה<Empty>

    Chrome מגרסה 91 ואילך

    הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

setMirrorMode()

הבטחה Chrome מגרסה 65 ואילך 
chrome.system.display.setMirrorMode(
  info: MirrorModeInfo,
  callback?: function,
)

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

פרמטרים

  • מידע

    MirrorModeInfo

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

  • קריאה חוזרת (callback)

    פונקציה אופציונלית

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

    () => void

החזרות

  • הבטחה<Empty>

    Chrome מגרסה 91 ואילך

    הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

showNativeTouchCalibration()

הבטחה Chrome 57 ואילך 
chrome.system.display.showNativeTouchCalibration(
  id: string,
  callback?: function,
)

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

פרמטרים

  • id [מזהה]

    מחרוזת

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

  • קריאה חוזרת (callback)

    פונקציה אופציונלית

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

    (success: boolean) => void

    • הצלחה

      בוליאני

החזרות

  • Promise&lt;boolean&gt;

    Chrome מגרסה 91 ואילך

    הבטחות נתמכות רק במניפסט מגרסה V3 ואילך, בפלטפורמות אחרות צריך להשתמש בקריאות חוזרות (callback).

startCustomTouchCalibration()

Chrome 57 ומעלה 
chrome.system.display.startCustomTouchCalibration(
  id: string,
)

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

פרמטרים

  • id [מזהה]

    מחרוזת

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

אירועים

onDisplayChanged

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

מופעל כשמשהו משתנה בתצורת המסך.

פרמטרים

  • קריאה חוזרת (callback)

    פונקציה

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

    () => void