pdfme/website/docs/api/ui/classes/Designer.md at d9f1a6d1a8000f46b29bd52c5d58707c14071663

mirror/pdfme

Fork 0

mirror of https://github.com/pdfme/pdfme.git synced 2026-04-22 15:09:24 -04:00

Files

hand-dot d9f1a6d1a8 fix website sidebar

2022-02-02 14:47:17 +09:00

15 KiB

Raw Blame History

id, title, sidebar_label, sidebar_position, custom_edit_url

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

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`: `ArrayBuffer` \| `Uint8Array` ; `fallback?`: `boolean` ; `subset?`: `boolean` }>
`props.options.lang?`	`"en"` \| `"ja"`
`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?`: `"left"` \| `"center"` \| `"right"` ; `backgroundColor?`: `string` ; `characterSpacing?`: `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:13

Properties

domContainer

• Protected domContainer: null | HTMLElement

Inherited from

BaseUIClass.domContainer

Defined in

ui/src/class.ts:54

onChangeTemplateCallback

• Private Optional onChangeTemplateCallback: (template: { basePdf: string | ArrayBuffer | Uint8Array ; columns?: string[] ; sampledata?: Record<string, string>[] ; schemas: Record<string, { alignment?: "left" | "center" | "right" ; backgroundColor?: string ; characterSpacing?: 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?`: `"left"` \| `"center"` \| `"right"` ; `backgroundColor?`: `string` ; `characterSpacing?`: `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

onSaveTemplateCallback

• Private Optional onSaveTemplateCallback: (template: { basePdf: string | ArrayBuffer | Uint8Array ; columns?: string[] ; sampledata?: Record<string, string>[] ; schemas: Record<string, { alignment?: "left" | "center" | "right" ; backgroundColor?: string ; characterSpacing?: 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?`: `"left"` \| `"center"` \| `"right"` ; `backgroundColor?`: `string` ; `characterSpacing?`: `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:10

size

• Protected size: Object

Type declaration

Name	Type
`height`	`number`
`width`	`number`

Inherited from

BaseUIClass.size

Defined in

ui/src/class.ts:58

template

• Protected template: Object

Type declaration

Name	Type
`basePdf`	`string` \| `ArrayBuffer` \| `Uint8Array`
`columns?`	`string`[]
`sampledata?`	`Record`<`string`, `string`>[]
`schemas`	`Record`<`string`, { `alignment?`: `"left"` \| `"center"` \| `"right"` ; `backgroundColor?`: `string` ; `characterSpacing?`: `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:56

Methods

destroy

▸ destroy(): void

Returns

void

Inherited from

BaseUIClass.destroy

Defined in

ui/src/class.ts:114

getFont

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

Returns

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

Inherited from

BaseUIClass.getFont

Defined in

ui/src/class.ts:98

getI18n

Returns

fn

▸ (key): string

Parameters

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

Returns

string

Inherited from

BaseUIClass.getI18n

Defined in

ui/src/class.ts:94

getTemplate

▸ getTemplate(): Object

Returns

Object

Name	Type
`basePdf`	`string` \| `ArrayBuffer` \| `Uint8Array`
`columns?`	`string`[]
`sampledata?`	`Record`<`string`, `string`>[]
`schemas`	`Record`<`string`, { `alignment?`: `"left"` \| `"center"` \| `"right"` ; `backgroundColor?`: `string` ; `characterSpacing?`: `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:102

onChangeTemplate

▸ onChangeTemplate(cb): void

Parameters

Name Type

cb (template: { basePdf: string | ArrayBuffer | Uint8Array ; columns?: string[] ; sampledata?: Record<string, string>[] ; schemas: Record<string, { alignment?: "left" | "center" | "right" ; backgroundColor?: string ; characterSpacing?: 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

Name	Type
`cb`	(`template`: { `basePdf`: `string` \| `ArrayBuffer` \| `Uint8Array` ; `columns?`: `string`[] ; `sampledata?`: `Record`<`string`, `string`>[] ; `schemas`: `Record`<`string`, { `alignment?`: `"left"` \| `"center"` \| `"right"` ; `backgroundColor?`: `string` ; `characterSpacing?`: `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:40

onSaveTemplate

▸ onSaveTemplate(cb): void

Parameters

Name Type

Name	Type
`cb`	(`template`: { `basePdf`: `string` \| `ArrayBuffer` \| `Uint8Array` ; `columns?`: `string`[] ; `sampledata?`: `Record`<`string`, `string`>[] ; `schemas`: `Record`<`string`, { `alignment?`: `"left"` \| `"center"` \| `"right"` ; `backgroundColor?`: `string` ; `characterSpacing?`: `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:36

render

▸ Protected render(): void

Returns

void

Overrides

BaseUIClass.render

Defined in

ui/src/Designer.tsx:44

saveTemplate

▸ saveTemplate(): void

Returns

void

Defined in

ui/src/Designer.tsx:20

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?`: `"left"` \| `"center"` \| `"right"` ; `backgroundColor?`: `string` ; `characterSpacing?`: `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:27

15 KiB Raw Blame History

Hierarchy

Constructors

constructor

Parameters

Overrides

Defined in

Properties

domContainer

Inherited from

Defined in

onChangeTemplateCallback

Type declaration

Parameters

Returns

Defined in

onSaveTemplateCallback

Type declaration

Parameters

Returns

Defined in

size

Type declaration

Inherited from

Defined in

template

Type declaration

Inherited from

Defined in

Methods

destroy

Returns

Inherited from

Defined in

getFont

Returns

Inherited from

Defined in

getI18n

Returns

Parameters

Returns

Inherited from

Defined in

getTemplate

Returns

Inherited from

Defined in

onChangeTemplate

Parameters

Returns

Defined in

onSaveTemplate

Parameters

Returns

Defined in

render

Returns

Overrides

Defined in

saveTemplate

Returns

Defined in

updateTemplate

Parameters

Returns

Overrides

Defined in

15 KiB

Raw Blame History