Class: Designer

Hierarchy

• BaseUIClass

  ↳ Designer

Constructors

constructor

• new Designer(props)

Parameters

Name	Type
props	Object
props.domContainer	HTMLElement
props.options?	Object
props.options.font?	Record<string, { data: string | ArrayBuffer | Uint8Array ; fallback?: boolean ; subset?: boolean }>
props.options.lang?	"en" | "ja" | "ar"
props.template	Object
props.template.basePdf	string | ArrayBuffer | Uint8Array
props.template.columns?	string[]
props.template.sampledata?	Record<string, string>[]
props.template.schemas	Record<string, { alignment?: "center" | "left" | "right" ; backgroundColor?: string ; characterSpacing?: number ; dynamicFontSize?: { max: number ; min: number } ; fontColor?: string ; fontName?: string ; fontSize?: number ; height: number ; lineHeight?: number ; position: { x: number ; y: number } ; rotate?: number ; type: "text" ; width: number } | { height: number ; position: { x: number ; y: number } ; rotate?: number ; type: "image" ; width: number } | { height: number ; position: { x: number ; y: number } ; rotate?: number ; type: "qrcode" | "japanpost" | "ean13" | "ean8" | "code39" | "code128" | "nw7" | "itf14" | "upca" | "upce" ; width: number }>[]

Overrides

BaseUIClass.constructor

Defined in

ui/src/Designer.tsx:14

Properties

domContainer

• Protected domContainer: null | HTMLElement

Inherited from

BaseUIClass.domContainer

Defined in

ui/src/class.ts:58

---

onChangeTemplateCallback

• Private Optional onChangeTemplateCallback: (template: { basePdf: string | ArrayBuffer | Uint8Array ; columns?: string[] ; sampledata?: Record<string, string>[] ; schemas: Record<string, { alignment?: "center" | "left" | "right" ; backgroundColor?: string ; characterSpacing?: number ; dynamicFontSize?: { max: number ; min: number } ; fontColor?: string ; fontName?: string ; fontSize?: number ; height: number ; lineHeight?: number ; position: { x: number ; y: number } ; rotate?: number ; type: "text" ; width: number } | { height: number ; position: { x: number ; y: number } ; rotate?: number ; type: "image" ; width: number } | { height: number ; position: { x: number ; y: number } ; rotate?: number ; type: "qrcode" | "japanpost" | "ean13" | "ean8" | "code39" | "code128" | "nw7" | "itf14" | "upca" | "upce" ; width: number }>[] }) => void

Type declaration

▸ (template): void

Parameters

Name	Type
template	Object
template.basePdf	string | ArrayBuffer | Uint8Array
template.columns?	string[]
template.sampledata?	Record<string, string>[]
template.schemas	Record<string, { alignment?: "center" | "left" | "right" ; backgroundColor?: string ; characterSpacing?: number ; dynamicFontSize?: { max: number ; min: number } ; fontColor?: string ; fontName?: string ; fontSize?: number ; height: number ; lineHeight?: number ; position: { x: number ; y: number } ; rotate?: number ; type: "text" ; width: number } | { height: number ; position: { x: number ; y: number } ; rotate?: number ; type: "image" ; width: number } | { height: number ; position: { x: number ; y: number } ; rotate?: number ; type: "qrcode" | "japanpost" | "ean13" | "ean8" | "code39" | "code128" | "nw7" | "itf14" | "upca" | "upce" ; width: number }>[]

Returns

void

Defined in

ui/src/Designer.tsx:12

---

onSaveTemplateCallback

• Private Optional onSaveTemplateCallback: (template: { basePdf: string | ArrayBuffer | Uint8Array ; columns?: string[] ; sampledata?: Record<string, string>[] ; schemas: Record<string, { alignment?: "center" | "left" | "right" ; backgroundColor?: string ; characterSpacing?: number ; dynamicFontSize?: { max: number ; min: number } ; fontColor?: string ; fontName?: string ; fontSize?: number ; height: number ; lineHeight?: number ; position: { x: number ; y: number } ; rotate?: number ; type: "text" ; width: number } | { height: number ; position: { x: number ; y: number } ; rotate?: number ; type: "image" ; width: number } | { height: number ; position: { x: number ; y: number } ; rotate?: number ; type: "qrcode" | "japanpost" | "ean13" | "ean8" | "code39" | "code128" | "nw7" | "itf14" | "upca" | "upce" ; width: number }>[] }) => void

