canvas-form
v1.2.0
Published
You can choose some forms by canvas-form
Downloads
11
Readme
Update 1.2.0:
1- Change js to ts
2- Add createTriangle
3- Add addFontFamily
4- Fix some mistakes
Compiling
If you want to know the details, go here
OS | Command
----- | -----
OS X | Using Homebrew:brew install pkg-config cairo pango libpng jpeg giflib librsvg pixman
Ubuntu | sudo apt-get install build-essential libcairo2-dev libpango1.0-dev libjpeg-dev libgif-dev librsvg2-dev
Fedora | sudo yum install gcc-c++ cairo-devel pango-devel libjpeg-turbo-devel giflib-devel
Solaris | pkgin install cairo pango pkg-config xproto renderproto kbproto xextproto
OpenBSD | doas pkg_add cairo pango png jpeg giflib
Windows | See the wiki
Others | See the wiki
Install
npm install canvas-form --save
const { Forms } = require("canvas-form");
let form = new Forms();
Values
Key | Type --- | ---- createCircle | method createText | method createImages | method createLine | method createRect | method createRhombus | method createStar | method createTriangle | method setCanvasSize | method toBuffer | method toSave | method addFontFamily | method Canvas | prototype canvas | prototype ctx | prototype
Rect
let rect = form.createRect(/* options: RectOptions */);
rect.draw({x:200, y:100, color:"blue", drawType:"stroke"})
rect.draw({x:500, y:100, height:110, width:110});
Circle
let circle = form.createCircle(/* options: CircleOptions */);
circle.draw({x:200, y:100, color:"blue", drawType:"stroke"});
circle.draw({x:500, y:100, radius:60});
Text
let text = form.createText(/* options: TextOptions */);
text.draw({x:200, y:100, color:"blue", drawType:"stroke", text:"Hello"});
text.draw({x:500, y:100, text:"Hi", fontFamily:"Impact", size:60, textAlign:"left", width:70});
Line
let line = form.createLine(/* options: LineOptions */);
line.draw({x:200, y:100, endX:450, endY:100, color:"blue", lineWidth:3});
line.draw({x:200, y:150, endX:450, endY:150, lineWidth:5});
Rhombus
let rhombus = form.createRhombus(/* options: RhombusOptions */);
rhombus.draw({x:200, y:200, color:"blue", drawType:"stroke"});
rhombus.draw({x:500, y:200, height:80 ,width:90});
Star
let star = form.createStar(/* options: StarOptions */);
star.draw({x:200, y:100, color:"blue", drawType:"stroke"});
star.draw({x:500, y:100, spikes:9, innerRadius:20, outerRadius:30});
Image
let image = form.createImage(/* options: ImageOptions */);
image.draw({x:200, y:500, height:120, width:120, path:"https://cdn.discordapp.com/attachments/716228498825412690/987695097107873792/unknown.png"}).then(async img=>
{
await image.draw({x:400, y:500, isCircle:true, radius:60, path:"https://cdn.discordapp.com/attachments/716228498825412690/987695097107873792/unknown.png"});
await img.draw({x:600, y:500, height:100, width:100, path:"https://cdn.discordapp.com/attachments/716228498825412690/987695097107873792/unknown.png"});
await img.draw({x:800, y:500, isCircle:true, radius:50, path:"https://cdn.discordapp.com/attachments/716228498825412690/987695097107873792/unknown.png"});
});
Triangle
let triangle = form.createTriangle(/* options: TriangleOptions */);
triangle.draw({x:200, y:100, color:"red"});
triangle.draw({x:300, y:100, color:"blue", drawType:"stroke"});
triangle.draw({x:400, y:100, color:"green", rotate:70});
triangle.draw({x:200, y:200, color:"yellow", sideAB: 20, sideAC: 10});
triangle.draw({x:300, y:200, color:"pink", sideBC: 50, rotate:20});
Font Family
Warning
If you use windows os you must add font family in your windows before use addFontFamily
// Add new Font Family
form.addFontFamily(/* path: string, setName: string, options?: {style?: string, weight?: string} */) // You can add any name in setName
for examlpe:
form.addFontFamily("./Halimun.ttf","Halimun");
let text = form.createText();
text.draw({x:200, y:100, text:"Hello", fontFamily:"Halimun"});
text.draw({x:500, y:100, text:"Hello", fontFamily:"Impact"});
Canvas size
// change size canvas
form.setCanvasSize(height, width) // default height = 1920, width = 1080
Other method
// save Image
form.toSave(path, type); // path = "save local device without .", type = "png" | "jpeg"
// convert to Buffer
form.toBuffer() // return Buffer
One example in detail
form.createRect(/*options*/).draw({x:500, y:100, color:"red"}).draw({x:700, y:100, color:"red"}).draw({x:900, y:100, color:"red"});
OR
form.createRect({y:100, color:"red"}).draw({x:500}).draw({x:700}).draw({x:900});
OR
let rect = form.createRect(/*options*/);
rect.draw({x:500, y:100, color:"red"});
rect.draw({x:700, y:100, color:"red"});
rect.draw({x:900, y:100, color:"red"});
OR
let rect = form.createRect({color:"red", y:100});
rect.draw({x:500});
rect.draw({x:700});
rect.draw({x:900});
Options
RectOptions
Key | Type | Default
--- | ---- | -----
x | Number | 0
y | Number | 0
color | String | black
drawType draw
| String | fill
width | Number | 100
height | Number | 100
CircleOptions
Key | Type | Default
--- | ---- | -----
x | Number | 0
y | Number | 0
color | String | black
drawType draw
| String | fill
radius | Number | 50
TextOptions
Key | Type | Default
--- | ---- | -----
x | Number | 0
y | Number | 0
color | String | black
drawType draw
| String | fill
width | Number | 100
text | String | null
size | Number | 50
fontFamily | String | Arial
LineOptions
Key | Type | Default --- | ---- | ----- x | Number | 0 y | Number | 0 color | String | black lineWidth | Number | 1 endX | Number | 50 endY | Number | 50
RhombusOptions
Key | Type | Default
--- | ---- | -----
x | Number | 0
y | Number | 0
color | String | black
drawType draw
| String | fill
width | Number | 100
height | Number | 100
lineWidth | Number | 1
StarOptions
Key | Type | Default
--- | ---- | -----
x | Number | 0
y | Number | 0
color | String | black
drawType draw
| String | fill
lineWidth | Number | 1
spikes | Number | 5
outerRadius | Number | 30
innerRadius | Number | 15
ImageOptions
Key | Type | Default --- | ---- | ----- x | Number | 0 y | Number | 0 color | String | black width | Number | 100 height | Number | 100 path | String | null
TriangleOptions
Key | Type | Default
--- | ---- | -----
x | Number | 0
y | Number | 0
color | String | black
drawType draw
| String | fill
sideAB?| number | 0
sideAC?| number | 0
sideBC?| number | 0
rotate?| number | 0