36 lines
2.5 KiB
Markdown
36 lines
2.5 KiB
Markdown
---
|
|
title: "Options"
|
|
description: "Explore the different configuration options available for html2canvas"
|
|
previousUrl: "/getting-started"
|
|
previousTitle: "Getting Started"
|
|
nextUrl: "/features"
|
|
nextTitle: "Features"
|
|
---
|
|
|
|
These are all of the available configuration options.
|
|
|
|
| Name | Default | Description |
|
|
| ------------- | :------: | ----------- |
|
|
| allowTaint | `false` | Whether to allow cross-origin images to taint the canvas
|
|
| backgroundColor | `#ffffff` | Canvas background color, if none is specified in DOM. Set `null` for transparent
|
|
| canvas | `null` | Existing `canvas` element to use as a base for drawing on
|
|
| foreignObjectRendering | `false` | Whether to use ForeignObject rendering if the browser supports it
|
|
| imageTimeout | `15000` | Timeout for loading an image (in milliseconds). Set to `0` to disable timeout.
|
|
| ignoreElements | `(element) => false` | Predicate function which removes the matching elements from the render.
|
|
| logging | `true` | Enable logging for debug purposes
|
|
| onclone | `null` | Callback function which is called when the Document has been cloned for rendering, can be used to modify the contents that will be rendered without affecting the original source document.
|
|
| proxy | `null` | Url to the [proxy](/proxy/) which is to be used for loading cross-origin images. If left empty, cross-origin images won't be loaded.
|
|
| removeContainer | `true` | Whether to cleanup the cloned DOM elements html2canvas creates temporarily
|
|
| scale | `window.devicePixelRatio` | The scale to use for rendering. Defaults to the browsers device pixel ratio.
|
|
| useCORS | `false` | Whether to attempt to load images from a server using CORS
|
|
| width | `Element` width | The width of the `canvas`
|
|
| height | `Element` height | The height of the `canvas`
|
|
| x | `Element` x-offset | Crop canvas x-coordinate
|
|
| y | `Element` y-offset| Crop canvas y-coordinate
|
|
| scrollX | `Element` scrollX | The x-scroll position to used when rendering element, (for example if the Element uses `position: fixed`)
|
|
| scrollY | `Element` scrollY | The y-scroll position to used when rendering element, (for example if the Element uses `position: fixed`)
|
|
| windowWidth | `Window.innerWidth` | Window width to use when rendering `Element`, which may affect things like Media queries
|
|
| windowHeight | `Window.innerHeight` | Window height to use when rendering `Element`, which may affect things like Media queries
|
|
|
|
If you wish to exclude certain `Element`s from getting rendered, you can add a `data-html2canvas-ignore` attribute to those elements and html2canvas will exclude them from the rendering.
|