Type declaration

▸ (template): void

Parameters

Name	Type
template	Object
template.basePdf	string | ArrayBuffer | Uint8Array
template.columns?	string[]
template.sampledata?	Record<string, string>[]
template.schemas	Record<string, { alignment?: "center" | "left" | "right" ; backgroundColor?: string ; characterSpacing?: number ; dynamicFontSize?: { max: number ; min: number } ; fontColor?: string ; fontName?: string ; fontSize?: number ; height: number ; lineHeight?: number ; position: { x: number ; y: number } ; rotate?: number ; type: "text" ; width: number } | { height: number ; position: { x: number ; y: number } ; rotate?: number ; type: "image" ; width: number } | { height: number ; position: { x: number ; y: number } ; rotate?: number ; type: "qrcode" | "japanpost" | "ean13" | "ean8" | "code39" | "code128" | "nw7" | "itf14" | "upca" | "upce" ; width: number }>[]

Returns

void

Defined in

ui/src/Designer.tsx:11

---

resizeObserver

• resizeObserver: ResizeObserver

Inherited from

BaseUIClass.resizeObserver

Defined in

ui/src/class.ts:77

---

size

• Protected size: Object

Type declaration

Name	Type
height	number
width	number

Inherited from

BaseUIClass.size

Defined in

ui/src/class.ts:62

---

template

• Protected template: Object

Type declaration

Name	Type
basePdf	string | ArrayBuffer | Uint8Array
columns?	string[]
sampledata?	Record<string, string>[]
schemas	Record<string, { alignment?: "center" | "left" | "right" ; backgroundColor?: string ; characterSpacing?: number ; dynamicFontSize?: { max: number ; min: number } ; fontColor?: string ; fontName?: string ; fontSize?: number ; height: number ; lineHeight?: number ; position: { x: number ; y: number } ; rotate?: number ; type: "text" ; width: number } | { height: number ; position: { x: number ; y: number } ; rotate?: number ; type: "image" ; width: number } | { height: number ; position: { x: number ; y: number } ; rotate?: number ; type: "qrcode" | "japanpost" | "ean13" | "ean8" | "code39" | "code128" | "nw7" | "itf14" | "upca" | "upce" ; width: number }>[]

Inherited from

BaseUIClass.template

Defined in

ui/src/class.ts:60

Methods

destroy

▸ destroy(): void

Returns

void

Inherited from

BaseUIClass.destroy

Defined in

ui/src/class.ts:135

---

getFont

▸ Protected getFont(): Record<string, { data: string | ArrayBuffer | Uint8Array ; fallback?: boolean ; subset?: boolean }>

Returns

Record<string, { data: string | ArrayBuffer | Uint8Array ; fallback?: boolean ; subset?: boolean }>

Inherited from

BaseUIClass.getFont

Defined in

ui/src/class.ts:104

---

getI18n

▸ Protected getI18n(): (key: "field" | "cancel" | "fieldName" | "require" | "uniq" | "inputExample" | "edit" | "plsInputName" | "fieldMustUniq" | "notUniq" | "noKeyName" | "fieldsList" | "addNewField" | "editField" | "type" | "errorOccurred" | "errorBulkUpdateFieldName" | "commitBulkUpdateFieldName" | "bulkUpdateFieldName") => string

Returns

fn

▸ (key): string

Parameters

Name	Type
key	"field" | "cancel" | "fieldName" | "require" | "uniq" | "inputExample" | "edit" | "plsInputName" | "fieldMustUniq" | "notUniq" | "noKeyName" | "fieldsList" | "addNewField" | "editField" | "type" | "errorOccurred" | "errorBulkUpdateFieldName" | "commitBulkUpdateFieldName" | "bulkUpdateFieldName"

Returns

string

Inherited from

BaseUIClass.getI18n

Defined in

ui/src/class.ts:100

---

getTemplate

▸ getTemplate(): Object

Returns

Object

