[READ-ONLY] Mirror of https://github.com/thoda-dev/svg-lua. svg lua library
update documentation
Thomas DAGES
(Dec 6, 2018, 3:54 PM +0100)
d8a5e6a4
decfcd55
+16
-15
+16
-15
README.md
+16
-15
README.md
···
20
20
`svg.min.lua` generated with [Lua Minifier from Mothereff.in](https://mothereff.in/lua-minifier)
21
21
22
22
# Documentation
23
+
### Main methods
23
24
**svg:create(width, height, stroke, fill)** *create the svg object*
24
25
25
-
- width: number => width of the drawing, default to 100
26
-
- height: number => height of the drawing, default to 100
27
-
- stroke: string => lines color, default to '#000000'
28
-
- fill: string => fill color, default to 'transparent'
26
+
- width: number => width of the drawing, default to 100
27
+
- height: number => height of the drawing, default to 100
28
+
- stroke: string => lines color, default to '#000000'
29
+
- fill: string => fill color, default to 'transparent'
29
30
30
31
**svg:add(element)** *add an element to the drawing*
31
32
32
-
- element: svg.Element => see farther for element list
33
+
- element: svg.Element => see farther for element list
33
34
34
35
**svg:draw()** *return the svg formated string*
35
36
36
-
## Elements for svg:add()
37
+
### Elements for svg:add()
37
38
**svg:Rect()** *add a rectangle*
38
39
39
-
- x: number => Horizontal position from top left corner, default to 10
40
-
- y: number => Vertical position from top left corner, default to 10
41
-
- width: number => Width of the rectangle, default to 10
42
-
- height: number => Height of the rectangle, default to 10
43
-
- stroke: string => lines color, default to '#000000'
44
-
- strokeWidth: string => lines width, default to 1
45
-
- fill: string => fill color, default to transparent
46
-
- rx: number => Horizontal raduis of the corners, default to 0
47
-
- ry: number => Vertical radius of the corners, default to 0
40
+
- x: number => Horizontal position from top left corner, default to 10
41
+
- y: number => Vertical position from top left corner, default to 10
42
+
- width: number => Width of the rectangle, default to 10
43
+
- height: number => Height of the rectangle, default to 10
44
+
- stroke: string => lines color, default to '#000000'
45
+
- strokeWidth: string => lines width, default to 1
46
+
- fill: string => fill color, default to transparent
47
+
- rx: number => Horizontal raduis of the corners, default to 0
48
+
- ry: number => Vertical radius of the corners, default to 0