chrome.system.display

Description

使用 system.display API 查询显示元数据。

Permissions

system.display

Summary

Types

Bounds

PROPERTIES

  • height

    number

    显示器的高度（以像素为单位）。

  • left

    number

    左上角的 x 坐标。

  • top

    number

    左上角的 y 坐标。

  • width

    number

    显示的宽度（以像素为单位）。

DisplayLayout

Chrome 53+

PROPERTIES

  • id

    string

    显示器的唯一标识符。

  • offset

    number

    显示沿连接边的偏移量。 0 表示最上角或最左角对齐。

  • parentId

    string

    父显示的唯一标识符。如果这是根，则为空。

  • position

    LayoutPosition

    此显示相对于父级的布局位置。这对于根将被忽略。

DisplayMode

Chrome 52+

PROPERTIES

  • deviceScaleFactor

    number

    显示模式设备比例因子。

  • height

    number

    以设备无关（用户可见）像素为单位的显示模式高度。

  • heightInNativePixels

    number

    以原生像素为单位的显示模式高度。

  • isInterlaced

    boolean optional

    Chrome 74+

    如果此模式是隔行扫描的，则为真，如果未提供，则为假。

  • isNative

    boolean

    如果模式是显示器的本机模式，则为真。

  • isSelected

    boolean

    如果当前选择了显示模式，则为真。

  • refreshRate

    number

    Chrome 67+

    以赫兹为单位的显示模式刷新率。

  • uiScale

    number optional

    Deprecated since Chrome 70

    Use displayZoomFactor

    显示模式 UI 比例因子。

  • width

    number

    以设备无关（用户可见）像素为单位的显示模式宽度。

  • widthInNativePixels

    number

    以原生像素为单位的显示模式宽度。

DisplayProperties

PROPERTIES

  • boundsOriginX

    number optional

    如果设置，则沿 x 轴更新显示的逻辑边界原点。与 boundsOriginY 一起应用。如果未设置且设置了 boundsOriginY，则默认为当前值。注意更新显示原点时，将应用一些约束，因此最终边界原点可能与一组不同。可以使用 getInfo 检索最终边界。无法在主显示器上更改边界原点。

  • boundsOriginY

    number optional

    如果设置，则沿 y 轴更新显示的逻辑边界原点。有关 boundsOriginX 参数，请参阅文档。

  • displayMode

    DisplayMode optional

    Chrome 52+

    如果设置，则将显示模式更新为与此值匹配的模式。如果其他参数无效，则不会应用。如果显示模式无效，则不会应用并设置错误，但仍会应用其他属性。

  • displayZoomFactor

    number optional

    Chrome 65+

    如果设置，则更新与显示关联的缩放。此缩放执行重新布局和重新绘制，从而产生比仅执行逐像素拉伸放大更好的缩放质量。

  • isPrimary

    boolean optional

    如果设置为 true，则使显示为主。如果设置为 false，则无操作。注意：如果设置，则显示被视为所有其他属性的主要显示（即可以设置 isUnified 而不能设置边界原点）。

  • isUnified

    boolean optional

    Chrome 59+

    仅限 Chrome 操作系统。如果设置为 true，则将显示模式更改为统一桌面（有关详细信息，请参阅 enableUnifiedDesktop）。如果设置为 false，将禁用统一桌面模式。这仅对主显示器有效。如果提供，则不能提供 mirroringSourceId，其他属性将被忽略。如果不提供，这将不起作用。

  • mirroringSourceId

    string optional

    Deprecated since Chrome 68

    Use setMirrorMode.

    仅限 Chrome 操作系统。如果设置且不为空，则仅为此显示启用镜像。否则禁用所有显示器的镜像。此值应指示要镜像的源显示器的 id，该 id 不能与传递给 setDisplayProperties 的 id 相同。如果设置，则不能设置其他属性。

  • overscan

    Insets optional

    如果设置，则将显示器的过扫描插入设置为提供的值。请注意，过扫描值不得为负值或大于屏幕尺寸的一半。无法在内部监视器上更改过扫描。

  • rotation

    number optional

    如果设置，则更新显示的旋转。合法值为 [0, 90, 180, 270]。旋转设置为顺时针，相对于显示器的垂直位置。

DisplayUnitInfo

