ElementHandle

继承自: JSHandle

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

不推荐

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

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

除非通过 JSHandle.dispose() 释放句柄，否则 ElementHandle 会阻止 DOM 元素被垃圾回收。当其所属的 Frame 发生导航时，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。边界框是相对于主 Frame 视口计算的 - 通常与浏览器窗口相同。

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

子 Frame 中的元素返回相对于主 Frame 的边界框，与 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 节点的元素句柄的内容 Frame，否则返回 null

用法

ElementHandle.contentFrame();

null | Frame #

ownerFrame

在 v1.9 之前添加

elementHandle.ownerFrame

返回包含给定元素的 Frame。

用法

ElementHandle.ownerFrame();

null | Frame #

waitForElementState

在 v1.9 之前添加

elementHandle.waitForElementState

当元素满足 state 条件时返回。

取决于 state 参数，此方法会等待其中一个可操作性检查通过。除非等待 "hidden" 状态，否则当元素在等待时被分离，此方法会抛出错误。

"visible" 等待元素变得可见。
"hidden" 等待元素变得不可见或未附加。请注意，等待 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 的 Locator.check()。详细了解 locators。

此方法通过执行以下步骤来选中元素：

确保元素是复选框或单选输入框。如果不是，此方法会抛出错误。如果元素已被选中，此方法会立即返回。
等待元素的可操作性检查通过，除非设置了 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 的 Locator.click()。详细了解 locators。

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

等待元素的可操作性检查通过，除非设置了 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
  相对于元素内边距框左上角使用的点。如果未指定，则使用元素的某个可见点。
- setTimeout double (可选)#
  
  最大等待时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
- setTrial boolean (可选)添加于: v1.11#
  
  设置后，此方法仅执行可操作性检查并跳过实际操作。默认为 false。这对于等待元素准备好执行操作但又不实际执行操作的情况很有用。

void #

dblclick

在 v1.9 之前添加

elementHandle.dblclick

不推荐

请改用基于 Locator 的 Locator.dblclick()。详细了解 locators。

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

等待元素的可操作性检查通过，除非设置了 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
  相对于元素内边距框左上角使用的点。如果未指定，则使用元素的某个可见点。
- setTimeout double (可选)#
  
  最大等待时间（毫秒）。默认为 30000 (30 秒)。传入 0 可禁用超时。默认值可通过 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改。
- setTrial boolean (可选)添加于: v1.11#
  
  设置后，此方法仅执行可操作性检查并跳过实际操作。默认为 false。这对于等待元素准备好执行操作但又不实际执行操作的情况很有用。

void #

dispatchEvent

在 v1.9 之前添加

elementHandle.dispatchEvent

不推荐

请改用基于 Locator 的 Locator.dispatchEvent()。详细了解 locators。

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

用法

elementHandle.dispatchEvent("click");

其内部会根据给定的 type 创建一个事件实例，使用 eventInit 属性初始化并将其派发到元素上。事件默认是 composed（组合的）、cancelable（可取消的）和 bubble（冒泡的）。

由于 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 的子树中查找与指定 selector 匹配的元素，并将其作为第一个参数传递给 expression。如果没有元素匹配 selector，此方法会抛出错误。

如果 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 的子树中查找所有与指定 selector 匹配的元素，并将匹配元素数组作为第一个参数传递给 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 的 Locator.fill()。详细了解 locators。

此方法会等待可操作性检查通过，聚焦元素，填充内容并在填充后触发 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 的 Locator.focus()。详细了解 locators。

在元素上调用 focus。

用法

ElementHandle.focus();

void #

getAttribute

在 v1.9 之前添加

elementHandle.getAttribute

不推荐

请改用基于 Locator 的 Locator.getAttribute()。详细了解 locators。

返回元素属性值。

用法

ElementHandle.getAttribute(name);

参数

name String #

要获取值的属性名称。

null | String #

hover

在 v1.9 之前添加

elementHandle.hover

不推荐

请改用基于 Locator 的 Locator.hover()。详细了解 locators。

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

等待元素的可操作性检查通过，除非设置了 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。

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

用法

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()。详细了解定位符。

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

用法

ElementHandle.isChecked();

boolean #

isDisabled

在 v1.9 之前添加

elementHandle.isDisabled

不推荐

请使用基于定位符的 Locator.isDisabled()。详细了解定位符。

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

用法

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 枚举 ScreenshotAnimations { DISABLED, ALLOW } （可选）#
  
  当设置为 "disabled" 时，停止 CSS 动画、CSS 过渡和 Web 动画。动画根据其持续时间获得不同的处理：
  - 有限动画被快进到完成，因此它们将触发 transitionend 事件。
  - 无限动画被取消到初始状态，并在屏幕截图后重新播放。
  默认为 "allow"，保持动画不变。
- setCaret 枚举 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 枚举 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 枚举 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 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 指向一个输入元素。但是，如果元素位于具有相关联控件的 <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 (可选)#
  
  是否绕过可操作性检查。默认为 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

不推荐

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

当通过 setState 选项指定的元素满足条件时返回该元素。如果等待 hidden 或 detached 则返回 null。

等待相对于元素句柄的选择器满足setState选项指定的条件（从 DOM 中出现/消失，或变为可见/隐藏）。如果在调用方法时选择器已经满足条件，方法会立即返回。如果在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