本页由脚本自动生成，请勿手动编辑。如需补充说明，请使用 ::: tip 块。

Defined in: plugins/export/export.d.ts:4

Extends

• BasePlugin

Constructors

Constructor

new ExportPlugin(host, pixelRatio?): ExportPlugin;

Defined in: plugins/export/export.d.ts:8

Parameters

Parameter	Type
host	EditorHost
pixelRatio?	number

Returns

ExportPlugin

Overrides

BasePlugin.constructor

Properties

name

name: string;

Defined in: plugins/export/export.d.ts:5

Overrides

BasePlugin.name

---

version

version: string;

Defined in: plugins/export/export.d.ts:6

Overrides

BasePlugin.version

---

pixelRatio

pixelRatio: number;

Defined in: plugins/export/export.d.ts:7

Methods

handleExportExcel()

handleExportExcel(): void;

Defined in: plugins/export/export.d.ts:10

Returns

void

---

handleExportImage()

handleExportImage(): void;

Defined in: plugins/export/export.d.ts:11

Returns

void

---

handleExportJSON()

handleExportJSON(): void;

Defined in: plugins/export/export.d.ts:12

Returns

void

---

handleExportPdf()

handleExportPdf(): void;

Defined in: plugins/export/export.d.ts:13

Returns

void

---

exportImage()

exportImage(mimeType?, background?): void;

Defined in: plugins/export/export.d.ts:14

Parameters

Parameter	Type
mimeType?	"image/png" | "image/jpeg"
background?	string

Returns

void

---

exportJSON()

exportJSON(): void;

Defined in: plugins/export/export.d.ts:15

Returns

void

---

exportPdf()

exportPdf(): void;

Defined in: plugins/export/export.d.ts:16

Returns

void

---

elementsToDataURL()

elementsToDataURL(mimeType?, background?): string;

Defined in: plugins/export/export.d.ts:17

Parameters

Parameter	Type
mimeType?	"image/png" | "image/jpeg"
background?	string

Returns

string

---

install()

install(): void;

Defined in: types/base-plugin.d.ts:9

Returns

void

Inherited from

BasePlugin.install

---

uninstall()

uninstall(): void;

Defined in: types/base-plugin.d.ts:10

Returns

void

Inherited from

BasePlugin.uninstall

---

activate()

activate(): void;

Defined in: types/base-plugin.d.ts:11

Returns

void

Inherited from

BasePlugin.activate

---

deactivate()

deactivate(): void;

Defined in: types/base-plugin.d.ts:12

Returns

void

Inherited from

BasePlugin.deactivate

---

使用示例

导出 PNG 图片

import { ExportPlugin } from 'vkedit'

host.installPlugin('export', ExportPlugin)
const exportPlugin = host.getPlugin<ExportPlugin>('export')

await exportPlugin?.exportPNG({
  dpm: 12,
  fileName: 'my-design',
})

导出 PDF 文档

await exportPlugin?.exportPDF({
  dpm: 12,
  fileName: 'my-design',
  pageSize: 'A4',
})

DPM 选择指南

• 屏幕预览：DPM 8（默认值，文件体积小）
• 普通打印：DPM 12（平衡清晰度和体积）
• 高清打印：DPM 24+（最大清晰度，文件体积大）

导出是异步操作

exportPNG、exportJPG、exportPDF 均返回 Promise，需要 await。导出过程中不要修改画布内容。