ElementHandle

继承自: JSHandle

ElementHandle 代表页面中的一个 DOM 元素。可以通过 Page.querySelector() 方法创建 ElementHandles。

不推荐

不推荐使用 ElementHandle，请改用 Locator 对象和“Web-first”断言。

ElementHandle hrefElement = page.querySelector("a");
hrefElement.click();

ElementHandle 会阻止 DOM 元素被垃圾回收，除非使用 JSHandle.dispose() 处置该句柄。当其来源帧导航后，ElementHandles 会被自动处置。

ElementHandle 实例可用作 Page.evalOnSelector() 和 Page.evaluate() 方法的参数。

Locator 和 ElementHandle 的区别在于，ElementHandle 指向一个特定的元素，而 Locator 捕获了如何检索元素这一逻辑。

在下面的示例中，handle 指向页面上一个特定的 DOM 元素。如果该元素更改文本或被 React 用于渲染一个完全不同的组件，handle 仍然指向该 DOM 元素。这可能导致意外的行为。

ElementHandle handle = page.querySelector("text=Submit");
handle.hover();
handle.click();

使用 locator，每次使用 element 时，都会使用选择器在页面中定位最新的 DOM 元素。因此在下面的代码片段中，底层 DOM 元素将被定位两次。

Locator locator = page.getByText("Submit");
locator.hover();
locator.click();

方法

boundingBox

v1.9 之前添加

elementHandle.boundingBox

此方法返回元素的边界框，如果元素不可见，则返回 null。边界框是相对于主帧视口计算的，主帧视口通常与浏览器窗口相同。

滚动会影响返回的边界框，类似于 Element.getBoundingClientRect。这意味着 x 和/或 y 可能是负数。

子帧中的元素返回相对于主帧的边界框，与 Element.getBoundingClientRect 不同。

假设页面是静态的，使用边界框坐标执行输入是安全的。例如，以下代码片段应该单击元素的中心。

用法

BoundingBox box = elementHandle.boundingBox();
page.mouse().click(box.x + box.width / 2, box.y + box.height / 2);

null | BoundingBox#
- x double
  
  元素的 x 坐标（以像素为单位）。
- y double
  
  元素的 y 坐标（以像素为单位）。
- width double
  
  元素的宽度（以像素为单位）。
- height double
  
  元素的高度（以像素为单位）。

contentFrame

v1.9 之前添加

elementHandle.contentFrame

对于引用 iframe 节点的元素句柄，返回内容帧，否则返回 null。

用法

ElementHandle.contentFrame();

null | Frame #

ownerFrame

v1.9 之前添加

elementHandle.ownerFrame

返回包含给定元素的帧。

用法

ElementHandle.ownerFrame();

null | Frame #

waitForElementState

v1.9 之前添加

elementHandle.waitForElementState

当元素满足 state 时返回。

根据 state 参数，此方法会等待其中一个可操作性检查通过。当等待期间元素分离（detached）时，此方法会抛出异常，除非是等待 "hidden" 状态。

"visible" 等待直到元素可见。
"hidden" 等待直到元素不可见或未附加。请注意，等待元素隐藏时，元素分离不会导致抛出异常。
"stable" 等待直到元素同时可见且稳定。
"enabled" 等待直到元素启用。
"disabled" 等待直到元素禁用。
"editable" 等待直到元素可编辑。

如果在 setTimeout 毫秒内元素未能满足条件，此方法将抛出异常。

用法

ElementHandle.waitForElementState(state);
ElementHandle.waitForElementState(state, options);

参数

state enum ElementState { VISIBLE, HIDDEN, STABLE, ENABLED, DISABLED, EDITABLE }#

要等待的状态，更多详情见下文。
options ElementHandle.WaitForElementStateOptions (可选)
- setTimeout double (可选)#
  
  以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

void #

已弃用

check

v1.9 之前添加

elementHandle.check

不推荐

改用基于定位器的 Locator.check()。阅读更多关于定位器的信息。

此方法通过执行以下步骤检查元素

确保元素是复选框或单选输入。如果不是，此方法将抛出异常。如果元素已选中，此方法将立即返回。
对元素执行可操作性检查，除非设置了 setForce 选项。
如果需要，将元素滚动到视图中。
使用 Page.mouse() 点击元素中心。
确保元素现在已选中。如果不是，此方法将抛出异常。

