just-sketch
v1.0.1
Published
just npm start kit.
Downloads
4
Readme
sketch
convert image to base64. Of course, you can also join images before convert.
Installation
$ yarn add just-sketch
Using Scenes
- add watermark or frame.
sketch()
.import(imageURL) // import picture
.join(qrCodeURL, { // join qr code watermark
width: 100,
right: 40,
bottom: 20,
}).rect({ // draw frame
top: 280,
left: 310,
width: 120,
height: 120,
borderWidth: 1,
borderColor: `red`,
}).export(base64 => {
document.querySelector('.js-image').src = base64;
});
Usage
convert image to base64:
import sketch from 'just-sketch'; sketch() .import(imageURL) .export(base64 => { // get base64 here... }).catch(error => console.log(error));
picture synthesis:
// Specifies the type of the exported picture sketch.imageType = 'png'; sketch() .import(imageURL) .join(anotherURL) .export(base64 => { // get png base64 here... }); // call `.join()` by chaining to join multi images sketch() .import(imageURL) .join(anotherURL, { top: 0, left: 0, }).join(anotherURL, { right: 0, bottom: 0, }).export(base64 => { // get base64 here... });
APIs
sketch([width: Number, height: Number])
:width
andheight
is optional, if they are passed in, then the size of exported base64 picture will depend on them. Otherwise, it will depend on the natural size of the imported picture in.import()
sketch.imageType
: The type(png
,jpeg
) of exported base64 picture.(jpeg
by default).import(imageURL: String)
: The size of the imported picture will determine the size of the final exported base64 picture..join(imageURL[, options: Object])
: Join another picture to the imported picture.- size:
options.width
: as you known.options.height
: as you known.
- position:
options.top
: as you known.options.right
: as you known.options.bottom
: as you known.options.left
: as you known.
- size:
.rect(options: Object)
: Join rectangle frame.- based on
.join()
options, the following options are added:options.borderWidth:
: as you known.options.borderColor:
: as you known.options.backgroundColor:
: as you known.
- based on
NOTE: Only adjacent sides position are accepted.
.export((base64, context, canvas) => {})
: Export base64 picture, or usecontext
andcanvas
to do whatever you can..catch(error => {})
: try catch export.
License
Licensed under the MIT License