1.
2.
3.
Options ratioDim obj The pixel dimensions to apply as a restrictive ratio, with properties x & y. minWidth int The minimum width for the select area in pixels. minHeight int The mimimum height for the select area in pixels. maxWidth int The maximum width for the select areas in pixels (if both minWidth & maxWidth set to same the width of the cropper will be fixed) maxHeight int The maximum height for the select areas in pixels (if both minHeight & maxHeight set to same the height of the cropper will be fixed) displayOnInit int Whether to display the select area on initialisation, only used when providing minimum width & height or ratio. onEndCrop func The callback function to provide the crop details to on end of a crop. captureKeys boolean Whether to capture the keys for moving the select area, as these can cause some problems at the moment. onloadCoords obj A coordinates object with properties x1, y1, x2 & y2; for the coordinates of the select area to display onload The callback function The callback function is a function that allows you to capture the crop co-ordinates when the user finished a crop movement, it is passed two arguments: * coords, obj, coordinates object with properties x1, y1, x2 & y2; for the coordinates of the select area. * dimensions, obj, dimensions object with properities width & height; for the dimensions of the select area. An example function which outputs the crop values to form fields: Display code as plain text JavaScript: 1. function onEndCrop( coords, dimensions ) { 2. $( 'x1' ).value = coords.x1; 3. $( 'y1' ).value = coords.y1; 4. $( 'x2' ).value = coords.x2; 5. $( 'y2' ).value = coords.y2; 6. $( 'width' ).value = dimensions.width; 7. $( 'height' ).value = dimensions.height; 8. } Basic interface This basic example will attach the cropper UI to the test image and return crop results to the provided callback function. Display code as plain text HTML: 1. 2. 3.
Minimum dimensions You can apply minimum dimensions to a single axis or both, this example applies minimum dimensions to both axis. Display code as plain text HTML: 1. 2. 3.
Select area ratio You can apply a ratio to the selection area, this example applies a 4:3 ratio to the select area. Display code as plain text HTML: 1. 2. 3.
With crop preview You can display a dynamically prouced preview of the resulting crop by using the ImgWithPreview subclass, a preview can only be displayed when we have a fixed size (set via minWidth & minHeight options). Note that the displayOnInit option is not required as this is the default behaviour when displaying a crop preview. Display code as plain text HTML: 1. 2.
3. 4.
Known Issues * Safari animated gifs, only one of each will animate, this seems to be a known Safari issue. * After drawing an area and then clicking to start a new drag in IE 5.5 the rendered height appears as the last height until the user drags, this appears to be the related to another IE error (which has been fixed) where IE does not always redraw the select area properly. * Lack of CSS opacity support in Opera before version 9 mean we disable those style rules, if Opera 8 support is important you & you want the overlay to work then you can use the Opera rules in the CSS to apply a black PNG with 50% alpha transparency to replicate the effect. * Styling & borders on image, any CSS styling applied directly to the image itself (floats, borders, padding, margin, etc.) will cause problems with the cropper. The use of a wrapper element to apply these styles to is recommended. * overflow: auto or overflow: scroll on parent will cause cropper to burst out of parent in IE and Opera when applied (maybe Mac browsers too) I'm not sure why yet. If you use CakePHP you will notice that including this in your script will break the CSS layout. This is due to the CSS rule form div{ vertical-align: text-top; margin-left: 1em; margin-bottom:2em; overflow: auto; } A simple workaround is to add another rule directly after this like so: form div.no_cake, form div.no_cake div { margin:0; overflow:hidden; } and then in your code surround the img tag with a div with the class name of no_cake. Cheers