如果在操作期间元素从 DOM 分离，此方法将抛出异常。

如果所有步骤在指定的 setTimeout 内未能完成，此方法将抛出 TimeoutError。传递零超时禁用此等待。

用法

ElementHandle.check();
ElementHandle.check(options);

参数

options ElementHandle.CheckOptions (可选)
- setForce boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- setNoWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setPosition Position (可选)添加于：v1.11#
  - setX double
  - setY double
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- setTimeout double (可选)#
  
  以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。
- setTrial boolean (可选)添加于：v1.11#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好执行操作而无需实际执行。

void #

click

v1.9 之前添加

elementHandle.click

不推荐

改用基于定位器的 Locator.click()。阅读更多关于定位器的信息。

此方法通过执行以下步骤单击元素

对元素执行可操作性检查，除非设置了 setForce 选项。
如果需要，将元素滚动到视图中。
使用 Page.mouse() 点击元素的中心，或点击指定的 setPosition。
等待已开始的导航成功或失败，除非设置了 setNoWaitAfter 选项。

如果在操作期间元素从 DOM 分离，此方法将抛出异常。

如果所有步骤在指定的 setTimeout 内未能完成，此方法将抛出 TimeoutError。传递零超时禁用此等待。

用法

ElementHandle.click();
ElementHandle.click(options);

参数

options ElementHandle.ClickOptions (可选)
- setButton enum MouseButton { LEFT, RIGHT, MIDDLE } (可选)#
  
  默认为 left。
- setClickCount int (可选)#
  
  默认为 1。参见 UIEvent.detail。
- setDelay double (可选)#
  
  mousedown 和 mouseup 之间等待的时间（毫秒）。默认为 0。
- setForce boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (可选)#
  
  要按下的修饰键。确保在操作期间只按下了这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- setNoWaitAfter boolean (可选)#
  
  已弃用
  此选项将来默认为 true。
  
  发起导航的操作会等待这些导航发生和页面开始加载。您可以通过设置此标志来选择退出等待。您只有在例外情况下才需要此选项，例如导航到无法访问的页面。默认为 false。
- setPosition Position (可选)#
  - setX double
  - setY double
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- setSteps int (可选)Added in: v1.57#
  
  默认为 1。发送 n 个插值过的 mousemove 事件，以表示从 Playwright 当前光标位置到目标位置的移动。当设置为 1 时，将发出一个到达目标位置的 mousemove 事件。
- setTimeout double (可选)#
  
  以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。
- setTrial boolean (可选)添加于：v1.11#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好执行操作而无需实际执行。

void #

dblclick

v1.9 之前添加

elementHandle.dblclick

不推荐

改用基于定位器的 Locator.dblclick()。阅读更多关于定位器的信息。

此方法通过执行以下步骤双击元素

对元素执行可操作性检查，除非设置了 setForce 选项。
如果需要，将元素滚动到视图中。
使用 Page.mouse() 双击元素的中心，或双击指定的 setPosition。

如果在操作期间元素从 DOM 分离，此方法将抛出异常。

如果所有步骤在指定的 setTimeout 内未能完成，此方法将抛出 TimeoutError。传递零超时禁用此等待。

注意

elementHandle.dblclick() 会分派两次 click 事件和一次 dblclick 事件。

用法

ElementHandle.dblclick();
ElementHandle.dblclick(options);

参数

options ElementHandle.DblclickOptions (可选)
- setButton enum MouseButton { LEFT, RIGHT, MIDDLE } (可选)#
  
  默认为 left。
- setDelay double (可选)#
  
  mousedown 和 mouseup 之间等待的时间（毫秒）。默认为 0。
- setForce boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (可选)#
  
  要按下的修饰键。确保在操作期间只按下了这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- setNoWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setPosition Position (可选)#
  - setX double
  - setY double
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- setSteps int (可选)Added in: v1.57#
  
  默认为 1。发送 n 个插值过的 mousemove 事件，以表示从 Playwright 当前光标位置到目标位置的移动。当设置为 1 时，将发出一个到达目标位置的 mousemove 事件。
- setTimeout double (可选)#
  
  以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。
- setTrial boolean (可选)添加于：v1.11#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好执行操作而无需实际执行。

void #

dispatchEvent

v1.9 之前添加

elementHandle.dispatchEvent

不推荐

改用基于定位器的 Locator.dispatchEvent()。阅读更多关于定位器的信息。