PROPERTIES

  • availableDisplayZoomFactors

    number[]

    Chrome 67+

    可以为显示器设置的缩放系数值列表。

  • bounds

    Bounds

    显示器的逻辑边界。

  • displayZoomFactor

    number

    Chrome 65+

    显示器的当前缩放比例和默认缩放比例之间的比率。例如，值 1 相当于 100% 缩放，值 1.5 相当于 150% 缩放。

  • dpiX

    number

    沿 x 轴每英寸的像素数。

  • dpiY

    number

    沿 y 轴每英寸的像素数。

  • edid

    Edid optional

    Chrome 67+

    注意：这仅适用于 Chrome OS Kiosk 应用程序和 Web UI。

  • hasTouchSupport

    boolean

    Chrome 57+

    如果此显示器具有与其关联的触摸输入设备，则为真。

  • id

    string

    显示器的唯一标识符。

  • isEnabled

    boolean

    如果启用此显示，则为真。

  • isPrimary

    boolean

    如果这是主显示器，则为真。

  • isUnified

    boolean

    Chrome 59+

    在统一桌面模式下，所有显示器都为真。请参阅文档enableUnifiedDesktop

  • mirroringDestinationIds

    string[]

    Chrome 64+

    仅限 Chrome 操作系统。源显示器被镜像到的显示器的标识符。如果没有镜像显示，则为空。对于所有显示器，这将设置为相同的值。这不能包括 mirroringSourceId。

  • mirroringSourceId

    string

    仅限 Chrome 操作系统。如果启用镜像，则被镜像的显示器的标识符，否则为空。这将为所有显示器（包括被镜像的显示器）设置。

  • modes

    DisplayMode[]

    Chrome 52+

    可用显示模式列表。当前模式将具有 isSelected=true。仅适用于 Chrome 操作系统。在其他平台上将设置为空数组。

  • name

    string

    用户友好的名称（例如“HP LCD 显示器”）。

  • overscan

    Insets

    显示器在其屏幕范围内的插图。目前仅在 ChromeOS 上公开。将在其他平台上设置为空插图。

  • rotation

    number

    显示器相对于垂直位置的顺时针旋转度数。目前仅在 ChromeOS 上公开。在其他平台上将设置为 0。当设备处于物理平板电脑状态时，值 -1 将被解释为自动旋转。

  • workArea

    Bounds

    显示范围内显示的可用工作区。工作区不包括为操作系统保留的显示区域，例如任务栏和启动器。

Edid

Chrome 67+

PROPERTIES

  • manufacturerId

    string

    3 个字符的制造商代码。见秒。 3.4.1 第 21 页。 v1.4 中需要。

  • productId

    string

    2 字节制造商分配的代码，Sec。 3.4.2 第 21 页。 v1.4 中需要。

  • yearOfManufacture

    number

    制造商年份，秒。 3.4.4 第 22 页。 v1.4 中需要。

GetInfoFlags

Chrome 59+

PROPERTIES

Insets

PROPERTIES

  • bottom

    number

    距底部边界的 y 轴距离。

  • left

    number

    距左边界的 x 轴距离。

  • right

    number

    与右边界的 x 轴距离。

  • top

    number

    与顶部边界的 y 轴距离。

LayoutPosition

Chrome 53+

布局位置，即显示附加到的父级边缘。

TYPE

"top", "right", "bottom", or "left"

MirrorMode

Chrome 65+

镜像模式，即将显示器镜像到其他显示器的不同方式。

TYPE

"off", "normal", or "mixed"

MirrorModeInfo

Chrome 65+

PROPERTIES

  • mirroringDestinationIds

    string[] optional

    显示镜像目标的 ID。这仅对“混合mixed”有效。

  • mirroringSourceId

    string optional

    镜像源显示的id。这仅对“混合mixed”有效。

  • mode

    MirrorMode

    应该设置的镜像模式。

Point

Chrome 57+

PROPERTIES

  • x

    number

    点的 x 坐标。

  • y

    number

    点的 y 坐标。

TouchCalibrationPair

Chrome 57+

PROPERTIES

  • displayPoint

    Point

    显示点的坐标。

  • touchPoint

    Point

    显示点对应的触摸点坐标。

TouchCalibrationPairQuad

Chrome 57+

PROPERTIES

Methods

clearTouchCalibration 

chrome.system.display.clearTouchCalibration(
  id: string,
)

Chrome 57+

重置显示器的触摸校准，并通过清除与显示器关联的任何触摸校准数据将其恢复到默认状态。

PARAMETERS

  • id

    string

    显示器的唯一标识符。

completeCustomTouchCalibration

chrome.system.display.completeCustomTouchCalibration( pairs: TouchCalibrationPairQuad, bounds: Bounds, )

Chrome 57+

设置显示器的触摸校准对。这些pairs将用于校准触摸屏以使用在 startCustomTouchCalibration() 中调用的 id 进行显示。在调用此方法之前始终调用 startCustomTouchCalibration。如果另一个触摸校准正在进行中，这将引发错误。

PARAMETERS

  • pairs

    TouchCalibrationPairQuad

    用于校准显示器的点对。

  • bounds

    Bounds

    执行触摸校准时的显示范围。 bounds.left 和 bounds.top 值被忽略。

enableUnifiedDesktop 

chrome.system.display.enableUnifiedDesktop(
  enabled: boolean,
)

Chrome 46+

启用/禁用统一桌面功能。如果在镜像处于活动状态时启用，则在关闭镜像之前桌面模式不会改变。否则，桌面模式将立即切换到统一。注意：这仅适用于 Chrome OS Kiosk 应用程序和 Web UI。

PARAMETERS

  • enabled

    boolean

    如果应启用统一桌面，则为 True。

getDisplayLayout 

chrome.system.display.getDisplayLayout(
  callback?: function,
)

Promise Chrome 53+

请求所有显示器的布局信息。注意：这仅适用于 Chrome OS Kiosk 应用程序和 Web UI。

PARAMETERS

