Skip to content

Commit 9206887

Browse files
author
Nate Roling
committed
Add note about providing a value to the orientation option.
1 parent 3ddac4f commit 9206887

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,8 @@ This emulates the CSS feature [background-image: cover](https://developer.mozill
157157
This feature assumes *crop: true*.
158158
* **crop**: Crops the image to the maxWidth/maxHeight constraints if set to *true*.
159159
This feature assumes *canvas: true*.
160-
* **orientation**: Allows to transform the canvas coordinates according to the EXIF orientation specification.
160+
* **orientation**: Transform the canvas coordinates according to the EXIF orientation specification.
161+
Note that you must provide an orientation value (1-8), as setting this option to *true* will not work. See [Exif parser](#exif-parser).
161162
This feature assumes *canvas: true*.
162163
* **canvas**: Returns the image as [canvas](https://developer.mozilla.org/en/HTML/Canvas) element if set to *true*.
163164
* **crossOrigin**: Sets the crossOrigin property on the img element for loading [CORS enabled images](https://developer.mozilla.org/en-US/docs/HTML/CORS_Enabled_Image).

0 commit comments

Comments
 (0)