下面的代码片段会分派 click 事件到元素上。无论元素的可见状态如何，都会分派 click 事件。这等同于调用 element.click()。

用法

elementHandle.dispatchEvent("click");

在底层，它会根据给定的 type 创建一个事件实例，用 eventInit 属性初始化它，并将其分派到元素上。默认情况下，事件是 composed、cancelable 且冒泡的。

由于 eventInit 是事件特定的，请参阅事件文档以获取初始属性列表。

您还可以指定 JSHandle 作为属性值，如果您希望将实时对象传递到事件中

// Note you can only create DataTransfer in Chromium and Firefox
JSHandle dataTransfer = page.evaluateHandle("() => new DataTransfer()");
Map<String, Object> arg = new HashMap<>();
arg.put("dataTransfer", dataTransfer);
elementHandle.dispatchEvent("dragstart", arg);

参数

type String #

DOM 事件类型："click"、"dragstart" 等。
eventInit EvaluationArgument (可选)#

可选的事件特定初始化属性。

void #

evalOnSelector

添加于：v1.9

elementHandle.evalOnSelector

不推荐

此方法不等待元素通过可操作性检查，因此可能导致测试不稳定。请改用 Locator.evaluate()、其他 Locator 辅助方法或“Web-first”断言。

返回 expression 的返回值。

该方法在 ElementHandle 的子树中查找与指定选择器匹配的元素，并将该元素作为第一个参数传递给 expression。如果未找到匹配的元素，则抛出错误。

如果 expression 返回一个 Promise，则 ElementHandle.evalOnSelector() 将等待该 Promise 解析并返回其值。

用法

ElementHandle tweetHandle = page.querySelector(".tweet");
assertEquals("100", tweetHandle.evalOnSelector(".like", "node => node.innerText"));
assertEquals("10", tweetHandle.evalOnSelector(".retweets", "node => node.innerText"));

参数

selector String #

要查询的选择器。
expression String #

要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算为函数，则该函数会自动调用。
arg EvaluationArgument (可选)#

要传递给 expression 的可选参数。

Object #

evalOnSelectorAll

添加于：v1.9

elementHandle.evalOnSelectorAll

不推荐

在大多数情况下，Locator.evaluateAll()、其他 Locator 辅助方法和 web-first 断言做得更好。

返回 expression 的返回值。

该方法在 ElementHandle 的子树中查找所有与指定选择器匹配的元素，并将匹配元素的数组作为第一个参数传递给 expression。

如果 expression 返回一个 Promise，则 ElementHandle.evalOnSelectorAll() 将等待该 Promise 解析并返回其值。

用法

<div class="feed">
  <div class="tweet">Hello!</div>
  <div class="tweet">Hi!</div>
</div>

ElementHandle feedHandle = page.querySelector(".feed");
assertEquals(Arrays.asList("Hello!", "Hi!"), feedHandle.evalOnSelectorAll(".tweet", "nodes => nodes.map(n => n.innerText)"));

参数

selector String #

要查询的选择器。
expression String #

要在浏览器上下文中计算的 JavaScript 表达式。如果表达式计算为函数，则该函数会自动调用。
arg EvaluationArgument (可选)#

要传递给 expression 的可选参数。

Object #

fill

v1.9 之前添加

elementHandle.fill

不推荐

改用基于定位器的 Locator.fill()。阅读更多关于定位器的信息。

此方法等待可操作性检查，聚焦元素，填充内容并触发 input 事件。注意，您可以传入一个空字符串来清除输入字段。

如果目标元素不是 <input>、<textarea> 或 [contenteditable] 元素，此方法将抛出错误。但是，如果元素位于具有关联 control 的 <label> 元素内部，则会填充该 control。

要发送细粒度的键盘事件，请使用 Locator.pressSequentially()。

用法

ElementHandle.fill(value);
ElementHandle.fill(value, options);

参数

value String #

要为 <input>、<textarea> 或 [contenteditable] 元素设置的值。
options ElementHandle.FillOptions (可选)
- setForce boolean (可选)添加于：v1.13#
  
  是否绕过可操作性检查。默认为 false。
- setNoWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setTimeout double (可选)#
  
  以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

void #

focus

v1.9 之前添加

elementHandle.focus

不推荐

改用基于定位器的 Locator.focus()。阅读更多关于定位器的信息。

调用元素上的 focus。

用法

ElementHandle.focus();

