html2canvas 配置参数中文文档

html2canvas 配置参数中文文档

当使用 html2canvas 库进行截图、绘制或渲染 HTML 元素时,您可以使用上述 API 参数来自定义其行为。下面是对每个参数的解释:

Canvas 设置

  • canvas:您可以指定一个现有的 canvas 元素作为绘制的目标。
  • backgroundColor:canvas 的背景颜色,如果在 DOM 中未指定背景颜色,则可以设置为 null(透明)。
  • allowTaint:是否允许跨域的图片污染 canvas。

渲染设置

  • foreignObjectRendering:是否在支持的情况下使用 ForeignObject 渲染。
  • useCORS:是否尝试使用 CORS 加载图片。
  • proxy:用于加载跨域图片的代理 URL。如果为空,则不加载跨域图片。
  • imageTimeout:加载图片的超时时间(毫秒)。设置为 0 表示禁用超时。
  • logging:是否启用调试日志输出。

页面设置

  • width:元素的宽度。
  • height:元素的高度。
  • x:截取的画布 x 偏移量。
  • y:截取的画布 y 偏移量。
  • scrollX:渲染元素时的 x 滚动位置(例如,如果元素使用了 position: fixed)。
  • scrollY:渲染元素时的 y 滚动位置(例如,如果元素使用了 position: fixed)。
  • windowWidth:渲染元素时使用的窗口宽度,可能会影响媒体查询等事项。
  • windowHeight:渲染元素时使用的窗口高度,可能会影响媒体查询等事项。

其他设置

  • ignoreElements:一个函数,用于从渲染中移除匹配的元素。
  • onclone:在文档被克隆用于渲染时调用的回调函数。
  • removeContainer:是否清除 html2canvas 临时创建的克隆 DOM 元素。
  • scale:渲染的比例,默认为浏览器的设备像素比。

yyds版:https://allenchinese.github.io/html2canvas-docs-zh-cn/