You are viewing Jcrop 2.x documentation — click here for legacy v0.9.x

Jcrop Documentation

Here we present to you, the most recent Jcrop documentation, the Jcrop Manual. This resource is a work-in-progress, but we hope it helps you get the most out of Jcrop!

Documentation Conventions

Throughout this documentation, you will see various code or variable references. To avoid excessive explanations, the table below describes the various references and their meaning.
ReferenceMeaning
aspectRatioUsually indicates an option setting
aspectRatio: 1.2Indicates an option setting and value
refresh()Indicates an object method, usually on Jcrop instance
$.Jcrop.componentA static property on jQuery.Jcrop object
Jcrop.filterA property on a Jcrop instance
Selection.activeA property on a Selection object

It's especially important to recognize the difference between mentions of Jcrop and $.Jcrop:
The former is an active instance, where the latter is the constructor.

Callouts

Several kinds of callouts are used to draw attention to important details or information.

CalloutMeaning
Clarification
This may help clarify prior information
More Information
Where to go for additional, related information
Troubleshooting
This information may help you solve a problem
Common Pitfall
Avoid fatal problems