void #

getAttribute

v1.9 之前添加

elementHandle.getAttribute

不推荐

改用基于定位器的 Locator.getAttribute()。阅读更多关于定位器的信息。

返回元素属性值。

用法

ElementHandle.getAttribute(name);

参数

name String #

要获取值的属性名称。

null | String #

hover

v1.9 之前添加

elementHandle.hover

不推荐

改用基于定位器的 Locator.hover()。阅读更多关于定位器的信息。

此方法通过执行以下步骤将鼠标悬停在元素上

对元素执行可操作性检查，除非设置了 setForce 选项。
如果需要，将元素滚动到视图中。
使用 Page.mouse() 悬停在元素的中心，或悬停在指定的 setPosition。

如果在操作期间元素从 DOM 分离，此方法将抛出异常。

如果所有步骤在指定的 setTimeout 内未能完成，此方法将抛出 TimeoutError。传递零超时禁用此等待。

用法

ElementHandle.hover();
ElementHandle.hover(options);

参数

options ElementHandle.HoverOptions (可选)
- setForce boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (可选)#
  
  要按下的修饰键。确保在操作期间只按下了这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- setNoWaitAfter boolean (可选)新增于: v1.28#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setPosition Position (可选)#
  - setX double
  - setY double
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- setTimeout double (可选)#
  
  以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。
- setTrial boolean (可选)添加于：v1.11#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好执行操作而无需实际执行。

void #

innerHTML

v1.9 之前添加

elementHandle.innerHTML

不推荐

改用基于定位器的 Locator.innerHTML()。阅读更多关于定位器的信息。

返回 element.innerHTML。

用法

ElementHandle.innerHTML();

String #

innerText

v1.9 之前添加

elementHandle.innerText

不推荐

改用基于定位器的 Locator.innerText()。阅读更多关于定位器的信息。

返回 element.innerText。

用法

ElementHandle.innerText();

String #

inputValue

添加于：v1.13

elementHandle.inputValue

不推荐

改用基于定位器的 Locator.inputValue()。阅读更多关于定位器的信息。

返回选定的 <input>、<textarea> 或 <select> 元素的 input.value。

对非输入元素抛出错误。但是，如果元素位于具有关联 control 的 <label> 元素内部，则返回 control 的值。

用法

ElementHandle.inputValue();
ElementHandle.inputValue(options);

参数

options ElementHandle.InputValueOptions (可选)
- setTimeout double (可选)#
  
  以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

String #

isChecked

v1.9 之前添加

elementHandle.isChecked

不推荐

改用基于定位器的 Locator.isChecked()。阅读更多关于定位器的信息。

返回元素是否已选中。如果元素不是复选框或单选输入，则抛出异常。

用法

ElementHandle.isChecked();

boolean #

isDisabled

v1.9 之前添加

elementHandle.isDisabled

不推荐

改用基于定位器的 Locator.isDisabled()。阅读更多关于定位器的信息。

返回元素是否禁用，与 enabled 相反。

用法

ElementHandle.isDisabled();

boolean #

isEditable

v1.9 之前添加

elementHandle.isEditable

不推荐

改用基于定位器的 Locator.isEditable()。阅读更多关于定位器的信息。

返回元素是否可编辑。

用法

ElementHandle.isEditable();

boolean #

isEnabled

v1.9 之前添加

elementHandle.isEnabled

不推荐

请改用基于定位器的 Locator.isEnabled()。阅读更多关于定位器的信息。

返回元素是否启用。

用法

ElementHandle.isEnabled();

boolean #

isHidden

v1.9 之前添加

elementHandle.isHidden

不推荐

改用基于定位器的 Locator.isHidden()。阅读更多关于定位器的信息。

返回元素是否隐藏，即可见的反面。

用法

ElementHandle.isHidden();

boolean #

isVisible

v1.9 之前添加

elementHandle.isVisible

不推荐

改用基于定位器的 Locator.isVisible()。阅读更多关于定位器的信息。

返回元素是否可见。

用法

ElementHandle.isVisible();

boolean #

press

v1.9 之前添加

elementHandle.press

不推荐

改用基于定位器的 Locator.press()。阅读更多关于定位器的信息。

聚焦元素，然后使用 Keyboard.down() 和 Keyboard.up()。

key 可以指定预期的 keyboardEvent.key 值或用于生成文本的单个字符。可以在 key 值的超集中找到更多此处的键值。键的示例包括

