svg_drawing_core.md

Module: @svg-drawing/core

Classes

• Command
• Convert
• DrawHandler
• Path
• Point
• Renderer
• ResizeHandler
• Svg
• SvgDrawing
• Vector

Interfaces

• ConvertOption

Type Aliases

CommandObject

Ƭ CommandObject: Object

Type declaration

Name	Type
type	CommandType
value	number[]

Defined in

core/src/types.ts:37

---

CommandType

Ƭ CommandType: "M" | "m" | "L" | "l" | "C" | "c" | "Z" | "H" | "h" | "V" | "v" | "A" | "a" | "Q" | "q"

Command Object

Defined in

core/src/types.ts:21

---

DownloadOption

Ƭ DownloadOption: Object

Download options

Type declaration

Name	Type
extension	"svg" | "png" | "jpg"
filename?	string

Defined in

core/src/types.ts:64

---

DrawEventName

Ƭ DrawEventName: Extract<keyof GlobalEventHandlersEventMap, "pointerdown" | "pointermove" | "pointerleave" | "pointercancel" | "pointerup" | "touchstart" | "touchmove" | "touchend" | "touchcancel" | "mousedown" | "mousemove" | "mouseleave" | "mouseout" | "mouseup">

Defined in

core/src/types.ts:82

---

DrawHandlerCallback

Ƭ DrawHandlerCallback: Object

DrawHandler callback

Type declaration

Name	Type
end	() => void
move	(po: PointObject) => void
start	() => void

Defined in

core/src/types.ts:69

---

DrawListenerType

Ƭ DrawListenerType: "pointer" | "touch" | "mouse"

Defined in

core/src/types.ts:80

---

DrawingOption

Ƭ DrawingOption: RendererOption & { close?: boolean ; curve?: boolean ; delay?: number ; fill?: string ; penColor?: string ; penWidth?: number }

SvgDrawing options

Defined in

core/src/types.ts:55

---

ListenerMaps

Ƭ ListenerMaps: Record<DrawListenerType, { end: DrawEventName[] ; frameout: DrawEventName[] ; move: DrawEventName[] ; start: DrawEventName[] }>

Defined in

core/src/types.ts:99

---

PathObject

Ƭ PathObject: Object

Svg Path JSON

Index signature

▪ [camelCase: string]: string | undefined

Defined in

core/src/types.ts:2

---

PointObject

Ƭ PointObject: Object

Path Object

Type declaration

Name	Type
pressure?	number
x	number
y	number

Defined in

core/src/types.ts:14

---

RendererOption

Ƭ RendererOption: Pick<SvgOption, "background">

Renderer options

Defined in

core/src/types.ts:52

---

ResizeHandlerCallback

Ƭ ResizeHandlerCallback: Object

ResizeHandler callback

Type declaration

Name	Type
resize	(rect: DOMRect | { height: number ; left: number ; top: number ; width: number }) => void

Defined in

core/src/types.ts:75

---

SvgObject

Ƭ SvgObject: Object

Svg JSON

Type declaration

Name	Type
background?	string
height	number
paths	PathObject[]
width	number

Defined in

core/src/types.ts:6

---

SvgOption

Ƭ SvgOption: Object

Svg options

Type declaration

Name	Type
background?	string
height	number
width	number

Defined in

core/src/types.ts:42

Variables

COMMAND_TYPE

• Const COMMAND_TYPE: Object

Index signature

▪ [name: string]: CommandType

Defined in

core/src/svg.ts:39

---

mimeTypeMap

• Const mimeTypeMap: { [key in DownloadOption["extension"]]: string }

Defined in

core/src/download.ts:12

Functions

camel2kebab

▸ camel2kebab(str): string

Parameters

Name	Type
str	string

Returns

string

Defined in

core/src/utils.ts:1

---

createSvgChildElement

▸ createSvgChildElement(elname, attrs): SVGElement

Parameters

Name	Type
elname	string
attrs	Attrs

Returns

SVGElement

Defined in

core/src/renderer.ts:29

---

createSvgElement

▸ createSvgElement(attrs, childs): SVGSVGElement

Parameters

Name	Type
attrs	Attrs
childs	SVGElement[]

Returns

SVGSVGElement

Defined in

core/src/renderer.ts:10

---

download

▸ download(svg, opt?, dlb?): void

Parameters

Name	Type	Default value
svg	Svg	undefined
opt	DownloadOption	defaultOpts
dlb	(__namedParameters: { data: string ; extension: "svg" | "png" | "jpg" ; filename?: string }) => void	downloadBlob

Returns

void

Defined in

core/src/download.ts:57

---

downloadBlob

▸ downloadBlob(__namedParameters): void

Parameters

Name	Type
__namedParameters	Object
__namedParameters.data	string
__namedParameters.extension	"svg" | "png" | "jpg"
__namedParameters.filename?	string

Returns

void

Defined in

core/src/download.ts:18

---

getPassiveOptions

▸ getPassiveOptions(passive?): boolean | { passive: boolean }

Parameters

Name	Type	Default value
passive	boolean	true

Returns

boolean | { passive: boolean }

Defined in

core/src/handler.ts:8

---

isAlmostSameNumber

▸ isAlmostSameNumber(a, b): boolean

Parameters

Name	Type
a	number
b	number

Returns

boolean

Defined in

core/src/utils.ts:9

---

isNaN

▸ isNaN(num): boolean

Parameters

Name	Type
num	number

Returns

boolean

Defined in

core/src/utils.ts:12

---

kebab2camel

▸ kebab2camel(str): string

Parameters

Name	Type
str	string

Returns

string

Defined in

core/src/utils.ts:6

---

pathObjectToElement

▸ pathObjectToElement(path): SVGElement

Parameters

Name	Type
path	PathObject

Returns

SVGElement

Defined in

core/src/renderer.ts:42

---

roundUp

▸ roundUp(num, digits?): number

Parameters

Name	Type	Default value
num	number	undefined
digits	number	2

Returns

number

Defined in

core/src/utils.ts:4

---

svg2base64

▸ svg2base64(svg): string

Parameters

Name	Type
svg	string

Returns

string

Defined in

core/src/download.ts:9

---

svgObjectToElement

▸ svgObjectToElement(__namedParameters): SVGSVGElement

Parameters

Name	Type
__namedParameters	SvgObject

Returns

SVGSVGElement

Defined in

core/src/renderer.ts:56

---

throttle

▸ throttle<T>(func, wait, options?): (...args: Parameters<T>) => ReturnType<T> | null

Type parameters

Name	Type
T	extends (...args: any) => any

Parameters

Name	Type
func	T
wait	number
options	Options

Returns

fn

▸ (...args): ReturnType<T> | null

Parameters

Name	Type
...args	Parameters<T>

Returns

ReturnType<T> | null

Defined in

core/src/throttle.ts:6

---

toBase64

▸ toBase64(svgObj): string

Parameters

Name	Type
svgObj	SvgObject

Returns

string

Defined in

core/src/download.ts:5