Skip to content
This repository was archived by the owner on Apr 15, 2025. It is now read-only.

Commit 8263b4c

Browse files
committed
Add options meta:true and orientation:true to the documentation.
1 parent 590065b commit 8263b4c

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

README.md

+11-8
Original file line numberDiff line numberDiff line change
@@ -194,11 +194,15 @@ Requires `canvas: true`.
194194
* **crop**: Crops the image to the maxWidth/maxHeight constraints if set to
195195
`true`.
196196
Enabling the `crop` option also enables the `canvas` option.
197-
* **orientation**: Transform the canvas according to the
198-
specified Exif orientation (number in range 1 to 8). See
199-
[loadImage.parseMetaData](https://github.com/blueimp/JavaScript-Load-Image#meta-data-parsing)
200-
for parsing EXIF data. Setting the `orientation` also enables the `canvas`
201-
option.
197+
* **orientation**: Transform the canvas according to the specified Exif
198+
orientation, which can be an `integer` in the range of `1` to `8` or the boolean
199+
value `true`.
200+
When set to `true`, it will set the orientation value based on the EXIF data of
201+
the image, which will be parsed automatically if the exif library is available.
202+
Setting the `orientation` also enables the `canvas` option.
203+
Setting `orientation` to `true` alsoe enables the `meta` option.
204+
* **meta**: Automatically parses the image meta data if set to `true`.
205+
The meta data is passed to the callback as second argument.
202206
* **canvas**: Returns the image as
203207
[canvas](https://developer.mozilla.org/en/HTML/Canvas) element if set to `true`.
204208
* **crossOrigin**: Sets the crossOrigin property on the img element for loading
@@ -268,8 +272,8 @@ Blob objects of resized images can be created via
268272
[canvas.toBlob()](https://github.com/blueimp/JavaScript-Canvas-to-Blob).
269273

270274
### Exif parser
271-
If you include the Load Image Exif Parser extension, the argument passed to the
272-
callback for **parseMetaData** will contain the additional property **exif** if
275+
If you include the Load Image Exif Parser extension, the argument passed to the
276+
callback for **parseMetaData** will contain the additional property **exif** if
273277
Exif data could be found in the given image.
274278
The **exif** object stores the parsed Exif tags:
275279

@@ -315,4 +319,3 @@ The JavaScript Load Image script is released under the
315319
Achim Stöhr.
316320
* Exif tags mapping based on Jacob Seidelin's
317321
[exif-js](https://github.com/jseidelin/exif-js).
318-

0 commit comments

Comments
 (0)