F1 - F12, Digit0- Digit9, KeyA- KeyZ, Backquote, Minus, Equal, Backslash, Backspace, Tab, Delete, Escape, ArrowDown, End, Enter, Home, Insert, PageDown, PageUp, ArrowRight, ArrowUp 等。

还支持以下修改快捷键：Shift、Control、Alt、Meta、ShiftLeft、ControlOrMeta。

按住 Shift 将以大写形式输入与 key 对应的文本。

如果 key 是单个字符，则区分大小写，因此 a 和 A 的值将分别生成不同的文本。

也支持快捷键，例如 key: "Control+o"、key: "Control++ 或 key: "Control+Shift+T"。当与修饰符一起指定时，修饰符在按下后续键时被按下并保持。

用法

ElementHandle.press(key);
ElementHandle.press(key, options);

参数

key String #

要按下的键的名称或要生成的字符，例如 ArrowLeft 或 a。
options ElementHandle.PressOptions (可选)
- setDelay double (可选)#
  
  keydown 和 keyup 之间等待的时间（毫秒）。默认为 0。
- setNoWaitAfter boolean (可选)#
  
  已弃用
  此选项将来默认为 true。
  
  发起导航的操作会等待这些导航发生和页面开始加载。您可以通过设置此标志来选择退出等待。您只有在例外情况下才需要此选项，例如导航到无法访问的页面。默认为 false。
- setTimeout double (可选)#
  
  以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

void #

querySelector

添加于：v1.9

elementHandle.querySelector

不推荐

请改用基于定位器的 Page.locator()。阅读更多关于定位器的信息。

此方法在 ElementHandle 的子树中查找与指定选择器匹配的元素。如果没有元素匹配选择器，则返回 null。

用法

ElementHandle.querySelector(selector);

参数

selector String #

要查询的选择器。

null | ElementHandle #

querySelectorAll

添加于：v1.9

elementHandle.querySelectorAll

不推荐

请改用基于定位器的 Page.locator()。阅读更多关于定位器的信息。

此方法在 ElementHandle 的子树中查找所有与指定选择器匹配的元素。如果没有元素匹配选择器，则返回空数组。

用法

ElementHandle.querySelectorAll(selector);

参数

selector String #

要查询的选择器。

List<ElementHandle>#

screenshot

v1.9 之前添加

elementHandle.screenshot

不推荐

请改用基于定位器的 Locator.screenshot()。阅读有关定位器的更多信息。

此方法捕获页面的屏幕截图，裁剪到此特定元素的大小和位置。如果元素被其他元素覆盖，它将不会真正显示在截图中。如果元素是可滚动的容器，截图中将仅显示当前滚动的内容。

此方法会等待可操作性检查，然后在截屏前将元素滚动到视图中。如果元素与 DOM 分离，则此方法会抛出错误。

返回包含捕获的屏幕截图的缓冲区。

用法

ElementHandle.screenshot();
ElementHandle.screenshot(options);

参数

options ElementHandle.ScreenshotOptions (可选)
- setAnimations enum ScreenshotAnimations { DISABLED, ALLOW } (可选)#
  
  设置为 "disabled" 时，停止 CSS 动画、CSS 过渡和 Web 动画。动画的处理方式因其持续时间而异
  - 有限动画会快进到完成，因此它们会触发 transitionend 事件。
  - 无限动画会取消到初始状态，然后在截图后重新播放。
  默认为 "allow"，保持动画不变。
- setCaret enum ScreenshotCaret { HIDE, INITIAL } (可选)#
  
  设置为 "hide" 时，截图将隐藏文本插入符号。设置为 "initial" 时，文本插入符号行为不会更改。默认为 "hide"。
- setMask List<Locator> (可选)#
  
  指定在截屏时应被遮盖的定位器。被遮盖的元素将覆盖其边界框，并带有粉红色框 #FF00FF（可通过 setMaskColor 自定义）。遮罩也会应用于不可见元素，请参阅仅匹配可见元素以禁用此行为。
- setMaskColor String (可选)添加于：v1.35#
  
  指定遮盖元素的覆盖框颜色，采用 CSS 颜色格式。默认颜色为粉红色 #FF00FF。
- setOmitBackground boolean (可选)#
  
  隐藏默认的白色背景并允许捕获透明截图。不适用于 jpeg 图像。默认为 false。
