puppeteer/new-docs/puppeteer.protocol.overlay.highlightconfig.md

35 lines
3.3 KiB
Markdown
Raw Normal View History

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Protocol](./puppeteer.protocol.md) &gt; [Overlay](./puppeteer.protocol.overlay.md) &gt; [HighlightConfig](./puppeteer.protocol.overlay.highlightconfig.md)
## Protocol.Overlay.HighlightConfig interface
Configuration data for the highlighting of page elements.
<b>Signature:</b>
```typescript
export interface HighlightConfig
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [borderColor](./puppeteer.protocol.overlay.highlightconfig.bordercolor.md) | [DOM.RGBA](./puppeteer.protocol.dom.rgba.md) | The border highlight fill color (default: transparent). |
| [colorFormat](./puppeteer.protocol.overlay.highlightconfig.colorformat.md) | [ColorFormat](./puppeteer.protocol.overlay.colorformat.md) | The color format used to format color styles (default: hex). |
| [contentColor](./puppeteer.protocol.overlay.highlightconfig.contentcolor.md) | [DOM.RGBA](./puppeteer.protocol.dom.rgba.md) | The content box highlight fill color (default: transparent). |
| [cssGridColor](./puppeteer.protocol.overlay.highlightconfig.cssgridcolor.md) | [DOM.RGBA](./puppeteer.protocol.dom.rgba.md) | The grid layout color (default: transparent). |
| [eventTargetColor](./puppeteer.protocol.overlay.highlightconfig.eventtargetcolor.md) | [DOM.RGBA](./puppeteer.protocol.dom.rgba.md) | The event target element highlight fill color (default: transparent). |
| [gridHighlightConfig](./puppeteer.protocol.overlay.highlightconfig.gridhighlightconfig.md) | [GridHighlightConfig](./puppeteer.protocol.overlay.gridhighlightconfig.md) | The grid layout highlight configuration (default: all transparent). |
| [marginColor](./puppeteer.protocol.overlay.highlightconfig.margincolor.md) | [DOM.RGBA](./puppeteer.protocol.dom.rgba.md) | The margin highlight fill color (default: transparent). |
| [paddingColor](./puppeteer.protocol.overlay.highlightconfig.paddingcolor.md) | [DOM.RGBA](./puppeteer.protocol.dom.rgba.md) | The padding highlight fill color (default: transparent). |
| [shapeColor](./puppeteer.protocol.overlay.highlightconfig.shapecolor.md) | [DOM.RGBA](./puppeteer.protocol.dom.rgba.md) | The shape outside fill color (default: transparent). |
| [shapeMarginColor](./puppeteer.protocol.overlay.highlightconfig.shapemargincolor.md) | [DOM.RGBA](./puppeteer.protocol.dom.rgba.md) | The shape margin fill color (default: transparent). |
| [showAccessibilityInfo](./puppeteer.protocol.overlay.highlightconfig.showaccessibilityinfo.md) | boolean | Whether the a11y info should be shown (default: true). |
| [showExtensionLines](./puppeteer.protocol.overlay.highlightconfig.showextensionlines.md) | boolean | Whether the extension lines from node to the rulers should be shown (default: false). |
| [showInfo](./puppeteer.protocol.overlay.highlightconfig.showinfo.md) | boolean | Whether the node info tooltip should be shown (default: false). |
| [showRulers](./puppeteer.protocol.overlay.highlightconfig.showrulers.md) | boolean | Whether the rulers should be shown (default: false). |
| [showStyles](./puppeteer.protocol.overlay.highlightconfig.showstyles.md) | boolean | Whether the node styles in the tooltip (default: false). |