RETURNS

  • Promise<DisplayLayout[]>

    Pending

    这仅在未指定回调参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与回调的第一个参数相同。

getInfo

chrome.system.display.getInfo( flags?: GetInfoFlags, callback?: function, )

Promise

请求所有连接的显示设备的信息。

PARAMETERS

RETURNS

  • Promise<DisplayUnitInfo[]>

    Pending

    这仅在未指定回调参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与回调的第一个参数相同。

overscanCalibrationAdjust

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

Chrome 53+

调整显示的当前过扫描插入。通常，这应该沿轴移动显示（例如，左+右具有相同的值）或沿轴缩放（例如，顶部+底部具有相反的值）。自开始以来，每次 Adjust 调用都会与之前的调用累积在一起。

PARAMETERS

  • id

    string

    显示器的唯一标识符。

  • delta

    Insets

    改变过扫描插图的数量。

overscanCalibrationComplete 

chrome.system.display.overscanCalibrationComplete(
  id: string,
)

Chrome 53+

通过保存当前值并隐藏覆盖来完成显示器的过扫描调整。

PARAMETERS

  • id

    string

    显示器的唯一标识符。

overscanCalibrationReset 

chrome.system.display.overscanCalibrationReset(
  id: string,
)

Chrome 53+

将显示器的过扫描插入重置为上次保存的值（即在调用 Start 之前）。

PARAMETERS

  • id

    string

    显示器的唯一标识符。

overscanCalibrationStart 

chrome.system.display.overscanCalibrationStart(
  id: string,
)

Chrome 53+

开始显示器的过扫描校准。这将在屏幕上显示一个覆盖图，指示当前的过扫描插图。如果正在进行显示ID 的过扫描校准，这将重置校准。

PARAMETERS

  • id

    string

    显示器的唯一标识符。

setDisplayLayout

chrome.system.display.setDisplayLayout( layouts: DisplayLayout[], callback?: function, )

Promise Chrome 53+

设置所有显示器的布局。任何未包含的显示都将使用默认布局。如果布局会重叠或以其他方式无效，它将被调整为有效布局。布局解决后，会触发一个 onDisplayChanged 事件。注意：这仅适用于 Chrome OS Kiosk 应用程序和 Web UI。

PARAMETERS

  • layouts

    DisplayLayout[]

    布局信息，除主显示器外的所有显示器都需要。

  • callback

    function optional

    The callback parameter looks like:

    () => void

RETURNS

  • Promise<void>

    Pending

    这仅在未指定回调参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与回调的第一个参数相同。

setDisplayProperties

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

Promise

根据 info 中提供的信息更新由 id 指定的显示的属性。失败时，runtime.lastError 将被设置。注意：这仅适用于 Chrome OS Kiosk 应用程序和 Web UI。

PARAMETERS

  • id

    string

    显示器的唯一标识符。

  • info

    DisplayProperties

    有关应更改的显示属性的信息。只有在 info 中为它指定了新值时，才会更改属性。

  • callback

    function optional

    The callback parameter looks like:

    () => void

RETURNS

  • Promise<void>

    Pending

    这仅在未指定回调参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与回调的第一个参数相同。

setMirrorMode

chrome.system.display.setMirrorMode( info: MirrorModeInfo, callback?: function, )

Promise Chrome 65+

将显示模式设置为指定的镜像模式。每次调用都会重置先前调用的状态。对于镜像目标显示，调用 setDisplayProperties() 将失败。注意：这仅适用于 Chrome OS Kiosk 应用程序和 Web UI。

PARAMETERS

  • info

    MirrorModeInfo

    应应用于显示模式的镜像模式的信息。

  • callback

    function optional

    The callback parameter looks like:

    () => void

RETURNS

  • Promise<void>

    Pending

    这仅在未指定回调参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与回调的第一个参数相同。

showNativeTouchCalibration 

chrome.system.display.showNativeTouchCalibration(
  id: string,
  callback?: function,
)

Promise Chrome 57+

显示以 id 为显示 id 的显示器的原生触摸校准 UX。这将在屏幕上显示一个覆盖图，其中包含有关如何继续的所需说明。只有在成功校准的情况下才会调用回调。如果校准失败，这将引发错误。

PARAMETERS

  • id

    string

    显示器的唯一标识符。

  • callback

    function optional

    The callback parameter looks like:

    (success: boolean) => void

    • success

      boolean

RETURNS

  • Promise<boolean>

    Pending

    这仅在未指定回调参数时返回 Promise，并且使用 MV3+。 Promise 中的类型与回调的第一个参数相同。

startCustomTouchCalibration 

chrome.system.display.startCustomTouchCalibration(
  id: string,
)

Chrome 57+

启动显示器的自定义触摸校准。使用自定义 UX 收集校准数据时应调用此方法。如果另一个触摸校准正在进行中，这将引发错误。

PARAMETERS

  • id

    string

    显示器的唯一标识符。

Events

onDisplayChanged 

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

当显示配置发生任何变化时触发。

PARAMETERS

  • callback

    function

    The callback parameter looks like:

    () => void

By.一粒技术服务.

results matching ""

    No results matching ""