- setPath Path (可选)#
  
  保存图像的文件路径。截屏类型将从文件扩展名推断。如果 setPath 是相对路径，则相对于当前工作目录解析。如果未提供路径，则图像不会保存到磁盘。
- setQuality int (可选)#
  
  图像质量，介于 0-100 之间。不适用于 png 图像。
- setScale enum ScreenshotScale { CSS, DEVICE } (可选)#
  
  设置为 "css" 时，截屏将具有页面上每个 CSS 像素的单个像素。对于高 DPI 设备，这将保持截屏较小。使用 "device" 选项将产生每个设备像素的单个像素，因此高 DPI 设备的截屏将大两倍或更大。
  
  默认为 "device"。
- setStyle String (可选)新增于: v1.41#
  
  在截屏时应用的样式表文本。您可以在此处隐藏动态元素、使元素不可见或更改其属性，以帮助您创建可重复的截屏。此样式表会穿透 Shadow DOM 并应用于内部框架。
- setTimeout double (可选)#
  
  以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。
- setType enum ScreenshotType { PNG, JPEG } (可选)#
  
  指定截图类型，默认为 png。

byte[]#

scrollIntoViewIfNeeded

v1.9 之前添加

elementHandle.scrollIntoViewIfNeeded

不推荐

请改用基于定位器的 Locator.scrollIntoViewIfNeeded()。阅读有关定位器的更多信息。

此方法会等待可操作性检查，然后尝试将元素滚动到视图中，除非它完全可见（由 IntersectionObserver 的 ratio 定义）。

当 elementHandle 不指向与文档或 ShadowRoot 连接的元素时，抛出异常。

有关滚动的其他方法，请参阅 scrolling。

用法

ElementHandle.scrollIntoViewIfNeeded();
ElementHandle.scrollIntoViewIfNeeded(options);

参数

options ElementHandle.ScrollIntoViewIfNeededOptions (可选)
- setTimeout double (可选)#
  
  以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

void #

selectOption

v1.9 之前添加

elementHandle.selectOption

不推荐

改用基于定位器的 Locator.selectOption()。阅读更多关于定位器的信息。

此方法会等待可操作性检查，等待所有指定的选项都出现在 <select> 元素中，然后选择这些选项。

如果目标元素不是 <select> 元素，则此方法会引发错误。但是，如果元素位于具有关联 control 的 <label> 元素内，则将使用该 control。

返回已成功选择的选项值数组。

一旦所有提供的选项都已选中，将触发 change 和 input 事件。

用法

// Single selection matching the value or label
handle.selectOption("blue");
// single selection matching the label
handle.selectOption(new SelectOption().setLabel("Blue"));
// multiple selection
handle.selectOption(new String[] {"red", "green", "blue"});

参数

values null | String | ElementHandle | String[] | SelectOption | ElementHandle[] | SelectOption[]#
- setValue String (可选)
  
  按 option.value 匹配。可选。
- setLabel String (可选)
  
  按 option.label 匹配。可选。
- setIndex int (可选)
  
  按索引匹配。可选。
要选择的选项。如果 <select> 具有 multiple 属性，则选择所有匹配的选项，否则仅选择与传入选项之一匹配的第一个选项。字符串值同时匹配值和标签。当所有指定的属性都匹配时，认为选项匹配。
options ElementHandle.SelectOptionOptions (可选)
- setForce boolean (可选)添加于：v1.13#
  
  是否绕过可操作性检查。默认为 false。
- setNoWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setTimeout double (可选)#
  
  以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

List<String>#

selectText

v1.9 之前添加

elementHandle.selectText

不推荐

请改用基于定位器的 Locator.selectText()。阅读有关定位器的更多信息。

此方法会等待可操作性检查，然后聚焦元素并选择其所有文本内容。

如果元素在具有关联控件的 <label> 元素内，则聚焦并选择该控件的文本。

用法

ElementHandle.selectText();
ElementHandle.selectText(options);

参数

options ElementHandle.SelectTextOptions (可选)
- setForce boolean (可选)添加于：v1.13#
  
  是否绕过可操作性检查。默认为 false。
- setTimeout double (可选)#
  
  以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

void #

setChecked

新增于: v1.15

elementHandle.setChecked

不推荐

改用基于定位器的 Locator.setChecked()。阅读更多关于定位器的信息。

此方法通过执行以下步骤选中或取消选中元素

