Explore the different configuration options available for html2canvas
探索可用于 html2canvas 的不同配置选项
参数配置
These are all of the available configuration options.
以下是所有可用的参数配置:
名称 | 默认值 | 说明 |
---|---|---|
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的背景色,如果在dom中没有指定,设置null表示透明。 |
canvas 画布 |
null | Existing canvas element to use as a base for drawing on 现有的画布元素用作绘图的基础 |
foreignObjectRendering ForeignObject渲染 |
false | Whether to use ForeignObject rendering if the browser supports it 如果浏览器支持,是否使用 ForeignObject 渲染 |
imageTimeout 图像超时时间 |
15000 | Timeout for loading an image (in milliseconds). Set to 0 to disable timeout. 设置加载图像的超时时间(毫秒值),设置0表示禁用超时。 |
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 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 是否清除html2canvas为了渲染而临时创建的DOM克隆元素 |
scale 比例 |
window.devicePixelRatio | The scale to use for rendering. Defaults to the browsers device pixel ratio. 用于渲染的比例,默认为浏览器的设备像素比。 |
useCORS 使用CORS |
false | Whether to attempt to load images from a server using CORS 是否尝试使用CORS从服务器加载图像。 |
width 宽度 |
Element width | The width of the canvas canvas画布的宽度 |
height 高度 |
Element height | The height of the canvas canvas画布的高度 |
x | Element x-offset | Crop canvas x-coordinate 裁剪画布时,起点的 x 坐标 |
y | Element y-offset | Crop canvas y-coordinate 裁剪画布时,起点的 y 坐标 |
scrollX 滚动x |
Element scrollX | The x-scroll position to used when rendering element, (for example if the Element uses position: fixed) 渲染元素时使用的 x 滚动位置,(例如,如果元素使用position: fixed) |
scrollY 滚动y |
Element scrollY | The y-scroll position to used when rendering element, (for example if the Element uses position: fixed) 渲染元素时使用的 y 滚动位置,(例如,如果元素使用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 Elements from getting rendered, you can add a data-html2canvas-ignore attribute to those elements and html2canvas will exclude them from the rendering.
如果你想在开始绘制时排除确切的元素,你可以给这些元素设置data-html2canvas-ignore属性,html2canvas渲染时就会自动排出这些元素。