ElementHandle

扩展: JSHandle

ElementHandle 代表页面内 DOM 元素。ElementHandle 可以通过 Page.querySelector() 方法创建。

不推荐

不建议使用 ElementHandle，请改用 Locator 对象和以 Web 为中心的断言。

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

ElementHandle 会阻止 DOM 元素被垃圾回收，除非使用 JSHandle.dispose() 释放句柄。当其源框架发生导航时，ElementHandle 会自动释放。

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 参数，此方法将等待 actionability 检查之一通过。当元素在等待时被分离时，此方法将抛出异常，除非等待 "hidden" 状态。

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

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

用法

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 的 Locator.check()。详细了解定位器。

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

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

如果元素在操作期间的任何时刻与 DOM 分离，此方法将抛出异常。

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

用法

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

参数

options ElementHandle.CheckOptions (可选)
- setForce boolean (可选)#
  
  是否绕过 actionability 检查。默认为 false。
- setNoWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setPosition Position (可选)在以下版本中添加: v1.11#
  - setX double
  - setY double
  相对于元素填充框左上角使用的点。如果未指定，则使用元素的一些可见点。
- setTimeout 双精度浮点数 (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改默认值。
- setTrial 布尔值 (可选)在以下版本中添加: v1.11#
  
  设置后，此方法只执行操作性检查并跳过操作。默认值为 false。用于在不执行操作的情况下等待元素准备好执行操作。

无返回值 #

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 整数 (可选)#
  
  默认为 1。请参阅 UIEvent.detail。
- setDelay 双精度浮点数 (可选)#
  
  mousedown 和 mouseup 之间等待的时间（毫秒）。默认值为 0。
- setForce 布尔值 (可选)#
  
  是否绕过 actionability 检查。默认为 false。
- setModifiers 列表<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (可选)#
  
  要按下的修饰键。确保在操作过程中只按下这些修饰键，然后恢复当前修饰键。如果没有指定，则使用当前按下的修饰键。 "ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- setNoWaitAfter 布尔值 (可选)#
  
  已弃用
  此选项将在将来默认为 true。
  
  启动导航的操作会等待这些导航发生并等待页面开始加载。你可以通过设置此标志选择不等待。你只需要在特殊情况下使用此选项，例如导航到无法访问的页面。默认值为 false。
- setPosition 位置 (可选)#
  - setX double
  - setY double
  相对于元素填充框左上角使用的点。如果未指定，则使用元素的一些可见点。
- setTimeout 双精度浮点数 (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改默认值。
- setTrial 布尔值 (可选)在以下版本中添加: v1.11#
  
  设置后，此方法只执行操作性检查并跳过操作。默认值为 false。用于在不执行操作的情况下等待元素准备好执行操作。

无返回值 #

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 双精度浮点数 (可选)#
  
  mousedown 和 mouseup 之间等待的时间（毫秒）。默认值为 0。
- setForce 布尔值 (可选)#
  
  是否绕过 actionability 检查。默认为 false。
- setModifiers 列表<enum KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (可选)#
  
  要按下的修饰键。确保在操作过程中只按下这些修饰键，然后恢复当前修饰键。如果没有指定，则使用当前按下的修饰键。 "ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- setNoWaitAfter 布尔值 (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setPosition 位置 (可选)#
  - setX double
  - setY double
  相对于元素填充框左上角使用的点。如果未指定，则使用元素的一些可见点。
- setTimeout 双精度浮点数 (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改默认值。
- setTrial 布尔值 (可选)在以下版本中添加: v1.11#
  
  设置后，此方法只执行操作性检查并跳过操作。默认值为 false。用于在不执行操作的情况下等待元素准备好执行操作。

无返回值 #

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 字符串 #

DOM 事件类型："click"、"dragstart" 等。
eventInit 评估参数 (可选)#

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

无返回值 #

evalOnSelector

添加于：v1.9

elementHandle.evalOnSelector

不推荐

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

返回 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 字符串 #

要查询的选择器。
expression 字符串 #

在浏览器上下文中执行的 JavaScript 表达式。如果表达式计算结果为函数，则该函数将自动调用。
arg 评估参数 (可选)#

传递给表达式的可选参数。

对象 #

evalOnSelectorAll

添加于：v1.9

elementHandle.evalOnSelectorAll

不推荐

在大多数情况下，Locator.evaluateAll()，其他定位器辅助方法和网页优先断言可以更好地完成这项工作。

返回表达式的返回值。

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

如果表达式返回一个 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 字符串 #

要查询的选择器。
expression 字符串 #

在浏览器上下文中执行的 JavaScript 表达式。如果表达式计算结果为函数，则该函数将自动调用。
arg 评估参数 (可选)#

传递给表达式的可选参数。

对象 #

fill

在 v1.9 之前添加

elementHandle.fill

不推荐

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

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

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

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

用法

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

参数

value 字符串 #

为 <input>、<textarea> 或 [contenteditable] 元素设置的值。
options ElementHandle.FillOptions (可选)
- setForce 布尔值 (可选)添加时间：v1.13#
  
  是否绕过 actionability 检查。默认为 false。
- setNoWaitAfter 布尔值 (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setTimeout 双精度值 (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改默认值。

空 #

focus

在 v1.9 之前添加

elementHandle.focus

不推荐

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

在元素上调用 focus。

用法

ElementHandle.focus();

空 #

getAttribute

在 v1.9 之前添加

elementHandle.getAttribute

不推荐

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

返回元素属性值。

用法

ElementHandle.getAttribute(name);

参数

name 字符串 #

要获取其值的属性名称。

空 | 字符串 #

hover

在 v1.9 之前添加

elementHandle.hover

不推荐

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

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

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

如果元素在操作期间的任何时刻与 DOM 分离，此方法将抛出异常。

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

用法

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

参数

options ElementHandle.HoverOptions (可选)
- setForce 布尔值 (可选)#
  
  是否绕过 actionability 检查。默认为 false。
- setModifiers 列表<枚举 KeyboardModifier { ALT, CONTROL, CONTROLORMETA, META, SHIFT }> (可选)#
  
  要按下的修饰键。确保在操作过程中只按下这些修饰键，然后恢复当前修饰键。如果没有指定，则使用当前按下的修饰键。 "ControlOrMeta" 在 Windows 和 Linux 上解析为 "Control"，在 macOS 上解析为 "Meta"。
- setNoWaitAfter 布尔值 (可选)添加时间：v1.28#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setPosition 位置 (可选)#
  - setX double
  - setY double
  相对于元素填充框左上角使用的点。如果未指定，则使用元素的一些可见点。
- setTimeout 双精度值 (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改默认值。
- setTrial 布尔值 (可选)在以下版本中添加: v1.11#
  
  设置后，此方法只执行操作性检查并跳过操作。默认值为 false。用于在不执行操作的情况下等待元素准备好执行操作。

空 #

innerHTML

在 v1.9 之前添加

elementHandle.innerHTML

不推荐

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

返回 element.innerHTML。

用法

ElementHandle.innerHTML();

字符串 #

innerText

在 v1.9 之前添加

elementHandle.innerText

不推荐

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

返回 element.innerText。

用法

ElementHandle.innerText();

字符串 #

inputValue

添加时间：v1.13

elementHandle.inputValue

不推荐

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

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

对于非输入元素抛出异常。但是，如果元素位于具有关联控件的 <label> 元素内，则返回控件的值。

用法

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

参数

options ElementHandle.InputValueOptions (可选)
- setTimeout 双精度值 (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改默认值。

字符串 #

isChecked

在 v1.9 之前添加

elementHandle.isChecked

不推荐

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

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

用法

ElementHandle.isChecked();

布尔值 #

isDisabled

在 v1.9 之前添加

elementHandle.isDisabled

不推荐

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

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

用法

ElementHandle.isDisabled();

布尔值 #

isEditable

在 v1.9 之前添加

elementHandle.isEditable

不推荐

请使用基于定位器的 Locator.isEditable() 代替。了解更多关于定位器的信息。

返回元素是否可编辑。

用法

ElementHandle.isEditable();

布尔值 #

isEnabled

在 v1.9 之前添加

elementHandle.isEnabled

不推荐

请使用基于定位器的 Locator.isEnabled() 代替。了解更多关于定位器的信息。

返回元素是否启用。

用法

ElementHandle.isEnabled();

布尔值 #

isHidden

在 v1.9 之前添加

elementHandle.isHidden

不推荐

请使用基于定位器的 Locator.isHidden() 代替。了解更多关于定位器的信息。

返回元素是否隐藏，与可见相反。

用法

ElementHandle.isHidden();

布尔值 #

isVisible

在 v1.9 之前添加

elementHandle.isVisible

不推荐

请使用基于定位器的 Locator.isVisible() 代替。了解更多关于定位器的信息。

返回元素是否可见。

用法

ElementHandle.isVisible();

布尔值 #

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 字符串 #

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

空 #

querySelector

添加于：v1.9

elementHandle.querySelector

不推荐

请使用基于定位器的 Page.locator() 代替。了解更多关于定位器的信息。

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

用法

ElementHandle.querySelector(selector);

参数

selector 字符串 #

要查询的选择器。

空 | ElementHandle #

querySelectorAll

添加于：v1.9

elementHandle.querySelectorAll

不推荐

请使用基于定位器的 Page.locator() 代替。了解更多关于定位器的信息。

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

用法

ElementHandle.querySelectorAll(selector);

参数

selector 字符串 #

要查询的选择器。

列表<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 列表<Locator> （可选）#
  
  指定截取屏幕截图时应屏蔽的定位器。屏蔽的元素将被一个粉色框 #FF00FF（由 setMaskColor 自定义）完全覆盖，该框完全覆盖其边界框。
- setMaskColor 字符串 （可选）添加于：v1.35#
  
  指定屏蔽元素的覆盖框的颜色，使用 CSS 颜色格式。默认颜色为粉色 #FF00FF。
- setOmitBackground 布尔值 （可选）#
  
  隐藏默认的白色背景，并允许捕获透明的屏幕截图。不适用于 jpeg 图像。默认为 false。
- setPath 路径 （可选）#
  
  要将图像保存到的文件路径。屏幕截图类型将从文件扩展名推断出来。如果 setPath 是相对路径，则它相对于当前工作目录解析。如果没有提供路径，图像将不会保存到磁盘。
- setQuality 整数 （可选）#
  
  图像的质量，介于 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 不指向与 Document 或 ShadowRoot 连接的元素时，会抛出异常。

请参阅滚动，了解滚动元素的其他方法。

用法

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> 元素，则此方法将抛出异常。但是，如果元素位于与控制关联的 <label> 元素中，则将使用该控制元素。

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

在所有提供的选项被选中后，触发 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 布尔值 (可选)添加时间：v1.13#
  
  是否绕过 actionability 检查。默认为 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 布尔值 (可选)添加时间：v1.13#
  
  是否绕过 actionability 检查。默认为 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 (可选)#
  
  是否绕过 actionability 检查。默认为 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 指向一个输入元素。但是，如果元素位于与控制关联的 <label> 元素中，则会将目标设置为控制元素。

用法

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 (可选)#
  
  是否绕过 actionability 检查。默认为 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 布尔值 (可选)在以下版本中添加: 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 (可选)#
  
  是否绕过 actionability 检查。默认为 false。
- setNoWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setPosition Position (可选)在以下版本中添加: v1.11#
  - setX double
  - setY double
  相对于元素填充框左上角使用的点。如果未指定，则使用元素的一些可见点。
- setTimeout double (可选)#
  
  以毫秒为单位的最大时间。默认为 30000（30 秒）。传递 0 以禁用超时。可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改默认值。
- setTrial 布尔值 (可选)在以下版本中添加: v1.11#
  
  设置后，此方法只执行操作性检查并跳过操作。默认值为 false。用于在不执行操作的情况下等待元素准备好执行操作。

void #

waitForSelector

在 v1.9 之前添加

elementHandle.waitForSelector

不推荐

请使用断言可见性或基于定位器的 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