确保元素是复选框或单选输入。如果不是，此方法将抛出异常。
如果元素已经处于正确的选中状态，此方法将立即返回。
等待匹配元素的可操作性检查，除非设置了 setForce 选项。如果在检查过程中元素被分离，则重试整个操作。
如果需要，将元素滚动到视图中。
使用 Page.mouse() 点击元素中心。
确保元素现在已选中或未选中。如果不是，此方法将抛出异常。

当所有步骤组合在指定的 setTimeout 内未完成时，此方法将抛出 TimeoutError。传递零超时会禁用此检查。

用法

ElementHandle.setChecked(checked);
ElementHandle.setChecked(checked, options);

参数

checked boolean #

是否选中或取消选中复选框。
options ElementHandle.SetCheckedOptions (可选)
- setForce boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- setNoWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setPosition Position (可选)#
  - setX double
  - setY double
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- setTimeout double (可选)#
  
  以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。
- setTrial boolean (可选)#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好执行操作而无需实际执行。

void #

setInputFiles

v1.9 之前添加

elementHandle.setInputFiles

不推荐

改用基于定位器的 Locator.setInputFiles()。阅读更多关于定位器的信息。

将文件输入的值设置为这些文件路径或文件。如果一些 filePaths 是相对路径，则它们相对于当前工作目录解析。空数组会清除选定的文件。对于带有 [webkitdirectory] 属性的输入，仅支持单个目录路径。

此方法期望 ElementHandle 指向一个 input 元素。但是，如果该元素位于具有关联 control 的 <label> 元素内部，则会定位该 control。

用法

ElementHandle.setInputFiles(files);
ElementHandle.setInputFiles(files, options);

参数

files Path | Path[] | FilePayload | FilePayload[]#
- setName String
  
  文件名
- setMimeType String
  
  文件类型
- setBuffer byte[]
  
  文件内容
options ElementHandle.SetInputFilesOptions (可选)
- setNoWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setTimeout double (可选)#
  
  以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

void #

tap

v1.9 之前添加

elementHandle.tap

不推荐

改用基于定位器的 Locator.tap()。阅读更多关于定位器的信息。

此方法通过执行以下步骤来点击元素

等待元素的可操作性检查，除非设置了 setForce 选项。
如果需要，将元素滚动到视图中。
使用 Page.touchscreen() 点击元素的中心，或点击指定的 setPosition。

如果在操作期间元素从 DOM 分离，此方法将抛出异常。

当所有步骤组合在指定的 setTimeout 内未完成时，此方法将抛出 TimeoutError。传递零超时会禁用此检查。

注意

elementHandle.tap() 要求浏览器上下文的 hasTouch 选项设置为 true。

用法

ElementHandle.tap();
ElementHandle.tap(options);

参数

options ElementHandle.TapOptions (可选)
- setForce boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- setModifiers List<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (可选)#
  
  要按下的修饰键。确保在操作期间只按下了这些修饰键，然后恢复当前修饰键。如果未指定，则使用当前按下的修饰键。"ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- setNoWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setPosition Position (可选)#
  - setX double
  - setY double
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- setTimeout double (可选)#
  
  以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。
- setTrial boolean (可选)添加于：v1.11#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好执行操作而无需实际执行。

void #

textContent

v1.9 之前添加

elementHandle.textContent

不推荐

改用基于定位器的 Locator.textContent()。阅读更多关于定位器的信息。

返回 node.textContent。

用法

ElementHandle.textContent();

null | String #

type

v1.9 之前添加

elementHandle.type

已弃用

在大多数情况下，您应该使用 Locator.fill()。只有当页面上有特殊的键盘处理时，您才需要一个一个地按下按键——在这种情况下，请使用 Locator.pressSequentially()。

聚焦元素，然后为文本中的每个字符发送一个 keydown、keypress/input 和 keyup 事件。

要按下特殊键（如 Control 或 ArrowDown），请使用 ElementHandle.press()。

用法

参数

text String #

要输入到聚焦元素的文本。
options ElementHandle.TypeOptions (可选)
- setDelay double (可选)#
  
  按键之间等待的时间，以毫秒为单位。默认为 0。
- setNoWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setTimeout double (可选)#
  
  以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

void #

uncheck

v1.9 之前添加

elementHandle.uncheck

不推荐

改用基于定位器的 Locator.uncheck()。阅读更多关于定位器的信息。

