imageEditor Class HTML5/Flash Uploader JavaScript

Supported technologies:

This class represents the image editor.

For a list of all members of this class, see imageEditor Members.

Syntax

JavaScript 
$au.imageEditor = function() {
}

Remarks

Aurigma HTML5 uploader has a built-in image editor. A user may open any photo/image added to the upload list in this editor and modify it. The editor includes two tools - cropping tool and draw tool. Depending on your needs, you can toggle each tool and configure them.

The cropping tool is toggled using the enableCrop property. Once you enable it, you may configure the crop frame aspect ratio using the cropRatio property. It may be a string like "4:3" or "2/3". Empty string means that there is no aspect ratio restrictions (free crop mode). A "orig" value will preserve the original aspect ratio. If you prepend ;fixed to this string, the uploader won't allow the user to change the crop rectangle orientation. If you don't want the resulting image to be smaller than a specific size, you should use cropMinSize.

The draw tool can be turned on and off using the enableDrawTool. It includes the freehand pen and eraser. The user may select the pen color and width (appropriate controls may be hidden through the settings though). These features are controlled using the drawTool properties.

Remember, that although the user sees the changes made to the image on the preview, under certain circumstances the changes are not applied to the uploaded image. For example, it may happen if you set your converter to the SourceFile mode or set thumbnailApplyCrop and/or thumbnailApplyDrawTool to false. Sometimes it may be useful to upload both modified and unmodified images, but to avoid confusion, pay attention to your converter settings.

See Also

Reference

Manual