Class: TextSVGOptions

Plugins.TextSVGOptions

Implements

• ITextSVGOptions

Constructors

constructor

• new TextSVGOptions()

Properties

text

• text: string = 'Custom Text'

Implementation of

ITextSVGOptions.text

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:43

---

fontSize

• fontSize: number = 100

Implementation of

ITextSVGOptions.fontSize

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:44

---

width

• width: number = 1024

Implementation of

ITextSVGOptions.width

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:45

---

height

• height: number = 1024

Implementation of

ITextSVGOptions.height

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:46

---

xOffset

• xOffset: number = 0

Implementation of

ITextSVGOptions.xOffset

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:47

---

yOffset

• yOffset: number = 0

Implementation of

ITextSVGOptions.yOffset

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:48

---

boxWidth

• boxWidth: number = 1024

Implementation of

ITextSVGOptions.boxWidth

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:49

---

boxHeight

• boxHeight: number = 1024

Implementation of

ITextSVGOptions.boxHeight

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:50

---

textAnchor

• textAnchor: "start" | "end" | "middle" = 'middle'

Implementation of

ITextSVGOptions.textAnchor

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:51

---

fontFamily

• fontFamily: string = ''

Implementation of

ITextSVGOptions.fontFamily

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:52

---

fontPath

• fontPath: string = ''

Implementation of

ITextSVGOptions.fontPath

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:53

---

maskText

• maskText: boolean = false

Implementation of

ITextSVGOptions.maskText

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:54

---

innerShadow

• innerShadow: boolean = false

Implementation of

ITextSVGOptions.innerShadow

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:55

---

textColor

• textColor: string = '#000000'

Implementation of

ITextSVGOptions.textColor

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:56

---

bgFillColor

• bgFillColor: string = '#ffffff'

Implementation of

ITextSVGOptions.bgFillColor

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:57

---

svgBackground

• svgBackground: string = '#ffffff'

Implementation of

ITextSVGOptions.svgBackground

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:58

Methods

onChange

▸ onChange(): void

Returns

void

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:60

---

set

▸ set(ops): void

Parameters

Name	Type
ops	ITextSVGOptions

Returns

void

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:61

---

reset

▸ reset(): void

Returns

void

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:64

---

toJSON

▸ toJSON(): Object

Returns

Object

Name	Type
text	string
fontFamily	string
fontPath	string
svgBackground	string
width	number
height	number
xOffset	number
yOffset	number
boxWidth	number
boxHeight	number
fontSize	number
maskText	boolean
innerShadow	boolean
bgFillColor	string
textColor	string
textAnchor	"start" | "end" | "middle"

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:69