mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
chore: generate docs for the protocol (#6213)
This commit is contained in:
parent
ffec2475d0
commit
3effcafcd1
@ -1,7 +1,7 @@
|
||||
{
|
||||
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
|
||||
"mainEntryPointFilePath": "<projectFolder>/lib/cjs/api-docs-entry.d.ts",
|
||||
"bundledPackages": [ ],
|
||||
"bundledPackages": [ "devtools-protocol" ],
|
||||
|
||||
"apiReport": {
|
||||
"enabled": false
|
||||
|
@ -15,7 +15,7 @@ overridePermissions(origin: string, permissions: Protocol.Browser.PermissionType
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| origin | string | The origin to grant permissions to, e.g. "https://example.com". |
|
||||
| permissions | Protocol.Browser.PermissionType\[\] | An array of permissions to grant. All permissions that are not listed here will be automatically denied. |
|
||||
| permissions | [Protocol.Browser.PermissionType](./puppeteer.protocol.browser.permissiontype.md)<!-- -->\[\] | An array of permissions to grant. All permissions that are not listed here will be automatically denied. |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
|
@ -11,7 +11,7 @@ type(): Protocol.Page.DialogType;
|
||||
```
|
||||
<b>Returns:</b>
|
||||
|
||||
Protocol.Page.DialogType
|
||||
[Protocol.Page.DialogType](./puppeteer.protocol.page.dialogtype.md)
|
||||
|
||||
The type of the dialog.
|
||||
|
||||
|
@ -81,6 +81,12 @@
|
||||
| [WaitForTargetOptions](./puppeteer.waitfortargetoptions.md) | |
|
||||
| [WaitTimeoutOptions](./puppeteer.waittimeoutoptions.md) | |
|
||||
|
||||
## Namespaces
|
||||
|
||||
| Namespace | Description |
|
||||
| --- | --- |
|
||||
| [Protocol](./puppeteer.protocol.md) | \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* Auto-generated by protocol-dts-generator.ts, do not edit manually. \* \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* |
|
||||
|
||||
## Variables
|
||||
|
||||
| Variable | Description |
|
||||
|
@ -20,5 +20,5 @@ cookies(...urls: string[]): Promise<Protocol.Network.Cookie[]>;
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
Promise<Protocol.Network.Cookie\[\]>
|
||||
Promise<[Protocol.Network.Cookie](./puppeteer.protocol.network.cookie.md)<!-- -->\[\]>
|
||||
|
||||
|
@ -14,7 +14,7 @@ deleteCookie(...cookies: Protocol.Network.DeleteCookiesRequest[]): Promise<void>
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| cookies | Protocol.Network.DeleteCookiesRequest\[\] | |
|
||||
| cookies | [Protocol.Network.DeleteCookiesRequest](./puppeteer.protocol.network.deletecookiesrequest.md)<!-- -->\[\] | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
|
@ -14,7 +14,7 @@ setCookie(...cookies: Protocol.Network.CookieParam[]): Promise<void>;
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| cookies | Protocol.Network.CookieParam\[\] | |
|
||||
| cookies | [Protocol.Network.CookieParam](./puppeteer.protocol.network.cookieparam.md)<!-- -->\[\] | |
|
||||
|
||||
<b>Returns:</b>
|
||||
|
||||
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXNode](./puppeteer.protocol.accessibility.axnode.md) > [backendDOMNodeId](./puppeteer.protocol.accessibility.axnode.backenddomnodeid.md)
|
||||
|
||||
## Protocol.Accessibility.AXNode.backendDOMNodeId property
|
||||
|
||||
The backend ID for the associated DOM node, if any.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
backendDOMNodeId?: DOM.BackendNodeId;
|
||||
```
|
13
new-docs/puppeteer.protocol.accessibility.axnode.childids.md
Normal file
13
new-docs/puppeteer.protocol.accessibility.axnode.childids.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXNode](./puppeteer.protocol.accessibility.axnode.md) > [childIds](./puppeteer.protocol.accessibility.axnode.childids.md)
|
||||
|
||||
## Protocol.Accessibility.AXNode.childIds property
|
||||
|
||||
IDs for each of this node's child nodes.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
childIds?: AXNodeId[];
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXNode](./puppeteer.protocol.accessibility.axnode.md) > [description](./puppeteer.protocol.accessibility.axnode.description.md)
|
||||
|
||||
## Protocol.Accessibility.AXNode.description property
|
||||
|
||||
The accessible description for this `Node`<!-- -->.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
description?: AXValue;
|
||||
```
|
13
new-docs/puppeteer.protocol.accessibility.axnode.ignored.md
Normal file
13
new-docs/puppeteer.protocol.accessibility.axnode.ignored.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXNode](./puppeteer.protocol.accessibility.axnode.md) > [ignored](./puppeteer.protocol.accessibility.axnode.ignored.md)
|
||||
|
||||
## Protocol.Accessibility.AXNode.ignored property
|
||||
|
||||
Whether this node is ignored for accessibility
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
ignored: boolean;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXNode](./puppeteer.protocol.accessibility.axnode.md) > [ignoredReasons](./puppeteer.protocol.accessibility.axnode.ignoredreasons.md)
|
||||
|
||||
## Protocol.Accessibility.AXNode.ignoredReasons property
|
||||
|
||||
Collection of reasons why this node is hidden.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
ignoredReasons?: AXProperty[];
|
||||
```
|
29
new-docs/puppeteer.protocol.accessibility.axnode.md
Normal file
29
new-docs/puppeteer.protocol.accessibility.axnode.md
Normal file
@ -0,0 +1,29 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXNode](./puppeteer.protocol.accessibility.axnode.md)
|
||||
|
||||
## Protocol.Accessibility.AXNode interface
|
||||
|
||||
A node in the accessibility tree.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface AXNode
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [backendDOMNodeId](./puppeteer.protocol.accessibility.axnode.backenddomnodeid.md) | [DOM.BackendNodeId](./puppeteer.protocol.dom.backendnodeid.md) | The backend ID for the associated DOM node, if any. |
|
||||
| [childIds](./puppeteer.protocol.accessibility.axnode.childids.md) | [AXNodeId](./puppeteer.protocol.accessibility.axnodeid.md)<!-- -->\[\] | IDs for each of this node's child nodes. |
|
||||
| [description](./puppeteer.protocol.accessibility.axnode.description.md) | [AXValue](./puppeteer.protocol.accessibility.axvalue.md) | The accessible description for this <code>Node</code>. |
|
||||
| [ignored](./puppeteer.protocol.accessibility.axnode.ignored.md) | boolean | Whether this node is ignored for accessibility |
|
||||
| [ignoredReasons](./puppeteer.protocol.accessibility.axnode.ignoredreasons.md) | [AXProperty](./puppeteer.protocol.accessibility.axproperty.md)<!-- -->\[\] | Collection of reasons why this node is hidden. |
|
||||
| [name](./puppeteer.protocol.accessibility.axnode.name.md) | [AXValue](./puppeteer.protocol.accessibility.axvalue.md) | The accessible name for this <code>Node</code>. |
|
||||
| [nodeId](./puppeteer.protocol.accessibility.axnode.nodeid.md) | [AXNodeId](./puppeteer.protocol.accessibility.axnodeid.md) | Unique identifier for this node. |
|
||||
| [properties](./puppeteer.protocol.accessibility.axnode.properties.md) | [AXProperty](./puppeteer.protocol.accessibility.axproperty.md)<!-- -->\[\] | All other properties |
|
||||
| [role](./puppeteer.protocol.accessibility.axnode.role.md) | [AXValue](./puppeteer.protocol.accessibility.axvalue.md) | This <code>Node</code>'s role, whether explicit or implicit. |
|
||||
| [value](./puppeteer.protocol.accessibility.axnode.value.md) | [AXValue](./puppeteer.protocol.accessibility.axvalue.md) | The value for this <code>Node</code>. |
|
||||
|
13
new-docs/puppeteer.protocol.accessibility.axnode.name.md
Normal file
13
new-docs/puppeteer.protocol.accessibility.axnode.name.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXNode](./puppeteer.protocol.accessibility.axnode.md) > [name](./puppeteer.protocol.accessibility.axnode.name.md)
|
||||
|
||||
## Protocol.Accessibility.AXNode.name property
|
||||
|
||||
The accessible name for this `Node`<!-- -->.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
name?: AXValue;
|
||||
```
|
13
new-docs/puppeteer.protocol.accessibility.axnode.nodeid.md
Normal file
13
new-docs/puppeteer.protocol.accessibility.axnode.nodeid.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXNode](./puppeteer.protocol.accessibility.axnode.md) > [nodeId](./puppeteer.protocol.accessibility.axnode.nodeid.md)
|
||||
|
||||
## Protocol.Accessibility.AXNode.nodeId property
|
||||
|
||||
Unique identifier for this node.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
nodeId: AXNodeId;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXNode](./puppeteer.protocol.accessibility.axnode.md) > [properties](./puppeteer.protocol.accessibility.axnode.properties.md)
|
||||
|
||||
## Protocol.Accessibility.AXNode.properties property
|
||||
|
||||
All other properties
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
properties?: AXProperty[];
|
||||
```
|
13
new-docs/puppeteer.protocol.accessibility.axnode.role.md
Normal file
13
new-docs/puppeteer.protocol.accessibility.axnode.role.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXNode](./puppeteer.protocol.accessibility.axnode.md) > [role](./puppeteer.protocol.accessibility.axnode.role.md)
|
||||
|
||||
## Protocol.Accessibility.AXNode.role property
|
||||
|
||||
This `Node`<!-- -->'s role, whether explicit or implicit.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
role?: AXValue;
|
||||
```
|
13
new-docs/puppeteer.protocol.accessibility.axnode.value.md
Normal file
13
new-docs/puppeteer.protocol.accessibility.axnode.value.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXNode](./puppeteer.protocol.accessibility.axnode.md) > [value](./puppeteer.protocol.accessibility.axnode.value.md)
|
||||
|
||||
## Protocol.Accessibility.AXNode.value property
|
||||
|
||||
The value for this `Node`<!-- -->.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
value?: AXValue;
|
||||
```
|
13
new-docs/puppeteer.protocol.accessibility.axnodeid.md
Normal file
13
new-docs/puppeteer.protocol.accessibility.axnodeid.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXNodeId](./puppeteer.protocol.accessibility.axnodeid.md)
|
||||
|
||||
## Protocol.Accessibility.AXNodeId type
|
||||
|
||||
Unique accessibility node identifier.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export type AXNodeId = string;
|
||||
```
|
19
new-docs/puppeteer.protocol.accessibility.axproperty.md
Normal file
19
new-docs/puppeteer.protocol.accessibility.axproperty.md
Normal file
@ -0,0 +1,19 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXProperty](./puppeteer.protocol.accessibility.axproperty.md)
|
||||
|
||||
## Protocol.Accessibility.AXProperty interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface AXProperty
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [name](./puppeteer.protocol.accessibility.axproperty.name.md) | [AXPropertyName](./puppeteer.protocol.accessibility.axpropertyname.md) | The name of this property. |
|
||||
| [value](./puppeteer.protocol.accessibility.axproperty.value.md) | [AXValue](./puppeteer.protocol.accessibility.axvalue.md) | The value of this property. |
|
||||
|
13
new-docs/puppeteer.protocol.accessibility.axproperty.name.md
Normal file
13
new-docs/puppeteer.protocol.accessibility.axproperty.name.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXProperty](./puppeteer.protocol.accessibility.axproperty.md) > [name](./puppeteer.protocol.accessibility.axproperty.name.md)
|
||||
|
||||
## Protocol.Accessibility.AXProperty.name property
|
||||
|
||||
The name of this property.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
name: AXPropertyName;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXProperty](./puppeteer.protocol.accessibility.axproperty.md) > [value](./puppeteer.protocol.accessibility.axproperty.value.md)
|
||||
|
||||
## Protocol.Accessibility.AXProperty.value property
|
||||
|
||||
The value of this property.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
value: AXValue;
|
||||
```
|
13
new-docs/puppeteer.protocol.accessibility.axpropertyname.md
Normal file
13
new-docs/puppeteer.protocol.accessibility.axpropertyname.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXPropertyName](./puppeteer.protocol.accessibility.axpropertyname.md)
|
||||
|
||||
## Protocol.Accessibility.AXPropertyName type
|
||||
|
||||
Values of AXProperty name: - from 'busy' to 'roledescription': states which apply to every AX node - from 'live' to 'root': attributes which apply to nodes in live regions - from 'autocomplete' to 'valuetext': attributes which apply to widgets - from 'checked' to 'selected': states which apply to widgets - from 'activedescendant' to 'owns' - relationships between elements other than parent/child/sibling.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export type AXPropertyName = ('busy' | 'disabled' | 'editable' | 'focusable' | 'focused' | 'hidden' | 'hiddenRoot' | 'invalid' | 'keyshortcuts' | 'settable' | 'roledescription' | 'live' | 'atomic' | 'relevant' | 'root' | 'autocomplete' | 'hasPopup' | 'level' | 'multiselectable' | 'orientation' | 'multiline' | 'readonly' | 'required' | 'valuemin' | 'valuemax' | 'valuetext' | 'checked' | 'expanded' | 'modal' | 'pressed' | 'selected' | 'activedescendant' | 'controls' | 'describedby' | 'details' | 'errormessage' | 'flowto' | 'labelledby' | 'owns');
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXRelatedNode](./puppeteer.protocol.accessibility.axrelatednode.md) > [backendDOMNodeId](./puppeteer.protocol.accessibility.axrelatednode.backenddomnodeid.md)
|
||||
|
||||
## Protocol.Accessibility.AXRelatedNode.backendDOMNodeId property
|
||||
|
||||
The BackendNodeId of the related DOM node.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
backendDOMNodeId: DOM.BackendNodeId;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXRelatedNode](./puppeteer.protocol.accessibility.axrelatednode.md) > [idref](./puppeteer.protocol.accessibility.axrelatednode.idref.md)
|
||||
|
||||
## Protocol.Accessibility.AXRelatedNode.idref property
|
||||
|
||||
The IDRef value provided, if any.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
idref?: string;
|
||||
```
|
20
new-docs/puppeteer.protocol.accessibility.axrelatednode.md
Normal file
20
new-docs/puppeteer.protocol.accessibility.axrelatednode.md
Normal file
@ -0,0 +1,20 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXRelatedNode](./puppeteer.protocol.accessibility.axrelatednode.md)
|
||||
|
||||
## Protocol.Accessibility.AXRelatedNode interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface AXRelatedNode
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [backendDOMNodeId](./puppeteer.protocol.accessibility.axrelatednode.backenddomnodeid.md) | [DOM.BackendNodeId](./puppeteer.protocol.dom.backendnodeid.md) | The BackendNodeId of the related DOM node. |
|
||||
| [idref](./puppeteer.protocol.accessibility.axrelatednode.idref.md) | string | The IDRef value provided, if any. |
|
||||
| [text](./puppeteer.protocol.accessibility.axrelatednode.text.md) | string | The text alternative of this node in the current context. |
|
||||
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXRelatedNode](./puppeteer.protocol.accessibility.axrelatednode.md) > [text](./puppeteer.protocol.accessibility.axrelatednode.text.md)
|
||||
|
||||
## Protocol.Accessibility.AXRelatedNode.text property
|
||||
|
||||
The text alternative of this node in the current context.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
text?: string;
|
||||
```
|
23
new-docs/puppeteer.protocol.accessibility.axvalue.md
Normal file
23
new-docs/puppeteer.protocol.accessibility.axvalue.md
Normal file
@ -0,0 +1,23 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValue](./puppeteer.protocol.accessibility.axvalue.md)
|
||||
|
||||
## Protocol.Accessibility.AXValue interface
|
||||
|
||||
A single computed AX property.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface AXValue
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [relatedNodes](./puppeteer.protocol.accessibility.axvalue.relatednodes.md) | [AXRelatedNode](./puppeteer.protocol.accessibility.axrelatednode.md)<!-- -->\[\] | One or more related nodes, if applicable. |
|
||||
| [sources](./puppeteer.protocol.accessibility.axvalue.sources.md) | [AXValueSource](./puppeteer.protocol.accessibility.axvaluesource.md)<!-- -->\[\] | The sources which contributed to the computation of this property. |
|
||||
| [type](./puppeteer.protocol.accessibility.axvalue.type.md) | [AXValueType](./puppeteer.protocol.accessibility.axvaluetype.md) | The type of this value. |
|
||||
| [value](./puppeteer.protocol.accessibility.axvalue.value.md) | any | The computed value of this property. |
|
||||
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValue](./puppeteer.protocol.accessibility.axvalue.md) > [relatedNodes](./puppeteer.protocol.accessibility.axvalue.relatednodes.md)
|
||||
|
||||
## Protocol.Accessibility.AXValue.relatedNodes property
|
||||
|
||||
One or more related nodes, if applicable.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
relatedNodes?: AXRelatedNode[];
|
||||
```
|
13
new-docs/puppeteer.protocol.accessibility.axvalue.sources.md
Normal file
13
new-docs/puppeteer.protocol.accessibility.axvalue.sources.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValue](./puppeteer.protocol.accessibility.axvalue.md) > [sources](./puppeteer.protocol.accessibility.axvalue.sources.md)
|
||||
|
||||
## Protocol.Accessibility.AXValue.sources property
|
||||
|
||||
The sources which contributed to the computation of this property.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
sources?: AXValueSource[];
|
||||
```
|
13
new-docs/puppeteer.protocol.accessibility.axvalue.type.md
Normal file
13
new-docs/puppeteer.protocol.accessibility.axvalue.type.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValue](./puppeteer.protocol.accessibility.axvalue.md) > [type](./puppeteer.protocol.accessibility.axvalue.type.md)
|
||||
|
||||
## Protocol.Accessibility.AXValue.type property
|
||||
|
||||
The type of this value.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
type: AXValueType;
|
||||
```
|
13
new-docs/puppeteer.protocol.accessibility.axvalue.value.md
Normal file
13
new-docs/puppeteer.protocol.accessibility.axvalue.value.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValue](./puppeteer.protocol.accessibility.axvalue.md) > [value](./puppeteer.protocol.accessibility.axvalue.value.md)
|
||||
|
||||
## Protocol.Accessibility.AXValue.value property
|
||||
|
||||
The computed value of this property.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
value?: any;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValueNativeSourceType](./puppeteer.protocol.accessibility.axvaluenativesourcetype.md)
|
||||
|
||||
## Protocol.Accessibility.AXValueNativeSourceType type
|
||||
|
||||
Enum of possible native property sources (as a subtype of a particular AXValueSourceType).
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export type AXValueNativeSourceType = ('figcaption' | 'label' | 'labelfor' | 'labelwrapped' | 'legend' | 'tablecaption' | 'title' | 'other');
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValueSource](./puppeteer.protocol.accessibility.axvaluesource.md) > [attribute](./puppeteer.protocol.accessibility.axvaluesource.attribute.md)
|
||||
|
||||
## Protocol.Accessibility.AXValueSource.attribute property
|
||||
|
||||
The name of the relevant attribute, if any.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
attribute?: string;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValueSource](./puppeteer.protocol.accessibility.axvaluesource.md) > [attributeValue](./puppeteer.protocol.accessibility.axvaluesource.attributevalue.md)
|
||||
|
||||
## Protocol.Accessibility.AXValueSource.attributeValue property
|
||||
|
||||
The value of the relevant attribute, if any.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
attributeValue?: AXValue;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValueSource](./puppeteer.protocol.accessibility.axvaluesource.md) > [invalid](./puppeteer.protocol.accessibility.axvaluesource.invalid.md)
|
||||
|
||||
## Protocol.Accessibility.AXValueSource.invalid property
|
||||
|
||||
Whether the value for this property is invalid.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
invalid?: boolean;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValueSource](./puppeteer.protocol.accessibility.axvaluesource.md) > [invalidReason](./puppeteer.protocol.accessibility.axvaluesource.invalidreason.md)
|
||||
|
||||
## Protocol.Accessibility.AXValueSource.invalidReason property
|
||||
|
||||
Reason for the value being invalid, if it is.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
invalidReason?: string;
|
||||
```
|
28
new-docs/puppeteer.protocol.accessibility.axvaluesource.md
Normal file
28
new-docs/puppeteer.protocol.accessibility.axvaluesource.md
Normal file
@ -0,0 +1,28 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValueSource](./puppeteer.protocol.accessibility.axvaluesource.md)
|
||||
|
||||
## Protocol.Accessibility.AXValueSource interface
|
||||
|
||||
A single source for a computed AX property.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface AXValueSource
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [attribute](./puppeteer.protocol.accessibility.axvaluesource.attribute.md) | string | The name of the relevant attribute, if any. |
|
||||
| [attributeValue](./puppeteer.protocol.accessibility.axvaluesource.attributevalue.md) | [AXValue](./puppeteer.protocol.accessibility.axvalue.md) | The value of the relevant attribute, if any. |
|
||||
| [invalid](./puppeteer.protocol.accessibility.axvaluesource.invalid.md) | boolean | Whether the value for this property is invalid. |
|
||||
| [invalidReason](./puppeteer.protocol.accessibility.axvaluesource.invalidreason.md) | string | Reason for the value being invalid, if it is. |
|
||||
| [nativeSource](./puppeteer.protocol.accessibility.axvaluesource.nativesource.md) | [AXValueNativeSourceType](./puppeteer.protocol.accessibility.axvaluenativesourcetype.md) | The native markup source for this value, e.g. a <label> element. |
|
||||
| [nativeSourceValue](./puppeteer.protocol.accessibility.axvaluesource.nativesourcevalue.md) | [AXValue](./puppeteer.protocol.accessibility.axvalue.md) | The value, such as a node or node list, of the native source. |
|
||||
| [superseded](./puppeteer.protocol.accessibility.axvaluesource.superseded.md) | boolean | Whether this source is superseded by a higher priority source. |
|
||||
| [type](./puppeteer.protocol.accessibility.axvaluesource.type.md) | [AXValueSourceType](./puppeteer.protocol.accessibility.axvaluesourcetype.md) | What type of source this is. |
|
||||
| [value](./puppeteer.protocol.accessibility.axvaluesource.value.md) | [AXValue](./puppeteer.protocol.accessibility.axvalue.md) | The value of this property source. |
|
||||
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValueSource](./puppeteer.protocol.accessibility.axvaluesource.md) > [nativeSource](./puppeteer.protocol.accessibility.axvaluesource.nativesource.md)
|
||||
|
||||
## Protocol.Accessibility.AXValueSource.nativeSource property
|
||||
|
||||
The native markup source for this value, e.g. a <label> element.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
nativeSource?: AXValueNativeSourceType;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValueSource](./puppeteer.protocol.accessibility.axvaluesource.md) > [nativeSourceValue](./puppeteer.protocol.accessibility.axvaluesource.nativesourcevalue.md)
|
||||
|
||||
## Protocol.Accessibility.AXValueSource.nativeSourceValue property
|
||||
|
||||
The value, such as a node or node list, of the native source.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
nativeSourceValue?: AXValue;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValueSource](./puppeteer.protocol.accessibility.axvaluesource.md) > [superseded](./puppeteer.protocol.accessibility.axvaluesource.superseded.md)
|
||||
|
||||
## Protocol.Accessibility.AXValueSource.superseded property
|
||||
|
||||
Whether this source is superseded by a higher priority source.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
superseded?: boolean;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValueSource](./puppeteer.protocol.accessibility.axvaluesource.md) > [type](./puppeteer.protocol.accessibility.axvaluesource.type.md)
|
||||
|
||||
## Protocol.Accessibility.AXValueSource.type property
|
||||
|
||||
What type of source this is.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
type: AXValueSourceType;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValueSource](./puppeteer.protocol.accessibility.axvaluesource.md) > [value](./puppeteer.protocol.accessibility.axvaluesource.value.md)
|
||||
|
||||
## Protocol.Accessibility.AXValueSource.value property
|
||||
|
||||
The value of this property source.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
value?: AXValue;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValueSourceType](./puppeteer.protocol.accessibility.axvaluesourcetype.md)
|
||||
|
||||
## Protocol.Accessibility.AXValueSourceType type
|
||||
|
||||
Enum of possible property sources.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export type AXValueSourceType = ('attribute' | 'implicit' | 'style' | 'contents' | 'placeholder' | 'relatedElement');
|
||||
```
|
13
new-docs/puppeteer.protocol.accessibility.axvaluetype.md
Normal file
13
new-docs/puppeteer.protocol.accessibility.axvaluetype.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [AXValueType](./puppeteer.protocol.accessibility.axvaluetype.md)
|
||||
|
||||
## Protocol.Accessibility.AXValueType type
|
||||
|
||||
Enum of possible property types.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export type AXValueType = ('boolean' | 'tristate' | 'booleanOrUndefined' | 'idref' | 'idrefList' | 'integer' | 'node' | 'nodeList' | 'number' | 'string' | 'computedString' | 'token' | 'tokenList' | 'domRelation' | 'role' | 'internalRole' | 'valueUndefined');
|
||||
```
|
@ -0,0 +1,18 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [GetFullAXTreeResponse](./puppeteer.protocol.accessibility.getfullaxtreeresponse.md)
|
||||
|
||||
## Protocol.Accessibility.GetFullAXTreeResponse interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface GetFullAXTreeResponse
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [nodes](./puppeteer.protocol.accessibility.getfullaxtreeresponse.nodes.md) | [AXNode](./puppeteer.protocol.accessibility.axnode.md)<!-- -->\[\] | |
|
||||
|
@ -0,0 +1,11 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [GetFullAXTreeResponse](./puppeteer.protocol.accessibility.getfullaxtreeresponse.md) > [nodes](./puppeteer.protocol.accessibility.getfullaxtreeresponse.nodes.md)
|
||||
|
||||
## Protocol.Accessibility.GetFullAXTreeResponse.nodes property
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
nodes: AXNode[];
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [GetPartialAXTreeRequest](./puppeteer.protocol.accessibility.getpartialaxtreerequest.md) > [backendNodeId](./puppeteer.protocol.accessibility.getpartialaxtreerequest.backendnodeid.md)
|
||||
|
||||
## Protocol.Accessibility.GetPartialAXTreeRequest.backendNodeId property
|
||||
|
||||
Identifier of the backend node to get the partial accessibility tree for.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
backendNodeId?: DOM.BackendNodeId;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [GetPartialAXTreeRequest](./puppeteer.protocol.accessibility.getpartialaxtreerequest.md) > [fetchRelatives](./puppeteer.protocol.accessibility.getpartialaxtreerequest.fetchrelatives.md)
|
||||
|
||||
## Protocol.Accessibility.GetPartialAXTreeRequest.fetchRelatives property
|
||||
|
||||
Whether to fetch this nodes ancestors, siblings and children. Defaults to true.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
fetchRelatives?: boolean;
|
||||
```
|
@ -0,0 +1,21 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [GetPartialAXTreeRequest](./puppeteer.protocol.accessibility.getpartialaxtreerequest.md)
|
||||
|
||||
## Protocol.Accessibility.GetPartialAXTreeRequest interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface GetPartialAXTreeRequest
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [backendNodeId](./puppeteer.protocol.accessibility.getpartialaxtreerequest.backendnodeid.md) | [DOM.BackendNodeId](./puppeteer.protocol.dom.backendnodeid.md) | Identifier of the backend node to get the partial accessibility tree for. |
|
||||
| [fetchRelatives](./puppeteer.protocol.accessibility.getpartialaxtreerequest.fetchrelatives.md) | boolean | Whether to fetch this nodes ancestors, siblings and children. Defaults to true. |
|
||||
| [nodeId](./puppeteer.protocol.accessibility.getpartialaxtreerequest.nodeid.md) | [DOM.NodeId](./puppeteer.protocol.dom.nodeid.md) | Identifier of the node to get the partial accessibility tree for. |
|
||||
| [objectId](./puppeteer.protocol.accessibility.getpartialaxtreerequest.objectid.md) | [Runtime.RemoteObjectId](./puppeteer.protocol.runtime.remoteobjectid.md) | JavaScript object id of the node wrapper to get the partial accessibility tree for. |
|
||||
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [GetPartialAXTreeRequest](./puppeteer.protocol.accessibility.getpartialaxtreerequest.md) > [nodeId](./puppeteer.protocol.accessibility.getpartialaxtreerequest.nodeid.md)
|
||||
|
||||
## Protocol.Accessibility.GetPartialAXTreeRequest.nodeId property
|
||||
|
||||
Identifier of the node to get the partial accessibility tree for.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
nodeId?: DOM.NodeId;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [GetPartialAXTreeRequest](./puppeteer.protocol.accessibility.getpartialaxtreerequest.md) > [objectId](./puppeteer.protocol.accessibility.getpartialaxtreerequest.objectid.md)
|
||||
|
||||
## Protocol.Accessibility.GetPartialAXTreeRequest.objectId property
|
||||
|
||||
JavaScript object id of the node wrapper to get the partial accessibility tree for.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
objectId?: Runtime.RemoteObjectId;
|
||||
```
|
@ -0,0 +1,18 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [GetPartialAXTreeResponse](./puppeteer.protocol.accessibility.getpartialaxtreeresponse.md)
|
||||
|
||||
## Protocol.Accessibility.GetPartialAXTreeResponse interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface GetPartialAXTreeResponse
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [nodes](./puppeteer.protocol.accessibility.getpartialaxtreeresponse.nodes.md) | [AXNode](./puppeteer.protocol.accessibility.axnode.md)<!-- -->\[\] | The <code>Accessibility.AXNode</code> for this DOM node, if it exists, plus its ancestors, siblings and children, if requested. |
|
||||
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md) > [GetPartialAXTreeResponse](./puppeteer.protocol.accessibility.getpartialaxtreeresponse.md) > [nodes](./puppeteer.protocol.accessibility.getpartialaxtreeresponse.nodes.md)
|
||||
|
||||
## Protocol.Accessibility.GetPartialAXTreeResponse.nodes property
|
||||
|
||||
The `Accessibility.AXNode` for this DOM node, if it exists, plus its ancestors, siblings and children, if requested.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
nodes: AXNode[];
|
||||
```
|
35
new-docs/puppeteer.protocol.accessibility.md
Normal file
35
new-docs/puppeteer.protocol.accessibility.md
Normal file
@ -0,0 +1,35 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Accessibility](./puppeteer.protocol.accessibility.md)
|
||||
|
||||
## Protocol.Accessibility namespace
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export namespace Accessibility
|
||||
```
|
||||
|
||||
## Interfaces
|
||||
|
||||
| Interface | Description |
|
||||
| --- | --- |
|
||||
| [AXNode](./puppeteer.protocol.accessibility.axnode.md) | A node in the accessibility tree. |
|
||||
| [AXProperty](./puppeteer.protocol.accessibility.axproperty.md) | |
|
||||
| [AXRelatedNode](./puppeteer.protocol.accessibility.axrelatednode.md) | |
|
||||
| [AXValue](./puppeteer.protocol.accessibility.axvalue.md) | A single computed AX property. |
|
||||
| [AXValueSource](./puppeteer.protocol.accessibility.axvaluesource.md) | A single source for a computed AX property. |
|
||||
| [GetFullAXTreeResponse](./puppeteer.protocol.accessibility.getfullaxtreeresponse.md) | |
|
||||
| [GetPartialAXTreeRequest](./puppeteer.protocol.accessibility.getpartialaxtreerequest.md) | |
|
||||
| [GetPartialAXTreeResponse](./puppeteer.protocol.accessibility.getpartialaxtreeresponse.md) | |
|
||||
|
||||
## Type Aliases
|
||||
|
||||
| Type Alias | Description |
|
||||
| --- | --- |
|
||||
| [AXNodeId](./puppeteer.protocol.accessibility.axnodeid.md) | Unique accessibility node identifier. |
|
||||
| [AXPropertyName](./puppeteer.protocol.accessibility.axpropertyname.md) | Values of AXProperty name: - from 'busy' to 'roledescription': states which apply to every AX node - from 'live' to 'root': attributes which apply to nodes in live regions - from 'autocomplete' to 'valuetext': attributes which apply to widgets - from 'checked' to 'selected': states which apply to widgets - from 'activedescendant' to 'owns' - relationships between elements other than parent/child/sibling. |
|
||||
| [AXValueNativeSourceType](./puppeteer.protocol.accessibility.axvaluenativesourcetype.md) | Enum of possible native property sources (as a subtype of a particular AXValueSourceType). |
|
||||
| [AXValueSourceType](./puppeteer.protocol.accessibility.axvaluesourcetype.md) | Enum of possible property sources. |
|
||||
| [AXValueType](./puppeteer.protocol.accessibility.axvaluetype.md) | Enum of possible property types. |
|
||||
|
13
new-docs/puppeteer.protocol.animation.animation.cssid.md
Normal file
13
new-docs/puppeteer.protocol.animation.animation.cssid.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [Animation](./puppeteer.protocol.animation.animation.md) > [cssId](./puppeteer.protocol.animation.animation.cssid.md)
|
||||
|
||||
## Protocol.Animation.Animation.cssId property
|
||||
|
||||
A unique ID for `Animation` representing the sources that triggered this CSS animation/transition.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
cssId?: string;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [Animation](./puppeteer.protocol.animation.animation.md) > [currentTime](./puppeteer.protocol.animation.animation.currenttime.md)
|
||||
|
||||
## Protocol.Animation.Animation.currentTime property
|
||||
|
||||
`Animation`<!-- -->'s current time.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
currentTime: number;
|
||||
```
|
13
new-docs/puppeteer.protocol.animation.animation.id.md
Normal file
13
new-docs/puppeteer.protocol.animation.animation.id.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [Animation](./puppeteer.protocol.animation.animation.md) > [id](./puppeteer.protocol.animation.animation.id.md)
|
||||
|
||||
## Protocol.Animation.Animation.id property
|
||||
|
||||
`Animation`<!-- -->'s id.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
id: string;
|
||||
```
|
29
new-docs/puppeteer.protocol.animation.animation.md
Normal file
29
new-docs/puppeteer.protocol.animation.animation.md
Normal file
@ -0,0 +1,29 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [Animation](./puppeteer.protocol.animation.animation.md)
|
||||
|
||||
## Protocol.Animation.Animation interface
|
||||
|
||||
Animation instance.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface Animation
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [cssId](./puppeteer.protocol.animation.animation.cssid.md) | string | A unique ID for <code>Animation</code> representing the sources that triggered this CSS animation/transition. |
|
||||
| [currentTime](./puppeteer.protocol.animation.animation.currenttime.md) | number | <code>Animation</code>'s current time. |
|
||||
| [id](./puppeteer.protocol.animation.animation.id.md) | string | <code>Animation</code>'s id. |
|
||||
| [name](./puppeteer.protocol.animation.animation.name.md) | string | <code>Animation</code>'s name. |
|
||||
| [pausedState](./puppeteer.protocol.animation.animation.pausedstate.md) | boolean | <code>Animation</code>'s internal paused state. |
|
||||
| [playbackRate](./puppeteer.protocol.animation.animation.playbackrate.md) | number | <code>Animation</code>'s playback rate. |
|
||||
| [playState](./puppeteer.protocol.animation.animation.playstate.md) | string | <code>Animation</code>'s play state. |
|
||||
| [source](./puppeteer.protocol.animation.animation.source.md) | [AnimationEffect](./puppeteer.protocol.animation.animationeffect.md) | <code>Animation</code>'s source animation node. |
|
||||
| [startTime](./puppeteer.protocol.animation.animation.starttime.md) | number | <code>Animation</code>'s start time. |
|
||||
| [type](./puppeteer.protocol.animation.animation.type.md) | ('CSSTransition' \| 'CSSAnimation' \| 'WebAnimation') | Animation type of <code>Animation</code>. |
|
||||
|
13
new-docs/puppeteer.protocol.animation.animation.name.md
Normal file
13
new-docs/puppeteer.protocol.animation.animation.name.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [Animation](./puppeteer.protocol.animation.animation.md) > [name](./puppeteer.protocol.animation.animation.name.md)
|
||||
|
||||
## Protocol.Animation.Animation.name property
|
||||
|
||||
`Animation`<!-- -->'s name.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
name: string;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [Animation](./puppeteer.protocol.animation.animation.md) > [pausedState](./puppeteer.protocol.animation.animation.pausedstate.md)
|
||||
|
||||
## Protocol.Animation.Animation.pausedState property
|
||||
|
||||
`Animation`<!-- -->'s internal paused state.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
pausedState: boolean;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [Animation](./puppeteer.protocol.animation.animation.md) > [playbackRate](./puppeteer.protocol.animation.animation.playbackrate.md)
|
||||
|
||||
## Protocol.Animation.Animation.playbackRate property
|
||||
|
||||
`Animation`<!-- -->'s playback rate.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
playbackRate: number;
|
||||
```
|
13
new-docs/puppeteer.protocol.animation.animation.playstate.md
Normal file
13
new-docs/puppeteer.protocol.animation.animation.playstate.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [Animation](./puppeteer.protocol.animation.animation.md) > [playState](./puppeteer.protocol.animation.animation.playstate.md)
|
||||
|
||||
## Protocol.Animation.Animation.playState property
|
||||
|
||||
`Animation`<!-- -->'s play state.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
playState: string;
|
||||
```
|
13
new-docs/puppeteer.protocol.animation.animation.source.md
Normal file
13
new-docs/puppeteer.protocol.animation.animation.source.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [Animation](./puppeteer.protocol.animation.animation.md) > [source](./puppeteer.protocol.animation.animation.source.md)
|
||||
|
||||
## Protocol.Animation.Animation.source property
|
||||
|
||||
`Animation`<!-- -->'s source animation node.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
source?: AnimationEffect;
|
||||
```
|
13
new-docs/puppeteer.protocol.animation.animation.starttime.md
Normal file
13
new-docs/puppeteer.protocol.animation.animation.starttime.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [Animation](./puppeteer.protocol.animation.animation.md) > [startTime](./puppeteer.protocol.animation.animation.starttime.md)
|
||||
|
||||
## Protocol.Animation.Animation.startTime property
|
||||
|
||||
`Animation`<!-- -->'s start time.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
startTime: number;
|
||||
```
|
13
new-docs/puppeteer.protocol.animation.animation.type.md
Normal file
13
new-docs/puppeteer.protocol.animation.animation.type.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [Animation](./puppeteer.protocol.animation.animation.md) > [type](./puppeteer.protocol.animation.animation.type.md)
|
||||
|
||||
## Protocol.Animation.Animation.type property
|
||||
|
||||
Animation type of `Animation`<!-- -->.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
type: ('CSSTransition' | 'CSSAnimation' | 'WebAnimation');
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [AnimationCanceledEvent](./puppeteer.protocol.animation.animationcanceledevent.md) > [id](./puppeteer.protocol.animation.animationcanceledevent.id.md)
|
||||
|
||||
## Protocol.Animation.AnimationCanceledEvent.id property
|
||||
|
||||
Id of the animation that was cancelled.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
id: string;
|
||||
```
|
@ -0,0 +1,20 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [AnimationCanceledEvent](./puppeteer.protocol.animation.animationcanceledevent.md)
|
||||
|
||||
## Protocol.Animation.AnimationCanceledEvent interface
|
||||
|
||||
Event for when an animation has been cancelled.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface AnimationCanceledEvent
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [id](./puppeteer.protocol.animation.animationcanceledevent.id.md) | string | Id of the animation that was cancelled. |
|
||||
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [AnimationCreatedEvent](./puppeteer.protocol.animation.animationcreatedevent.md) > [id](./puppeteer.protocol.animation.animationcreatedevent.id.md)
|
||||
|
||||
## Protocol.Animation.AnimationCreatedEvent.id property
|
||||
|
||||
Id of the animation that was created.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
id: string;
|
||||
```
|
@ -0,0 +1,20 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [AnimationCreatedEvent](./puppeteer.protocol.animation.animationcreatedevent.md)
|
||||
|
||||
## Protocol.Animation.AnimationCreatedEvent interface
|
||||
|
||||
Event for each animation that has been created.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface AnimationCreatedEvent
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [id](./puppeteer.protocol.animation.animationcreatedevent.id.md) | string | Id of the animation that was created. |
|
||||
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [AnimationEffect](./puppeteer.protocol.animation.animationeffect.md) > [backendNodeId](./puppeteer.protocol.animation.animationeffect.backendnodeid.md)
|
||||
|
||||
## Protocol.Animation.AnimationEffect.backendNodeId property
|
||||
|
||||
`AnimationEffect`<!-- -->'s target node.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
backendNodeId?: DOM.BackendNodeId;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [AnimationEffect](./puppeteer.protocol.animation.animationeffect.md) > [delay](./puppeteer.protocol.animation.animationeffect.delay.md)
|
||||
|
||||
## Protocol.Animation.AnimationEffect.delay property
|
||||
|
||||
`AnimationEffect`<!-- -->'s delay.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
delay: number;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [AnimationEffect](./puppeteer.protocol.animation.animationeffect.md) > [direction](./puppeteer.protocol.animation.animationeffect.direction.md)
|
||||
|
||||
## Protocol.Animation.AnimationEffect.direction property
|
||||
|
||||
`AnimationEffect`<!-- -->'s playback direction.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
direction: string;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [AnimationEffect](./puppeteer.protocol.animation.animationeffect.md) > [duration](./puppeteer.protocol.animation.animationeffect.duration.md)
|
||||
|
||||
## Protocol.Animation.AnimationEffect.duration property
|
||||
|
||||
`AnimationEffect`<!-- -->'s iteration duration.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
duration: number;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [AnimationEffect](./puppeteer.protocol.animation.animationeffect.md) > [easing](./puppeteer.protocol.animation.animationeffect.easing.md)
|
||||
|
||||
## Protocol.Animation.AnimationEffect.easing property
|
||||
|
||||
`AnimationEffect`<!-- -->'s timing function.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
easing: string;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [AnimationEffect](./puppeteer.protocol.animation.animationeffect.md) > [endDelay](./puppeteer.protocol.animation.animationeffect.enddelay.md)
|
||||
|
||||
## Protocol.Animation.AnimationEffect.endDelay property
|
||||
|
||||
`AnimationEffect`<!-- -->'s end delay.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
endDelay: number;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [AnimationEffect](./puppeteer.protocol.animation.animationeffect.md) > [fill](./puppeteer.protocol.animation.animationeffect.fill.md)
|
||||
|
||||
## Protocol.Animation.AnimationEffect.fill property
|
||||
|
||||
`AnimationEffect`<!-- -->'s fill mode.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
fill: string;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [AnimationEffect](./puppeteer.protocol.animation.animationeffect.md) > [iterations](./puppeteer.protocol.animation.animationeffect.iterations.md)
|
||||
|
||||
## Protocol.Animation.AnimationEffect.iterations property
|
||||
|
||||
`AnimationEffect`<!-- -->'s iterations.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
iterations: number;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [AnimationEffect](./puppeteer.protocol.animation.animationeffect.md) > [iterationStart](./puppeteer.protocol.animation.animationeffect.iterationstart.md)
|
||||
|
||||
## Protocol.Animation.AnimationEffect.iterationStart property
|
||||
|
||||
`AnimationEffect`<!-- -->'s iteration start.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
iterationStart: number;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [AnimationEffect](./puppeteer.protocol.animation.animationeffect.md) > [keyframesRule](./puppeteer.protocol.animation.animationeffect.keyframesrule.md)
|
||||
|
||||
## Protocol.Animation.AnimationEffect.keyframesRule property
|
||||
|
||||
`AnimationEffect`<!-- -->'s keyframes.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
keyframesRule?: KeyframesRule;
|
||||
```
|
29
new-docs/puppeteer.protocol.animation.animationeffect.md
Normal file
29
new-docs/puppeteer.protocol.animation.animationeffect.md
Normal file
@ -0,0 +1,29 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [AnimationEffect](./puppeteer.protocol.animation.animationeffect.md)
|
||||
|
||||
## Protocol.Animation.AnimationEffect interface
|
||||
|
||||
AnimationEffect instance
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface AnimationEffect
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [backendNodeId](./puppeteer.protocol.animation.animationeffect.backendnodeid.md) | [DOM.BackendNodeId](./puppeteer.protocol.dom.backendnodeid.md) | <code>AnimationEffect</code>'s target node. |
|
||||
| [delay](./puppeteer.protocol.animation.animationeffect.delay.md) | number | <code>AnimationEffect</code>'s delay. |
|
||||
| [direction](./puppeteer.protocol.animation.animationeffect.direction.md) | string | <code>AnimationEffect</code>'s playback direction. |
|
||||
| [duration](./puppeteer.protocol.animation.animationeffect.duration.md) | number | <code>AnimationEffect</code>'s iteration duration. |
|
||||
| [easing](./puppeteer.protocol.animation.animationeffect.easing.md) | string | <code>AnimationEffect</code>'s timing function. |
|
||||
| [endDelay](./puppeteer.protocol.animation.animationeffect.enddelay.md) | number | <code>AnimationEffect</code>'s end delay. |
|
||||
| [fill](./puppeteer.protocol.animation.animationeffect.fill.md) | string | <code>AnimationEffect</code>'s fill mode. |
|
||||
| [iterations](./puppeteer.protocol.animation.animationeffect.iterations.md) | number | <code>AnimationEffect</code>'s iterations. |
|
||||
| [iterationStart](./puppeteer.protocol.animation.animationeffect.iterationstart.md) | number | <code>AnimationEffect</code>'s iteration start. |
|
||||
| [keyframesRule](./puppeteer.protocol.animation.animationeffect.keyframesrule.md) | [KeyframesRule](./puppeteer.protocol.animation.keyframesrule.md) | <code>AnimationEffect</code>'s keyframes. |
|
||||
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [AnimationStartedEvent](./puppeteer.protocol.animation.animationstartedevent.md) > [animation](./puppeteer.protocol.animation.animationstartedevent.animation.md)
|
||||
|
||||
## Protocol.Animation.AnimationStartedEvent.animation property
|
||||
|
||||
Animation that was started.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
animation: Animation;
|
||||
```
|
@ -0,0 +1,20 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [AnimationStartedEvent](./puppeteer.protocol.animation.animationstartedevent.md)
|
||||
|
||||
## Protocol.Animation.AnimationStartedEvent interface
|
||||
|
||||
Event for animation that has been started.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface AnimationStartedEvent
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [animation](./puppeteer.protocol.animation.animationstartedevent.animation.md) | [Animation](./puppeteer.protocol.animation.animation.md) | Animation that was started. |
|
||||
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [GetCurrentTimeRequest](./puppeteer.protocol.animation.getcurrenttimerequest.md) > [id](./puppeteer.protocol.animation.getcurrenttimerequest.id.md)
|
||||
|
||||
## Protocol.Animation.GetCurrentTimeRequest.id property
|
||||
|
||||
Id of animation.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
id: string;
|
||||
```
|
@ -0,0 +1,18 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [GetCurrentTimeRequest](./puppeteer.protocol.animation.getcurrenttimerequest.md)
|
||||
|
||||
## Protocol.Animation.GetCurrentTimeRequest interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface GetCurrentTimeRequest
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [id](./puppeteer.protocol.animation.getcurrenttimerequest.id.md) | string | Id of animation. |
|
||||
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [GetCurrentTimeResponse](./puppeteer.protocol.animation.getcurrenttimeresponse.md) > [currentTime](./puppeteer.protocol.animation.getcurrenttimeresponse.currenttime.md)
|
||||
|
||||
## Protocol.Animation.GetCurrentTimeResponse.currentTime property
|
||||
|
||||
Current time of the page.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
currentTime: number;
|
||||
```
|
@ -0,0 +1,18 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [GetCurrentTimeResponse](./puppeteer.protocol.animation.getcurrenttimeresponse.md)
|
||||
|
||||
## Protocol.Animation.GetCurrentTimeResponse interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface GetCurrentTimeResponse
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [currentTime](./puppeteer.protocol.animation.getcurrenttimeresponse.currenttime.md) | number | Current time of the page. |
|
||||
|
@ -0,0 +1,18 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [GetPlaybackRateResponse](./puppeteer.protocol.animation.getplaybackrateresponse.md)
|
||||
|
||||
## Protocol.Animation.GetPlaybackRateResponse interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface GetPlaybackRateResponse
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [playbackRate](./puppeteer.protocol.animation.getplaybackrateresponse.playbackrate.md) | number | Playback rate for animations on page. |
|
||||
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [GetPlaybackRateResponse](./puppeteer.protocol.animation.getplaybackrateresponse.md) > [playbackRate](./puppeteer.protocol.animation.getplaybackrateresponse.playbackrate.md)
|
||||
|
||||
## Protocol.Animation.GetPlaybackRateResponse.playbackRate property
|
||||
|
||||
Playback rate for animations on page.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
playbackRate: number;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [KeyframesRule](./puppeteer.protocol.animation.keyframesrule.md) > [keyframes](./puppeteer.protocol.animation.keyframesrule.keyframes.md)
|
||||
|
||||
## Protocol.Animation.KeyframesRule.keyframes property
|
||||
|
||||
List of animation keyframes.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
keyframes: KeyframeStyle[];
|
||||
```
|
21
new-docs/puppeteer.protocol.animation.keyframesrule.md
Normal file
21
new-docs/puppeteer.protocol.animation.keyframesrule.md
Normal file
@ -0,0 +1,21 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [KeyframesRule](./puppeteer.protocol.animation.keyframesrule.md)
|
||||
|
||||
## Protocol.Animation.KeyframesRule interface
|
||||
|
||||
Keyframes Rule
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface KeyframesRule
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [keyframes](./puppeteer.protocol.animation.keyframesrule.keyframes.md) | [KeyframeStyle](./puppeteer.protocol.animation.keyframestyle.md)<!-- -->\[\] | List of animation keyframes. |
|
||||
| [name](./puppeteer.protocol.animation.keyframesrule.name.md) | string | CSS keyframed animation's name. |
|
||||
|
13
new-docs/puppeteer.protocol.animation.keyframesrule.name.md
Normal file
13
new-docs/puppeteer.protocol.animation.keyframesrule.name.md
Normal file
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [KeyframesRule](./puppeteer.protocol.animation.keyframesrule.md) > [name](./puppeteer.protocol.animation.keyframesrule.name.md)
|
||||
|
||||
## Protocol.Animation.KeyframesRule.name property
|
||||
|
||||
CSS keyframed animation's name.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
name?: string;
|
||||
```
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [KeyframeStyle](./puppeteer.protocol.animation.keyframestyle.md) > [easing](./puppeteer.protocol.animation.keyframestyle.easing.md)
|
||||
|
||||
## Protocol.Animation.KeyframeStyle.easing property
|
||||
|
||||
`AnimationEffect`<!-- -->'s timing function.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
easing: string;
|
||||
```
|
21
new-docs/puppeteer.protocol.animation.keyframestyle.md
Normal file
21
new-docs/puppeteer.protocol.animation.keyframestyle.md
Normal file
@ -0,0 +1,21 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [KeyframeStyle](./puppeteer.protocol.animation.keyframestyle.md)
|
||||
|
||||
## Protocol.Animation.KeyframeStyle interface
|
||||
|
||||
Keyframe Style
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface KeyframeStyle
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [easing](./puppeteer.protocol.animation.keyframestyle.easing.md) | string | <code>AnimationEffect</code>'s timing function. |
|
||||
| [offset](./puppeteer.protocol.animation.keyframestyle.offset.md) | string | Keyframe's time offset. |
|
||||
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [KeyframeStyle](./puppeteer.protocol.animation.keyframestyle.md) > [offset](./puppeteer.protocol.animation.keyframestyle.offset.md)
|
||||
|
||||
## Protocol.Animation.KeyframeStyle.offset property
|
||||
|
||||
Keyframe's time offset.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
offset: string;
|
||||
```
|
34
new-docs/puppeteer.protocol.animation.md
Normal file
34
new-docs/puppeteer.protocol.animation.md
Normal file
@ -0,0 +1,34 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md)
|
||||
|
||||
## Protocol.Animation namespace
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export namespace Animation
|
||||
```
|
||||
|
||||
## Interfaces
|
||||
|
||||
| Interface | Description |
|
||||
| --- | --- |
|
||||
| [Animation](./puppeteer.protocol.animation.animation.md) | Animation instance. |
|
||||
| [AnimationCanceledEvent](./puppeteer.protocol.animation.animationcanceledevent.md) | Event for when an animation has been cancelled. |
|
||||
| [AnimationCreatedEvent](./puppeteer.protocol.animation.animationcreatedevent.md) | Event for each animation that has been created. |
|
||||
| [AnimationEffect](./puppeteer.protocol.animation.animationeffect.md) | AnimationEffect instance |
|
||||
| [AnimationStartedEvent](./puppeteer.protocol.animation.animationstartedevent.md) | Event for animation that has been started. |
|
||||
| [GetCurrentTimeRequest](./puppeteer.protocol.animation.getcurrenttimerequest.md) | |
|
||||
| [GetCurrentTimeResponse](./puppeteer.protocol.animation.getcurrenttimeresponse.md) | |
|
||||
| [GetPlaybackRateResponse](./puppeteer.protocol.animation.getplaybackrateresponse.md) | |
|
||||
| [KeyframesRule](./puppeteer.protocol.animation.keyframesrule.md) | Keyframes Rule |
|
||||
| [KeyframeStyle](./puppeteer.protocol.animation.keyframestyle.md) | Keyframe Style |
|
||||
| [ReleaseAnimationsRequest](./puppeteer.protocol.animation.releaseanimationsrequest.md) | |
|
||||
| [ResolveAnimationRequest](./puppeteer.protocol.animation.resolveanimationrequest.md) | |
|
||||
| [ResolveAnimationResponse](./puppeteer.protocol.animation.resolveanimationresponse.md) | |
|
||||
| [SeekAnimationsRequest](./puppeteer.protocol.animation.seekanimationsrequest.md) | |
|
||||
| [SetPausedRequest](./puppeteer.protocol.animation.setpausedrequest.md) | |
|
||||
| [SetPlaybackRateRequest](./puppeteer.protocol.animation.setplaybackraterequest.md) | |
|
||||
| [SetTimingRequest](./puppeteer.protocol.animation.settimingrequest.md) | |
|
||||
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [ReleaseAnimationsRequest](./puppeteer.protocol.animation.releaseanimationsrequest.md) > [animations](./puppeteer.protocol.animation.releaseanimationsrequest.animations.md)
|
||||
|
||||
## Protocol.Animation.ReleaseAnimationsRequest.animations property
|
||||
|
||||
List of animation ids to seek.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
animations: string[];
|
||||
```
|
@ -0,0 +1,18 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [ReleaseAnimationsRequest](./puppeteer.protocol.animation.releaseanimationsrequest.md)
|
||||
|
||||
## Protocol.Animation.ReleaseAnimationsRequest interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface ReleaseAnimationsRequest
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [animations](./puppeteer.protocol.animation.releaseanimationsrequest.animations.md) | string\[\] | List of animation ids to seek. |
|
||||
|
@ -0,0 +1,13 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [ResolveAnimationRequest](./puppeteer.protocol.animation.resolveanimationrequest.md) > [animationId](./puppeteer.protocol.animation.resolveanimationrequest.animationid.md)
|
||||
|
||||
## Protocol.Animation.ResolveAnimationRequest.animationId property
|
||||
|
||||
Animation id.
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
animationId: string;
|
||||
```
|
@ -0,0 +1,18 @@
|
||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||||
|
||||
[Home](./index.md) > [puppeteer](./puppeteer.md) > [Protocol](./puppeteer.protocol.md) > [Animation](./puppeteer.protocol.animation.md) > [ResolveAnimationRequest](./puppeteer.protocol.animation.resolveanimationrequest.md)
|
||||
|
||||
## Protocol.Animation.ResolveAnimationRequest interface
|
||||
|
||||
<b>Signature:</b>
|
||||
|
||||
```typescript
|
||||
export interface ResolveAnimationRequest
|
||||
```
|
||||
|
||||
## Properties
|
||||
|
||||
| Property | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| [animationId](./puppeteer.protocol.animation.resolveanimationrequest.animationid.md) | string | Animation id. |
|
||||
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue
Block a user