توضیحات
از API system.display برای جستجوی فرادادههای نمایش استفاده کنید.
مجوزها
system.display انواع
ActiveState
یک enum برای تشخیص اینکه آیا نمایشگر توسط سیستم شناسایی و استفاده میشود یا خیر. اگر نمایشگر توسط سیستم شناسایی نشود (شاید قطع شده باشد، یا به دلیل حالت خواب و غیره قطع شده باشد و غیره) به عنوان "غیرفعال" در نظر گرفته میشود. این حالت برای حفظ نمایشگر موجود، به عنوان مثال، زمانی که همه نمایشگرها قطع شدهاند، استفاده میشود.
شمارشی
"فعال" «غیرفعال»
Bounds
خواص
- ارتفاع
شماره
ارتفاع نمایشگر بر حسب پیکسل.
- چپ
شماره
مختصات x گوشه بالا سمت چپ.
- بالا
شماره
مختصات y گوشه بالا سمت چپ.
- عرض
شماره
عرض نمایشگر بر حسب پیکسل.
DisplayLayout
خواص
- شناسه
رشته
شناسه منحصر به فرد نمایشگر.
- جبران
شماره
انحراف نمایشگر در امتداد لبه متصل. عدد ۰ نشان میدهد که بالاترین یا چپترین گوشهها تراز شدهاند.
- شناسه والدین
رشته
شناسه منحصر به فرد نمایشگر والد. اگر این ریشه باشد، خالی است.
- موقعیت
موقعیت چیدمان این عنصر نسبت به عنصر والد. این مورد برای عنصر ریشه نادیده گرفته میشود.
DisplayMode
خواص
- فاکتور مقیاس دستگاه
شماره
ضریب مقیاس دستگاه حالت نمایش.
- ارتفاع
شماره
ارتفاع حالت نمایش بر حسب پیکسلهای مستقل از دستگاه (قابل مشاهده توسط کاربر).
- heightInNativePixels
شماره
ارتفاع حالت نمایش بر حسب پیکسلهای اصلی.
- ای-اینترلیس
بولی اختیاری
کروم ۷۴+اگر این حالت در هم تنیده باشد، درست و اگر ارائه نشده باشد، نادرست است.
- بومی است
بولی
اگر حالت، حالت اصلی نمایشگر باشد، صحیح است.
- انتخاب شده است
بولی
اگر حالت نمایش در حال حاضر انتخاب شده باشد، صحیح است.
- نرخ تازهسازی
شماره
کروم ۶۷+نرخ تازهسازی حالت نمایش بر حسب هرتز.
- مقیاس ui
شماره اختیاری
از کروم ۷۰ منسوخ شده استاز
displayZoomFactorاستفاده کنیدضریب مقیاس رابط کاربری حالت نمایش.
- عرض
شماره
عرض حالت نمایش بر حسب پیکسلهای مستقل از دستگاه (قابل مشاهده توسط کاربر).
- widthInNativePixels
شماره
عرض حالت نمایش بر حسب پیکسلهای اصلی.
DisplayProperties
خواص
- boundsOriginX
شماره اختیاری
در صورت تنظیم، مبدأ مرزهای منطقی نمایشگر را در امتداد محور x بهروزرسانی میکند. همراه با
boundsOriginYاعمال میشود. اگر تنظیم نشده باشد وboundsOriginYتنظیم شده باشد، به طور پیشفرض روی مقدار فعلی قرار میگیرد. توجه داشته باشید که هنگام بهروزرسانی مبدأ نمایش، برخی محدودیتها اعمال میشوند، بنابراین مبدأ مرزهای نهایی ممکن است با مجموعه واحد متفاوت باشد. مرزهای نهایی را میتوان با استفادهgetInfoبازیابی کرد. مبدأ مرزها را نمیتوان در نمایشگر اصلی تغییر داد. - مرزهامنشا
شماره اختیاری
در صورت تنظیم، مبدأ مرزهای منطقی نمایشگر را در امتداد محور y بهروزرسانی میکند. برای پارامتر
boundsOriginXبه مستندات مراجعه کنید. - حالت نمایش
حالت نمایش اختیاری
کروم ۵۲+اگر تنظیم شود، حالت نمایش را به حالتی که با این مقدار مطابقت دارد، بهروزرسانی میکند. اگر سایر پارامترها نامعتبر باشند، این اعمال نخواهد شد. اگر حالت نمایش نامعتبر باشد، اعمال نمیشود و خطایی تنظیم میشود، اما سایر ویژگیها همچنان اعمال میشوند.
- نمایش بزرگنمایی فاکتور
شماره اختیاری
کروم ۶۵+در صورت تنظیم، بزرگنمایی مرتبط با نمایشگر را بهروزرسانی میکند. این بزرگنمایی، طرحبندی و رنگآمیزی مجدد را انجام میدهد و در نتیجه بزرگنمایی با کیفیت بهتری نسبت به بزرگنمایی با کشش پیکسل به پیکسل ایجاد میکند.
- isPrimary
بولی اختیاری
اگر روی true تنظیم شود، display را اصلی میکند. اگر روی false تنظیم شود، no-op میشود. نکته: اگر تنظیم شود، display برای همه ویژگیهای دیگر اصلی در نظر گرفته میشود (یعنی
isUnifiedممکن است تنظیم شود و bounds origin ممکن است تنظیم نشود). - اییونیفای
بولی اختیاری
کروم ۵۹+فقط ChromeOS. اگر روی true تنظیم شود، حالت نمایش به دسکتاپ یکپارچه تغییر میکند (برای جزئیات بیشتر به
enableUnifiedDesktopمراجعه کنید). اگر روی false تنظیم شود، حالت دسکتاپ یکپارچه غیرفعال میشود. این فقط برای نمایشگر اصلی معتبر است. در صورت ارائه، mirroringSourceId نباید ارائه شود و سایر ویژگیها نادیده گرفته میشوند. اگر این مورد ارائه نشود، هیچ تاثیری ندارد. - شناسه منبع آینهای
رشته اختیاری
از زمان کروم ۶۸ منسوخ شده استاز
setMirrorModeاستفاده کنید.فقط ChromeOS. اگر تنظیم شده باشد و خالی نباشد، فقط برای این نمایشگر، قابلیت آینهسازی را فعال میکند. در غیر این صورت، قابلیت آینهسازی را برای همه نمایشگرها غیرفعال میکند. این مقدار باید شناسه نمایشگر منبع برای آینهسازی را نشان دهد، که نباید با شناسه ارسال شده به setDisplayProperties یکسان باشد. در صورت تنظیم، هیچ ویژگی دیگری نمیتواند تنظیم شود.
- اسکن بیش از حد
درج اختیاری
در صورت تنظیم، اندازهی overscan inset نمایشگر را روی مقادیر ارائه شده تنظیم میکند. توجه داشته باشید که مقادیر overscan نمیتوانند منفی یا بزرگتر از نصف اندازهی صفحه نمایش باشند. overscan را نمیتوان در مانیتور داخلی تغییر داد.
- چرخش
شماره اختیاری
در صورت تنظیم، چرخش صفحه نمایش را بهروزرسانی میکند. مقادیر مجاز عبارتند از [0، 90، 180، 270]. چرخش در جهت عقربههای ساعت، نسبت به موقعیت عمودی صفحه نمایش، تنظیم میشود.
DisplayUnitInfo
خواص
- حالت فعالکروم ۱۱۷+
اگر نمایشگر توسط سیستم شناسایی و استفاده شود، فعال میشود.
- نمایش/بزرگنمایی/فاکتورهای موجود
شماره[]
کروم ۶۷+فهرستی از مقادیر ضریب بزرگنمایی که میتوان برای نمایشگر تنظیم کرد.
- مرزها
مرزهای منطقی نمایشگر.
- نمایش بزرگنمایی فاکتور
شماره
کروم ۶۵+نسبت بین بزرگنمایی فعلی و پیشفرض نمایشگر. برای مثال، مقدار ۱ معادل بزرگنمایی ۱۰۰٪ و مقدار ۱.۵ معادل بزرگنمایی ۱۵۰٪ است.
- دیپیآی ایکس
شماره
تعداد پیکسلها در هر اینچ در امتداد محور x.
- نقطه در اینچ مربع
شماره
تعداد پیکسلها در هر اینچ در امتداد محور y.
- ادید
ادیت اختیاری
کروم ۶۷+توجه: این فقط برای برنامههای ChromeOS Kiosk و رابط کاربری وب در دسترس است.
- پشتیبانی لمسی دارد
بولی
کروم ۵۷+اگر این نمایشگر یک دستگاه ورودی لمسی مرتبط با خود داشته باشد، صحیح است.
- شناسه
رشته
شناسه منحصر به فرد نمایشگر.
- فعال شده است
بولی
اگر این نمایشگر فعال باشد، درست است.
- isPrimary
بولی
اگر این نمایشگر اصلی باشد، درست است.
- اییونیفای
بولی
کروم ۵۹+برای همه نمایشگرها در حالت دسکتاپ یکپارچه صادق است. برای
enableUnifiedDesktopبه مستندات مراجعه کنید. - mirroringDestinationIds
رشته[]
کروم ۶۴+فقط ChromeOS. شناسههای نمایشگرهایی که نمایشگر منبع در آنها منعکس میشود. اگر هیچ نمایشگری در حال انعکاس نباشد، خالی است. این مقدار برای همه نمایشگرها یکسان تنظیم میشود. این مقدار نباید شامل
mirroringSourceIdباشد. - شناسه منبع آینهای
رشته
فقط ChromeOS. شناسه نمایشگری که در صورت فعال بودن قابلیت آینهسازی، آینهای میشود، در غیر این صورت خالی است. این برای همه نمایشگرها (از جمله نمایشگری که آینهای میشود) تنظیم خواهد شد.
- حالتها
حالت نمایش []
کروم ۵۲+فهرست حالتهای نمایش موجود. حالت فعلی دارای مقدار isSelected=true خواهد بود. فقط در ChromeOS موجود است. در سایر پلتفرمها روی یک آرایه خالی تنظیم میشود.
- نام
رشته
نام کاربرپسند (مثلاً "مانیتور LCD اچپی").
- اسکن بیش از حد
حاشیههای نمایشگر در محدودهی خود صفحه قرار میگیرند. در حال حاضر فقط در ChromeOS نمایش داده میشوند. در سایر پلتفرمها روی حاشیههای خالی تنظیم خواهد شد.
- چرخش
شماره
چرخش ساعتگرد نمایشگر نسبت به موقعیت عمودی بر حسب درجه. در حال حاضر فقط در ChromeOS نمایش داده میشود. در سایر پلتفرمها روی ۰ تنظیم خواهد شد. مقدار -۱ وقتی دستگاه در حالت تبلت فیزیکی است، به عنوان چرخش خودکار تعبیر میشود.
- منطقه کاری
ناحیه کاری قابل استفاده نمایشگر در محدوده نمایشگر. ناحیه کاری شامل قسمتهایی از نمایشگر که برای سیستم عامل رزرو شدهاند، مانند نوار وظیفه و لانچر، نمیشود.
Edid
خواص
- شناسه سازنده
رشته
کد سازنده ۳ کاراکتری. به بخش ۳.۴.۱ صفحه ۲۱ مراجعه کنید. در نسخه ۱.۴ الزامی است.
- شناسه محصول
رشته
کد ۲ بایتی اختصاص داده شده توسط سازنده، بخش ۳.۴.۲ صفحه ۲۱. در نسخه ۱.۴ الزامی است.
- سال ساخت
شماره
سال تولید، بخش ۳.۴.۴ صفحه ۲۲. در نسخه ۱.۴ الزامی است.
GetInfoFlags
خواص
- تکواحدی
بولی اختیاری
اگر روی درست تنظیم شود، فقط یک
DisplayUnitInfoتوسطgetInfoدر حالت دسکتاپ یکپارچه بازگردانده میشود (بهenableUnifiedDesktopمراجعه کنید). پیشفرض روی نادرست است.
Insets
خواص
- پایین
شماره
فاصله محور y از حد پایین.
- چپ
شماره
فاصله محور x از حد چپ.
- درست
شماره
فاصله محور x از حد سمت راست.
- بالا
شماره
فاصله محور y از مرز بالایی.
LayoutPosition
موقعیت چیدمان، یعنی لبه والد که نمایشگر به آن متصل است.
شمارشی
"بالا" «درست» "پایین" «چپ»
MirrorMode
حالت آینهای، یعنی روشهای مختلف نمایش آینهای یک نمایشگر روی نمایشگرهای دیگر.
شمارشی
"خاموش" "عادی" "مختلط"
حالت پیشفرض (دسکتاپ توسعهیافته یا یکپارچه) را مشخص میکند.
مشخص میکند که نمایش منبع پیشفرض در تمام نمایشگرهای دیگر منعکس شود.
مشخص میکند که نمایشگر منبع مشخصشده، روی نمایشگرهای مقصد ارائهشده، منعکس شود. تمام نمایشگرهای متصل دیگر، گسترش خواهند یافت.
MirrorModeInfo
خواص
- mirroringDestinationIds
رشته[] اختیاری
شناسههای مقصد قرینهسازی نمایش داده میشوند. این فقط برای «مختلط» معتبر است.
- شناسه منبع آینهای
رشته اختیاری
شناسهی نمایشگر منبع آینهای. این فقط برای «ترکیبی» معتبر است.
- حالت
حالت آینهای که باید تنظیم شود.
Point
خواص
- ایکس
شماره
مختصات x نقطه.
- ی
شماره
مختصات y نقطه.
TouchCalibrationPair
TouchCalibrationPairQuad
خواص
- جفت1
برای کالیبراسیون لمسی، جفت اول نقاط لمسی و نمایشگر مورد نیاز است.
- جفت۲
جفت دوم نقاط لمسی و نمایشگر برای کالیبراسیون لمسی مورد نیاز است.
- جفت۳
برای کالیبراسیون لمسی، جفت سوم نقاط لمسی و نمایشگر مورد نیاز است.
- جفت۴
جفت چهارم نقاط لمسی و نمایشگر برای کالیبراسیون لمسی مورد نیاز است.
روشها
clearTouchCalibration()
chrome.system.display.clearTouchCalibration(
id: string,
): void
کالیبراسیون لمسی صفحه نمایش را مجدداً تنظیم میکند و با پاک کردن هرگونه داده کالیبراسیون لمسی مرتبط با صفحه نمایش، آن را به حالت پیشفرض خود برمیگرداند.
پارامترها
- شناسه
رشته
شناسه منحصر به فرد نمایشگر.
completeCustomTouchCalibration()
chrome.system.display.completeCustomTouchCalibration(
pairs: TouchCalibrationPairQuad,
bounds: Bounds,
): void
جفتهای کالیبراسیون لمسی را برای یک نمایشگر تنظیم میکند. این pairs برای کالیبره کردن صفحه لمسی برای نمایش با id که در startCustomTouchCalibration() فراخوانی میشود، استفاده میشوند. همیشه قبل از فراخوانی این متد، startCustomTouchCalibration فراخوانی کنید. اگر کالیبراسیون لمسی دیگری در حال انجام باشد، این متد خطا میدهد.
پارامترها
- جفتها
جفت نقاطی که برای کالیبره کردن صفحه نمایش استفاده میشوند.
- مرزها
مرزهای نمایشگر هنگام انجام کالیبراسیون لمسی. مقادیر
bounds.leftوbounds.topنادیده گرفته میشوند.
enableUnifiedDesktop()
chrome.system.display.enableUnifiedDesktop(
enabled: boolean,
): void
ویژگی دسکتاپ یکپارچه را فعال/غیرفعال میکند. اگر هنگام فعال بودن قابلیت آینهسازی فعال باشد، حالت دسکتاپ تا زمانی که آینهسازی خاموش نشود، تغییر نخواهد کرد. در غیر این صورت، حالت دسکتاپ بلافاصله به حالت یکپارچه تغییر خواهد کرد. توجه: این ویژگی فقط برای برنامههای ChromeOS Kiosk و رابط کاربری وب در دسترس است.
پارامترها
- فعال شده
بولی
اگر دسکتاپ یکپارچه باید فعال باشد، صحیح است.
getDisplayLayout()
chrome.system.display.getDisplayLayout(): Promise<DisplayLayout[]>
اطلاعات طرحبندی را برای همه نمایشگرها درخواست میکند. توجه: این فقط برای برنامههای ChromeOS Kiosk و رابط کاربری وب در دسترس است.
بازگشتها
قول < نمایش طرحبندی []>
کروم ۹۱+وعدهای که با نتایج حل میشود.
getInfo()
chrome.system.display.getInfo(
flags?: GetInfoFlags,
): Promise<DisplayUnitInfo[]>
اطلاعات مربوط به تمام دستگاههای نمایش متصل را درخواست میکند.
پارامترها
- پرچمها
GetInfoFlags اختیاری است
کروم ۵۹+گزینههایی که بر نحوهی بازگشت اطلاعات تأثیر میگذارند.
بازگشتها
قول < DisplayUnitInfo []>
کروم ۹۱+وعدهای که با نتایج حل میشود.
overscanCalibrationAdjust()
chrome.system.display.overscanCalibrationAdjust(
id: string,
delta: Insets,
): void
درجهای overscan فعلی را برای یک نمایشگر تنظیم میکند. معمولاً این کار باید یا نمایشگر را در امتداد یک محور حرکت دهد (مثلاً چپ + راست مقدار یکسانی داشته باشند) یا آن را در امتداد یک محور مقیاسبندی کند (مثلاً بالا + پایین مقادیر متضادی داشته باشند). هر فراخوانی Adjust با فراخوانیهای قبلی از زمان Start جمع میشود.
پارامترها
- شناسه
رشته
شناسه منحصر به فرد نمایشگر.
- دلتا
مقدار تغییر درجهای overscan.
overscanCalibrationComplete()
chrome.system.display.overscanCalibrationComplete(
id: string,
): void
با ذخیره مقادیر فعلی و پنهان کردن پوشش، تنظیمات overscan را برای یک نمایشگر کامل کنید.
پارامترها
- شناسه
رشته
شناسه منحصر به فرد نمایشگر.
overscanCalibrationReset()
chrome.system.display.overscanCalibrationReset(
id: string,
): void
مقادیر overscan insets برای یک نمایش را به آخرین مقدار ذخیره شده (یعنی قبل از فراخوانی Start) بازنشانی میکند.
پارامترها
- شناسه
رشته
شناسه منحصر به فرد نمایشگر.
overscanCalibrationStart()
chrome.system.display.overscanCalibrationStart(
id: string,
): void
کالیبراسیون overscan را برای یک نمایشگر شروع میکند. این کار یک پوشش روی صفحه نمایش نشان میدهد که نشانگر درجهای overscan فعلی است. اگر کالیبراسیون overscan برای id نمایشگر در حال انجام باشد، کالیبراسیون را بازنشانی میکند.
پارامترها
- شناسه
رشته
شناسه منحصر به فرد نمایشگر.
setDisplayLayout()
chrome.system.display.setDisplayLayout(
layouts: DisplayLayout[],
): Promise<void>
طرحبندی را برای همه نمایشگرها تنظیم کنید. هر نمایشگری که شامل نشود، از طرحبندی پیشفرض استفاده خواهد کرد. اگر یک طرحبندی همپوشانی داشته باشد یا به هر دلیلی نامعتبر باشد، به یک طرحبندی معتبر تنظیم میشود. پس از تعیین طرحبندی، یک رویداد onDisplayChanged فعال میشود. توجه: این فقط برای برنامههای ChromeOS Kiosk و رابط کاربری وب در دسترس است.
پارامترها
- طرح بندی ها
اطلاعات طرحبندی، که برای همه نمایشگرها به جز نمایشگر اصلی مورد نیاز است.
بازگشتها
قول<void>
کروم ۹۱+قولی که با پایان یافتن تابع، اجرا میشود.
setDisplayProperties()
chrome.system.display.setDisplayProperties(
id: string,
info: DisplayProperties,
): Promise<void>
ویژگیهای نمایشگر مشخصشده توسط id را طبق اطلاعات ارائهشده در info بهروزرسانی میکند. در صورت عدم موفقیت، runtime.lastError تنظیم خواهد شد. توجه: این فقط برای برنامههای ChromeOS Kiosk و رابط کاربری وب در دسترس است.
پارامترها
- شناسه
رشته
شناسه منحصر به فرد نمایشگر.
- اطلاعات
اطلاعات مربوط به ویژگیهای نمایشی که باید تغییر کنند. یک ویژگی فقط در صورتی تغییر میکند که مقدار جدیدی برای آن در
infoمشخص شده باشد.
بازگشتها
قول<void>
کروم ۹۱+قولی که با پایان یافتن تابع، اجرا میشود.
setMirrorMode()
chrome.system.display.setMirrorMode(
info: MirrorModeInfo,
): Promise<void>
حالت نمایش را روی حالت آینهای مشخصشده تنظیم میکند. هر فراخوانی، وضعیت را از فراخوانیهای قبلی بازنشانی میکند. فراخوانی setDisplayProperties() برای نمایشگرهای مقصد آینهای با شکست مواجه میشود. توجه: این فقط برای برنامههای ChromeOS Kiosk و رابط کاربری وب در دسترس است.
پارامترها
- اطلاعات
اطلاعات حالت آینهای که باید در حالت نمایش اعمال شود.
بازگشتها
قول<void>
کروم ۹۱+قولی که با پایان یافتن تابع، اجرا میشود.
showNativeTouchCalibration()
chrome.system.display.showNativeTouchCalibration(
id: string,
): Promise<boolean>
تجربه کاربری کالیبراسیون لمسی بومی را برای نمایشگری که id آن به عنوان شناسه نمایشگر (display id) تعیین شده است، نمایش میدهد. این یک پوشش روی صفحه نمایش با دستورالعملهای لازم در مورد نحوه ادامه کار نشان میدهد. فراخوانی فقط در صورت کالیبراسیون موفقیتآمیز فراخوانی میشود. اگر کالیبراسیون با شکست مواجه شود، این باعث ایجاد خطا میشود.
پارامترها
- شناسه
رشته
شناسه منحصر به فرد نمایشگر.
بازگشتها
قول <boolean>
کروم ۹۱+قولی که به تماسگیرنده اطلاع میدهد که کالیبراسیون لمسی به پایان رسیده است. مقدار بولی اطلاع میدهد که آیا کالیبراسیون موفقیتآمیز بوده است یا خیر.
startCustomTouchCalibration()
chrome.system.display.startCustomTouchCalibration(
id: string,
): void
کالیبراسیون لمسی سفارشی را برای یک صفحه نمایش شروع میکند. این باید هنگام استفاده از یک UX سفارشی برای جمعآوری دادههای کالیبراسیون فراخوانی شود. اگر کالیبراسیون لمسی دیگری در حال انجام باشد، این خطا را نشان میدهد.
پارامترها
- شناسه
رشته
شناسه منحصر به فرد نمایشگر.
رویدادها
onDisplayChanged
chrome.system.display.onDisplayChanged.addListener(
callback: function,
)
وقتی چیزی در پیکربندی نمایشگر تغییر کند، اجرا میشود.
پارامترها
- تماس برگشتی
تابع
پارامتر
callbackبه شکل زیر است:() => void