Name	Type
basePdf	string | ArrayBuffer | Uint8Array
columns?	string[]
sampledata?	Record<string, string>[]
schemas	Record<string, { alignment?: "center" | "left" | "right" ; backgroundColor?: string ; characterSpacing?: number ; dynamicFontSize?: { max: number ; min: number } ; fontColor?: string ; fontName?: string ; fontSize?: number ; height: number ; lineHeight?: number ; position: { x: number ; y: number } ; rotate?: number ; type: "text" ; width: number } | { height: number ; position: { x: number ; y: number } ; rotate?: number ; type: "image" ; width: number } | { height: number ; position: { x: number ; y: number } ; rotate?: number ; type: "qrcode" | "japanpost" | "ean13" | "ean8" | "code39" | "code128" | "nw7" | "itf14" | "upca" | "upce" ; width: number }>[]

Inherited from

BaseUIClass.getTemplate

Defined in

ui/src/class.ts:108

---

onChangeTemplate

▸ onChangeTemplate(cb): void

Parameters

Name

Type

cb

(template: { basePdf: string | ArrayBuffer | Uint8Array ; columns?: string[] ; sampledata?: Record<string, string>[] ; schemas: Record<string, { alignment?: "center" | "left" | "right" ; backgroundColor?: string ; characterSpacing?: number ; dynamicFontSize?: { max: number ; min: number } ; fontColor?: string ; fontName?: string ; fontSize?: number ; height: number ; lineHeight?: number ; position: { x: number ; y: number } ; rotate?: number ; type: "text" ; width: number } | { height: number ; position: { x: number ; y: number } ; rotate?: number ; type: "image" ; width: number } | { height: number ; position: { x: number ; y: number } ; rotate?: number ; type: "qrcode" | "japanpost" | "ean13" | "ean8" | "code39" | "code128" | "nw7" | "itf14" | "upca" | "upce" ; width: number }>[] }) => void

Returns

void

Defined in

ui/src/Designer.tsx:42

---

onSaveTemplate

▸ onSaveTemplate(cb): void

Parameters

Name

Type

cb

(template: { basePdf: string | ArrayBuffer | Uint8Array ; columns?: string[] ; sampledata?: Record<string, string>[] ; schemas: Record<string, { alignment?: "center" | "left" | "right" ; backgroundColor?: string ; characterSpacing?: number ; dynamicFontSize?: { max: number ; min: number } ; fontColor?: string ; fontName?: string ; fontSize?: number ; height: number ; lineHeight?: number ; position: { x: number ; y: number } ; rotate?: number ; type: "text" ; width: number } | { height: number ; position: { x: number ; y: number } ; rotate?: number ; type: "image" ; width: number } | { height: number ; position: { x: number ; y: number } ; rotate?: number ; type: "qrcode" | "japanpost" | "ean13" | "ean8" | "code39" | "code128" | "nw7" | "itf14" | "upca" | "upce" ; width: number }>[] }) => void

Returns

void

Defined in

ui/src/Designer.tsx:38

---

render

▸ Protected render(): void

Returns

void

Overrides

BaseUIClass.render

Defined in

ui/src/Designer.tsx:46

---

saveTemplate

▸ saveTemplate(): void

Returns

void

Defined in

ui/src/Designer.tsx:21

---

updateOptions

▸ updateOptions(options): void

Parameters

Name	Type
options	Object
options.font?	Record<string, { data: string | ArrayBuffer | Uint8Array ; fallback?: boolean ; subset?: boolean }>
options.lang?	"en" | "ja" | "ar"

Returns

void

Inherited from

BaseUIClass.updateOptions

Defined in

ui/src/class.ts:122

---

updateTemplate

▸ updateTemplate(template): void

Parameters

Name	Type
template	Object
template.basePdf	string | ArrayBuffer | Uint8Array
template.columns?	string[]
template.sampledata?	Record<string, string>[]
template.schemas	Record<string, { alignment?: "center" | "left" | "right" ; backgroundColor?: string ; characterSpacing?: number ; dynamicFontSize?: { max: number ; min: number } ; fontColor?: string ; fontName?: string ; fontSize?: number ; height: number ; lineHeight?: number ; position: { x: number ; y: number } ; rotate?: number ; type: "text" ; width: number } | { height: number ; position: { x: number ; y: number } ; rotate?: number ; type: "image" ; width: number } | { height: number ; position: { x: number ; y: number } ; rotate?: number ; type: "qrcode" | "japanpost" | "ean13" | "ean8" | "code39" | "code128" | "nw7" | "itf14" | "upca" | "upce" ; width: number }>[]

Returns

void

Overrides

BaseUIClass.updateTemplate

Defined in

ui/src/Designer.tsx:28