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 捕获如何检索元素的逻辑。

在下面的示例中，句柄指向页面上特定的 DOM 元素。如果该元素更改文本或被 React 用于渲染完全不同的组件，则句柄仍然指向该 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 毫秒内未满足条件，此方法将抛出异常。

用法

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 的信息。

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

确保元素是复选框或单选输入框。如果不是，此方法将抛出异常。如果元素已被选中，此方法立即返回。
等待元素上的 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 double (可选)#
  
  最大等待时间，单位毫秒。默认为 30000 (30 秒)。传递 0 以禁用超时。可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改默认值。
- setTrial boolean (可选)添加于: v1.11#
  
  设置后，此方法仅执行 actionability 检查并跳过该操作。默认为 false。用于等待元素准备好进行操作而无需执行操作。

返回值

void #

click

在 v1.9 之前添加

elementHandle.click

不推荐使用

请改用基于 locator 的 Locator.click()。阅读更多关于 locators 的信息。

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

等待元素上的 actionability 检查，除非设置了 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 (可选)#
  
  是否绕过 actionability 检查。默认为 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#
  
  设置后，此方法仅执行 actionability 检查并跳过该操作。默认为 false。用于等待元素准备好进行操作而无需执行操作。

返回值

void #

dblclick

在 v1.9 之前添加

elementHandle.dblclick

不推荐使用

请改用基于 locator 的 Locator.dblclick()。阅读更多关于 locators 的信息。

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

等待元素上的 actionability 检查，除非设置了 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 (可选)#
  
  是否绕过 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 boolean (可选)添加于: v1.11#
  
  设置后，此方法仅执行 actionability 检查并跳过该操作。默认为 false。用于等待元素准备好进行操作而无需执行操作。

返回值

void #

dispatchEvent

在 v1.9 之前添加

elementHandle.dispatchEvent

不推荐使用

请改用基于 locator 的 Locator.dispatchEvent()。阅读更多关于 locators 的信息。

以下代码片段在元素上触发 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

不推荐使用

此方法不等待元素通过 actionability 检查，因此可能导致测试不稳定。请改用 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 String #

要查询的选择器。
expression String #

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

传递给 expression 的可选参数。

返回值

Object #

evalOnSelectorAll

添加于: v1.9

elementHandle.evalOnSelectorAll

不推荐使用

在大多数情况下，Locator.evaluateAll()、其他 Locator 辅助方法和以 Web 为先的断言效果更好。

返回 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 的 Locator.fill()。阅读更多关于 locators 的信息。

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

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

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

用法

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

参数

value String #

要为 <input>、<textarea> 或 [contenteditable] 元素设置的值。
options ElementHandle.FillOptions (可选)
- setForce boolean (可选)添加于: v1.13#
  
  是否绕过 actionability 检查。默认为 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 的信息。

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

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

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

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

用法

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

参数

options ElementHandle.HoverOptions (可选)
- setForce boolean (可选)#
  
  是否绕过 actionability 检查。默认为 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#
  
  设置后，此方法仅执行 actionability 检查并跳过该操作。默认为 false。用于等待元素准备好进行操作而无需执行操作。

返回值

void #

innerHTML

在 v1.9 之前添加

elementHandle.innerHTML

不推荐使用

请改用基于 locator 的 Locator.innerHTML()。阅读更多关于 locators 的信息。

返回 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。

对于非 input 元素会抛出错误。但是，如果元素位于具有关联 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() 方法。阅读更多关于定位器的信息。

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

用法

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() 方法。阅读更多关于定位器的信息。

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

此方法等待 actionability 检查，然后在截取屏幕截图之前将元素滚动到视图中。如果元素从 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() 方法。阅读更多关于定位器的信息。

此方法等待 actionability 检查，然后尝试将元素滚动到视图中，除非它根据 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() 方法。阅读更多关于定位器的信息。

此方法等待 actionability 检查，等待直到所有指定的选项都出现在 <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#
  
  是否绕过 actionability 检查。默认为 false。
- setNoWaitAfter boolean (可选)#
  
  已弃用
  此选项无效。
  
  此选项无效。
- setTimeout double (可选)#
  
  最大等待时间，单位毫秒。默认为 30000 (30 秒)。传递 0 以禁用超时。可以使用 BrowserContext.setDefaultTimeout() 或 Page.setDefaultTimeout() 方法更改默认值。

返回值

List<String>#

selectText

在 v1.9 之前添加

elementHandle.selectText

不推荐使用

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

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

如果元素位于具有关联 control 的 <label> 元素内，则聚焦并选择 control 中的文本。

用法

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

参数

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

返回值

void #

setChecked

添加于: v1.15

elementHandle.setChecked

不推荐使用

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

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

确保元素是复选框或单选输入框。如果不是，则此方法抛出错误。
如果元素已处于正确的选中状态，则此方法立即返回。
等待匹配元素上的 actionability 检查，除非设置了 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 (可选)#
  
  设置后，此方法仅执行 actionability 检查并跳过该操作。默认为 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() 方法。阅读更多关于定位器的信息。

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

等待元素上的 actionability 检查，除非设置了 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 boolean (可选)添加于: v1.11#
  
  设置后，此方法仅执行 actionability 检查并跳过该操作。默认为 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() 方法。阅读更多关于定位器的信息。

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

确保元素是复选框或单选输入框。如果不是，则此方法抛出错误。如果元素已处于未选中状态，则此方法立即返回。
等待元素上的 actionability 检查，除非设置了 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 boolean (可选)添加于: v1.11#
  
  设置后，此方法仅执行 actionability 检查并跳过该操作。默认为 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