Added support for "data-html2canvas-ignore" attribute

This commit is contained in:
Niklas von Hertzen 2012-11-25 22:25:08 +02:00
parent 084bf4b039
commit 7c0b893564
3 changed files with 14 additions and 12 deletions

2
.gitignore vendored
View File

@ -9,5 +9,7 @@
image.jpg image.jpg
/.project /.project
/.settings/ /.settings/
node_modules/
.envrc .envrc
tests/selenium.js
*.sublime-workspace *.sublime-workspace

View File

@ -2,33 +2,33 @@ html2canvas
=========== ===========
#### JavaScript HTML renderer #### #### JavaScript HTML renderer ####
This script allows you to take "screenshots" of webpages or parts of it, directly on the users browser. The screenshot is based on the DOM and as such may not be 100% accurate to the real representation as it does not make an actual screenshot, but builds the screenshot based on the information available on the page. This script allows you to take "screenshots" of webpages or parts of it, directly on the users browser. The screenshot is based on the DOM and as such may not be 100% accurate to the real representation as it does not make an actual screenshot, but builds the screenshot based on the information available on the page.
###How does it work?### ###How does it work?###
The script renders the current page as a canvas image, by reading the DOM and the different styles applied to the elements. However, as many elements are displayed differently on different browsers and operating systems (such as form elements such as radio buttons or checkboxes) as well as The script renders the current page as a canvas image, by reading the DOM and the different styles applied to the elements. However, as many elements are displayed differently on different browsers and operating systems (such as form elements such as radio buttons or checkboxes) as well as
It does <b>not require any rendering from the server</b>, as the whole image is created on the <b>clients browser</b>. However, for browsers without <code>canvas</code> support alternatives such as <a href="http://flashcanvas.net/">flashcanvas</a> or <a href="http://excanvas.sourceforge.net/">ExplorerCanvas</a> are necessary to create the image. It does <b>not require any rendering from the server</b>, as the whole image is created on the <b>clients browser</b>. However, for browsers without <code>canvas</code> support alternatives such as <a href="http://flashcanvas.net/">flashcanvas</a> or <a href="http://excanvas.sourceforge.net/">ExplorerCanvas</a> are necessary to create the image.
Additionally, to render <code>iframe</code> content or images situated outside of the <a href="http://en.wikipedia.org/wiki/Same_origin_policy">same origin policy</a> a proxy will be necessary to load the content to the users browser. Additionally, to render <code>iframe</code> content or images situated outside of the <a href="http://en.wikipedia.org/wiki/Same_origin_policy">same origin policy</a> a proxy will be necessary to load the content to the users browser.
The script is still in a very experimental state, so I don't recommend using it in a production environment nor start building applications with it yet, as there will be still major changes made. However, please do test it out and report your findings, especially if something should be working, but is displaying it incorrectly. The script is still in a very experimental state, so I don't recommend using it in a production environment nor start building applications with it yet, as there will be still major changes made. However, please do test it out and report your findings, especially if something should be working, but is displaying it incorrectly.
###Browser compatibility### ###Browser compatibility###
The script should work fine on the following browsers: The script should work fine on the following browsers:
* Firefox 3.5+ * Firefox 3.5+
* Google Chrome * Google Chrome
* Newer versions of Opera (exactly how new is yet to be determined) * Newer versions of Opera (exactly how new is yet to be determined)
* >=IE9 (Older versions compatible with the use of flashcanvas) * >=IE9 (Older versions compatible with the use of flashcanvas)
Note that the compatibility will most likely be increased in future builds, as many of the current restrictions have at least partial work arounds, which can be used with older browser versions. Note that the compatibility will most likely be increased in future builds, as many of the current restrictions have at least partial work arounds, which can be used with older browser versions.
###So what isn't included yet?### ###So what isn't included yet?###
There are still a lot of CSS properties missing, including most CSS3 properties such as <code>text-shadow</code>, <code>box-radius</code> etc. as well as all elements created by the browser, such as radio and checkbox buttons and list icons. I will compile a full list of supported elements and CSS properties soon. There are still a lot of CSS properties missing, including most CSS3 properties such as <code>text-shadow</code>, <code>box-radius</code> etc. as well as all elements created by the browser, such as radio and checkbox buttons and list icons. I will compile a full list of supported elements and CSS properties soon.
There is no support for <code>frame</code> and <code>object</code> content such as Flash. There is no support for <code>frame</code> and <code>object</code> content such as Flash.
### Usage ### ### Usage ###
@ -39,13 +39,13 @@ To access the created canvas, provide the `onrendered` event in the options whic
html2canvas( [ document.body ], { html2canvas( [ document.body ], {
onrendered: function( canvas ) { onrendered: function( canvas ) {
/* canvas is the actual canvas element, /* canvas is the actual canvas element,
to append it to the page call for example to append it to the page call for example
document.body.appendChild( canvas ); document.body.appendChild( canvas );
*/ */
} }
}); });
### Examples ### ### Examples ###

View File

@ -1271,7 +1271,7 @@ _html2canvas.Parse = function ( images, options ) {
function parseElement (el, stack) { function parseElement (el, stack) {
// skip hidden elements and their children // skip hidden elements and their children
if (getCSS(el, 'display') !== "none" && getCSS(el, 'visibility') !== "hidden") { if (getCSS(el, 'display') !== "none" && getCSS(el, 'visibility') !== "hidden" && !el.hasAttribute("data-html2canvas-ignore")) {
stack = renderElement(el, stack) || stack; stack = renderElement(el, stack) || stack;