Updated documentation and removed returnsOriginalImage parameter, setting that always to true for now

This commit is contained in:
CSullivan102
2014-01-10 19:59:23 -05:00
parent a30d6ea81f
commit df4c2247bc
3 changed files with 46 additions and 5 deletions
+45 -1
View File
@@ -1,9 +1,53 @@
cordova-imagePicker cordova-imagePicker
=================== ===================
Cordova Plugin For Multiple Image Selection Cordova Plugin For Multiple Image Selection - currently implemented only for
iOS, Android coming soon.
## Installing the plugin
The plugin conforms to the Cordova plugin specification, it can be installed
using the Cordova / Phonegap command line interface.
```
phonegap plugin add https://github.com/CSullivan102/cordova-imagePicker.git
cordova plugin add https://github.com/CSullivan102/cordova-imagePicker.git
```
## Using the plugin
The plugin creates the object `window.imagePicker` with the method `getPictures(success, fail, options)`
Example:
```javascript
window.imagePicker.getPictures(
function(results) {
for (var i = 0; i < results.length; i++) {
console.log('Image URI: ' + results[i]);
}
}, function (error) {
console.log('Error: ' + error);
}, options
);
```
### Options
```javascript
options = {
maximumImagesCount: int,
// max images to be selected, defaults to 15. If this is set to 1, upon
// selection of a single image, the plugin will return it.
width: int,
// width to resize image to (if one of height/width is 0, will resize
// to fit the other while keeping aspect ratio)
height: int,
// height to resize image to
quality: int (0-100)
// quality of resized image, defaults to 100
};
```
This plugin uses the ELCImagePickerController for the iOS image picker. This plugin uses the ELCImagePickerController for the iOS image picker.
+1 -2
View File
@@ -21,7 +21,6 @@
- (void) getPictures:(CDVInvokedUrlCommand *)command { - (void) getPictures:(CDVInvokedUrlCommand *)command {
NSDictionary *options = [command.arguments objectAtIndex: 0]; NSDictionary *options = [command.arguments objectAtIndex: 0];
bool returnsOriginalImage = [[options objectForKey:@"returnsOriginalImage"] boolValue];
NSInteger maximumImagesCount = [[options objectForKey:@"maximumImagesCount"] integerValue]; NSInteger maximumImagesCount = [[options objectForKey:@"maximumImagesCount"] integerValue];
self.width = [[options objectForKey:@"width"] integerValue]; self.width = [[options objectForKey:@"width"] integerValue];
self.height = [[options objectForKey:@"height"] integerValue]; self.height = [[options objectForKey:@"height"] integerValue];
@@ -40,7 +39,7 @@
ELCImagePickerController *imagePicker = [[ELCImagePickerController alloc] initWithRootViewController:albumController]; ELCImagePickerController *imagePicker = [[ELCImagePickerController alloc] initWithRootViewController:albumController];
imagePicker.maximumImagesCount = maximumImagesCount; imagePicker.maximumImagesCount = maximumImagesCount;
imagePicker.returnsOriginalImage = returnsOriginalImage; imagePicker.returnsOriginalImage = 1;
imagePicker.imagePickerDelegate = self; imagePicker.imagePickerDelegate = self;
albumController.parent = imagePicker; albumController.parent = imagePicker;
-2
View File
@@ -13,7 +13,6 @@ var ImagePicker = function() {
* success - success callback * success - success callback
* fail - error callback * fail - error callback
* options * options
* .singleSelection
* .maximumImagesCount * .maximumImagesCount
* .maxWidth * .maxWidth
* .maxHeight * .maxHeight
@@ -25,7 +24,6 @@ ImagePicker.prototype.getPictures = function(success, fail, options) {
var params = { var params = {
maximumImagesCount: options.maximumImagesCount ? options.maximumImagesCount : 15, maximumImagesCount: options.maximumImagesCount ? options.maximumImagesCount : 15,
returnsOriginalImage: options.returnsOriginalImage ? options.returnsOriginalImage : 1,
width: options.width ? options.width : 0, width: options.width ? options.width : 0,
height: options.height ? options.height : 0, height: options.height ? options.height : 0,
quality: options.quality ? options.quality : 100 quality: options.quality ? options.quality : 100