mirror/pdfme
1
0
Fork 0
mirror of https://github.com/pdfme/pdfme.git synced 2026-04-19 05:29:11 -04:00
Code Issues Packages Projects Releases Wiki Activity
Files
84303804807ca8efea07c6538bbdf4c8fd7875cc
pdfme/website/docs/api/ui/classes/Designer.md
hand-dot 8430380480 bugfix website build
2022-06-23 16:43:09 +09:00

16 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: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?: "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:12

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:11

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?: "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:60

Methods

destroy

▸ destroy(): void

Returns

void

Inherited from

BaseUIClass.destroy

Defined in

ui/src/class.ts:133

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:102

getI18n

▸ Protected getI18n(): (key: "field" | "cancel" | "fieldName" | "require" | "uniq" | "inputExample" | "edit" | "plsSelect" | "plsInputName" | "plsAddNewField" | "fieldMustUniq" | "notUniq" | "noKeyName" | "fieldsList" | "addNewField" | "editField" | "type" | "goToFirst" | "goToPrevious" | "goToNext" | "goToEnd" | "select" | "zoomIn" | "zoomOut" | "errorOccurred" | "errorBulkUpdateFieldName" | "commitBulkUpdateFieldName" | "bulkUpdateFieldName") => string

Returns

fn

▸ (key): string

Parameters
Name Type
key "field" | "cancel" | "fieldName" | "require" | "uniq" | "inputExample" | "edit" | "plsSelect" | "plsInputName" | "plsAddNewField" | "fieldMustUniq" | "notUniq" | "noKeyName" | "fieldsList" | "addNewField" | "editField" | "type" | "goToFirst" | "goToPrevious" | "goToNext" | "goToEnd" | "select" | "zoomIn" | "zoomOut" | "errorOccurred" | "errorBulkUpdateFieldName" | "commitBulkUpdateFieldName" | "bulkUpdateFieldName"
Returns

string

Inherited from

BaseUIClass.getI18n

Defined in

ui/src/class.ts:98

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:106

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

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?: "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: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: ArrayBuffer | Uint8Array ; fallback?: boolean ; subset?: boolean }>
options.lang? "en" | "ja"

Returns

void

Inherited from

BaseUIClass.updateOptions

Defined in

ui/src/class.ts:120

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:28

Reference in New Issue View Git Blame Copy Permalink