pdfme/website/docs/api/classes/Form.md

id, title, sidebar_label, sidebar_position, custom_edit_url

id	title	sidebar_label	sidebar_position	custom_edit_url
Form	Class: Form	Form	0	null

Hierarchy

• PreviewUI

  ↳ Form

Constructors

constructor

• new Form(props)

Parameters

Name	Type
props	PreviewUIConstructor

Overrides

PreviewUI.constructor

Defined in

Form.tsx:11

Properties

domContainer

• Protected domContainer: null | HTMLElement

Inherited from

PreviewUI.domContainer

Defined in

libs/class.ts:19

---

inputs

• Protected inputs: { [key: string]: string; }[]

Inherited from

PreviewUI.inputs

Defined in

libs/class.ts:89

---

onChangeInputCallback

• Private Optional onChangeInputCallback: (arg: { index: number ; key: string ; value: string }) => void

Type declaration

▸ (arg): void

Parameters

Name	Type
arg	Object
arg.index	number
arg.key	string
arg.value	string

Returns

void

Defined in

Form.tsx:9

---

size

• Protected size: Object

Type declaration

Name	Type
height	number
width	number

Inherited from

PreviewUI.size

Defined in

libs/class.ts:23

---

template

• Protected template: Object

Type declaration

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

Inherited from

PreviewUI.template

Defined in

libs/class.ts:21

Methods

destroy

▸ destroy(): void

Returns

void

Inherited from

PreviewUI.destroy

Defined in

libs/class.ts:79

---

getFont

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

Returns

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

Inherited from

PreviewUI.getFont

Defined in

libs/class.ts:63

---

getI18n

▸ Protected getI18n(): (key: "type" | "field" | "fieldName" | "require" | "uniq" | "inputExample" | "edit" | "plsSelect" | "plsInputName" | "plsAddNewField" | "fieldMustUniq" | "noKeyName" | "fieldsList" | "addNewField" | "editField" | "previewWarnMsg" | "previewErrMsg" | "goToFirst" | "goToPrevious" | "goToNext" | "goToEnd" | "select" | "errorOccurred") => string

Returns

fn

▸ (key): string

Parameters

Name	Type
key	"type" | "field" | "fieldName" | "require" | "uniq" | "inputExample" | "edit" | "plsSelect" | "plsInputName" | "plsAddNewField" | "fieldMustUniq" | "noKeyName" | "fieldsList" | "addNewField" | "editField" | "previewWarnMsg" | "previewErrMsg" | "goToFirst" | "goToPrevious" | "goToNext" | "goToEnd" | "select" | "errorOccurred"

Returns

string

Inherited from

PreviewUI.getI18n

Defined in

libs/class.ts:59

---

getInputs

▸ getInputs(): { [key: string]: string; }[]

Returns

{ [key: string]: string; }[]

Inherited from

PreviewUI.getInputs

Defined in

libs/class.ts:99

---

getTemplate

▸ getTemplate(): Object

Returns

Object

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

Inherited from

PreviewUI.getTemplate

Defined in

libs/class.ts:67

---

onChangeInput

▸ onChangeInput(cb): void

Parameters

Name	Type
cb	(arg: { index: number ; key: string ; value: string }) => void

Returns

void

Defined in

Form.tsx:15

---

render

▸ Protected render(): void

Returns

void

Overrides

PreviewUI.render

Defined in

Form.tsx:19

---

setInputs

▸ setInputs(inputs): void

Parameters

Name	Type
inputs	{ [key: string]: string; }[]

Returns

void

Inherited from

PreviewUI.setInputs

Defined in

libs/class.ts:105

---

updateTemplate

▸ updateTemplate(template): void

Parameters

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

Returns

void

Inherited from

PreviewUI.updateTemplate

Defined in

libs/class.ts:73