Mathis/sharp
1
0
Fork 0
mirror of https://github.com/lovell/sharp.git synced 2025-07-12 12:00:14 +02:00
Code Issues Packages Projects Releases Wiki Activity

Stop using the legacy .extract(top,left,width,height) in the documentation.

Browse Source
This commit is contained in:
Andreas Lind 2015-11-18 11:15:44 +01:00
parent 60b8b92630
commit 530c2a9fcf
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/api.md
View File

@ -78,7 +78,7 @@ to share a single input Stream.
```javascript ```javascript
var pipeline = sharp().rotate(); var pipeline = sharp().rotate();
pipeline.clone().resize(800, 600).pipe(firstWritableStream); pipeline.clone().resize(800, 600).pipe(firstWritableStream);
pipeline.clone().extract(20, 20, 100, 100).pipe(secondWritableStream); pipeline.clone().extract({ left: 20, top: 20, width: 100, height: 100 }).pipe(secondWritableStream);
readableStream.pipe(pipeline); readableStream.pipe(pipeline);
// firstWritableStream receives auto-rotated, resized readableStream // firstWritableStream receives auto-rotated, resized readableStream
// secondWritableStream receives auto-rotated, extracted region of readableStream // secondWritableStream receives auto-rotated, extracted region of readableStream
@ -230,11 +230,11 @@ sharp(inputBuffer)
### Operations ### Operations
#### extract(top, left, width, height) #### extract({ left: left, top: top, width: width, height: height })
Extract a region of the image. Can be used with or without a `resize` operation. Extract a region of the image. Can be used with or without a `resize` operation.
`top` and `left` are the offset, in pixels, from the top-left corner. `left` and `top` are the offset, in pixels, from the top-left corner.
`width` and `height` are the dimensions of the extracted image. `width` and `height` are the dimensions of the extracted image.
@ -242,7 +242,7 @@ Use `extract` before `resize` for pre-resize extraction. Use `extract` after `re
```javascript ```javascript
sharp(input) sharp(input)
.extract(top, left, width, height) .extract({ left: left, top: top, width: width, height: height })
.toFile(output, function(err) { .toFile(output, function(err) {
// Extract a region of the input image, saving in the same format. // Extract a region of the input image, saving in the same format.
}); });
@ -250,9 +250,9 @@ sharp(input)
```javascript ```javascript
sharp(input) sharp(input)
.extract(topOffsetPre, leftOffsetPre, widthPre, heightPre) .extract({ left: leftOffsetPre, top: topOffsetPre, width: widthPre, height: heightPre })
.resize(width, height) .resize(width, height)
.extract(topOffsetPost, leftOffsetPost, widthPost, heightPost) .extract({ left: leftOffsetPost, top: topOffsetPost, width: widthPost, height: heightPost })
.toFile(output, function(err) { .toFile(output, function(err) {
// Extract a region, resize, then extract from the resized image // Extract a region, resize, then extract from the resized image
}); });