Q imagepicker Class

Parameters:

• [options] Object optional

  options is an Object that contains parameters for function

  • saveSizeName Object

    Required hash where key is the preferred image size and value is the image name. Several key-value pairs may be given and image will be generated and saved in different files. Key may be just one number, e.g. '100' which means square image 100x100 or in format 'x', e.g. '80x120' to make non-square image. You can have one of or be empty, and then it will automatically keep the proportions. Or you can pass 'x' and then it will keep the original width and height of the image.

  • [url] String optional

    url is a url to post to.

  • [path="uploads"] String optional

    Can be a URL path or a function returning a URL path. It must exist on the server.

  • [subpath=""] String | Function optional

    A subpath which may be created on the server if it doesn't already exist. If this is a function, it is executed right before the request is sent.

  • [showSize=null] String optional

    showSize is a key in saveSizeName to show on success.

  • [useAnySize=false] String optional

    whether to tell the server to accept any size without complaining.

  • [crop] Object optional

    crop If provided, the image will be cropped according to the given parameters before it is saved on the server in the saveSizeName formats. If the browser supports it, the cropping will occur in the browser.

    • [x] Number optional
      left for cropping
    • [y] Number optional
      top for cropping
    • [w] Number optional
      width for cropping
    • [h] Number optional
      height value for cropping
  • [cropping=true] Boolean optional

    Whether to display an interface for selecting cropping images, before sending them to the server. If true, the cropping area overrides the crop option.

  • [preprocess] Q.Event optional

    preprocess is a function which is triggering before image upload. Its "this" object will be a jQuery of the imagepicker element The first parameter is a callback, which should be called with an optional hash of overrides, which can include "data", "path", "subpath", "save", "url", "loader" and "crop"

  • [cameraCommands] Array optional

    cameraCommands the commands that pop up to take a photo

    • [photo] Array optional
    • [library] Array optional
    • [cancel] Array optional
  • [onClick] Q.Event optional

    onClick is an event to execute during the click, which may cancel the click

  • [onSuccess] Q.Event optional

    onSuccess is Q.Event which is called on successful upload. First parameter will be the server response with an object in a format similar to the 'saveSizeName' field.

  • [onError] Q.Event optional

    onError Q.Event which is called if upload failed.

  • [onTooSmall] Q.Event optional

    onError Q.Event which is called if an image is selected that's too small for one of the sizes in saveSizeName. Return false to abort.

  • [onFinish] Q.Event optional

    onError Q.Event which is called at the end, whatever the outcome.

  • [onCropping] Q.Event optional

    Happens when the cropping dialog appears, in case you want to display hints or something.