此方法通过执行以下步骤检查元素

确保元素是复选框或单选输入。如果不是，此方法将抛出异常。如果元素已经未选中，此方法将立即返回。
等待元素的可操作性检查，除非设置了 setForce 选项。
如果需要，将元素滚动到视图中。
使用 Page.mouse() 点击元素中心。
确保元素现在未选中。如果不是，此方法将抛出异常。

如果在操作期间元素从 DOM 分离，此方法将抛出异常。

当所有步骤组合在指定的 setTimeout 内未完成时，此方法将抛出 TimeoutError。传递零超时会禁用此检查。

用法

ElementHandle.uncheck();
ElementHandle.uncheck(options);

参数

options ElementHandle.UncheckOptions (可选)
- setForce boolean (可选)#
  
  是否绕过可操作性检查。默认为 false。
- setNoWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setPosition Position (可选)添加于：v1.11#
  - setX double
  - setY double
  相对于元素填充框左上角的点。如果未指定，则使用元素的某个可见点。
- setTimeout double (可选)#
  
  以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。
- setTrial boolean (可选)添加于：v1.11#
  
  设置后，此方法仅执行可操作性检查并跳过操作。默认为 false。用于等待元素准备好执行操作而无需实际执行。

void #

waitForSelector

v1.9 之前添加

elementHandle.waitForSelector

不推荐

请改用断言可见性的 Web 断言或基于定位器的 Locator.waitFor()。

当元素满足 setState 选项时，返回由选择器指定的元素。如果等待 hidden 或 detached，则返回 null。

等待相对于元素句柄的 selector 满足 setState 选项（出现/从 dom 中分离，或变得可见/隐藏）。如果在调用方法时 selector 已满足条件，则方法将立即返回。如果选择器在 setTimeout 毫秒内不满足条件，函数将抛出异常。

用法

page.setContent("<div><span></span></div>");
ElementHandle div = page.querySelector("div");
// Waiting for the "span" selector relative to the div.
ElementHandle span = div.waitForSelector("span", new ElementHandle.WaitForSelectorOptions()
  .setState(WaitForSelectorState.ATTACHED));

注意

此方法不跨导航工作，请改用 Page.waitForSelector()。

参数

selector String #

要查询的选择器。
options ElementHandle.WaitForSelectorOptions (可选)
- setState enum WaitForSelectorState { ATTACHED, DETACHED, VISIBLE, HIDDEN } (可选)#
  
  默认为 'visible'。可以是以下之一：
  - 'attached' - 等待元素出现在 DOM 中。
  - 'detached' - 等待元素不在 DOM 中。
  - 'visible' - 等待元素具有非空的边界框且没有 visibility:hidden。请注意，没有任何内容或具有 display:none 的元素具有空的边界框，不被视为可见。
  - 'hidden' - 等待元素从 DOM 中分离，或具有空的边界框或 visibility:hidden。这与 'visible' 选项相反。
- setStrict boolean (可选)新增于: v1.15#
  
  如果为 true，则调用要求选择器解析为单个元素。如果给定选择器解析为多个元素，则调用会抛出异常。
- setTimeout double (可选)#
  
  以毫秒为单位的最大时间。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可以通过使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法来更改。

null | ElementHandle #

方法​

boundingBox​

contentFrame​

ownerFrame​

waitForElementState​

已弃用​

check​

click​

dblclick​

dispatchEvent​

evalOnSelector​

evalOnSelectorAll​

fill​

focus​

getAttribute​

hover​

innerHTML​

innerText​

inputValue​

isChecked​

isDisabled​

isEditable​

isEnabled​

isHidden​

isVisible​

press​

querySelector​

querySelectorAll​

screenshot​

scrollIntoViewIfNeeded​

selectOption​

selectText​

setChecked​

setInputFiles​

tap​

textContent​

type​

uncheck​

waitForSelector​

方法

boundingBox

contentFrame

ownerFrame

waitForElementState

已弃用

check

click

dblclick

dispatchEvent

evalOnSelector

evalOnSelectorAll

fill

focus

getAttribute

hover

innerHTML

innerText

inputValue

isChecked

isDisabled

isEditable

isEnabled

isHidden

isVisible

press

querySelector

querySelectorAll

screenshot

scrollIntoViewIfNeeded

selectOption

selectText

setChecked

setInputFiles

tap

textContent

type

uncheck

waitForSelector