Web SDK 10.0.0迁移注意事项

发布日期：2024年6月28日

1. 集成Service Worker以支持xfa文档。详情可查看：https://webviewer-demo.foxitsoftware.com/docs/developer-guide/main/skills/integrate-service-workers.html
2. 移除PDFBookmark类，改用BookmarkDataService。详情可查看： https://webviewer-demo.foxitsoftware.cn/docs/API_Reference/html/

---

Web SDK 9.2.0迁移注意事项

发布日期：2023年11月14日

1. 移除APIPDFUI.callAddonAPI，请改用PDFUI.getAddonInstance。

---

Web SDK 9.1.0迁移注意事项

发布日期：2023年8月29日

1. PDFUI.registerSignatureFlowHandler(signatureHandler)的signatureHandler参数已更改。

9.0.0
PDFUI.registerSignatureFlowHandler(type, handler)

9.1.0
PDFUI.registerSignatureFlowHandler(signatureHandler)

2. PDFUI.constructor(options)有以下更改。

9.0.0
customs.progress - { function }

9.1.0
customs.progress - { ProgressComponent }

3. 用Clipboard API覆盖PDFViewer.copySnapshot(dataURL)。因此只有HTTPS和localhost可以使用此接口。
4. 移除以下接口：

PDFViewCtrl.PDFViewer.openFileByShareId PDFViewCtrl.PDFViewer.registerCollabDataHandler PDFViewCtrl.PDFViewer.collaborate PDFViewCtrl.PDFViewer.registerSignatureHandler PDFViewCtrl.renderers.annotsRender.AnnotRender.active PDFViewCtrl.renderers.annotsRender.AnnotRender.unActive PDFViewCtrl.CustomScrollWrap PDFViewCtrl.PDF.PDFDoc.getPermission PDFViewCtrl.PDF.PDFDoc.getBookmarksJson PDFViewCtrl.PDF.form.constant.Field_Flag.Hidden PDFViewCtrl.constants.ViewerEvents.disableScroll PDFViewCtrl.PDF.constant.DataEvents.annotationReplyAdd PDFViewCtrl.PDF.constant.DataEvents.annotationReviewStateAnnotAdd PDFViewCtrl.PDF.constant.DataEvents.annotationMarkedStateAnnotAdd PDFViewCtrl.PDF.constant.DataEvents.annotationMovedPosition PDFViewCtrl.PDF.constant.DataEvents.actionAdd PDFViewCtrl.PDF.constant.DataEvents.layerVisibleChange PDFViewCtrl.PDF.constant.DataEvents.pageInfoChange PDFViewCtrl.PDF.constant.DataEvents.pageRotationChange PDFViewCtrl.PDF.constant.DataEvents.drmEncryptSuccess PDFViewCtrl.PDF.constant.DataEvents.removePwdAndPerm PDFViewCtrl.PDF.constant.DataEvents.insertPages PDFViewCtrl.PDF.constant.DataEvents.applyRedaction PDFViewCtrl.PDF.constant.DataEvents.removeReviewState

---

Web SDK 9.0.0迁移注意事项

发布日期：2023年3月7日

1. pdfDoc.sign(data)的DigestSignHandler参数已更改。

8.5.2
DigestSignHandler(signInfo, buffer) - 缓冲区类型为ArrayBuffer。

9.0.0
DigestSignHandler(signInfo, plainContent) - 纯内容类型为Blob。

---

Web SDK 8.5.2迁移注意事项

发布日期：2022年11月15日

1. 内置的协作API已弃用，由Foxit Web协作插件替代： https://webviewer-demo.foxit.com/docs/collab-developer-guide/
2. 移除/examples/UIExtension/collaboration，server/collaboration-sockjs-server和server/collaboration-websocket-server

---

Web SDK 8.5.0迁移注意事项

发布日期：2022年9月5日

1. PDFViewer.constructor(options)有以下更改。

8.4.0
customs.activeTooltip - { function }

8.5.0
customs.AnnotTooltip - { AnnotTooltip }

---

Web SDK 8.4.0迁移注意事项

发布日期：2022年5月31日

GraphicsObject.getBitmap(data)有以下更改：

1. 添加一个新参数：type。
2. 返回值已更改：

8.3.0 返回值

    {Promise.<byte buffer>} - 图像数据缓冲区。

8.4.0 返回值

    {Promise.<T>} - 指定类型的图像数据。

---

Web SDK 8.3.0迁移注意事项

发布日期：2022年3月8日

1. PDFViewer.takeSnapshot(pageIndex, left, top, width, height)和PDFPageRender.getSnapshot(left, top, width, height)的参数已更改。
   1). 以下参数以设备像素为单位：left, top, width, height
2. PDFUI.callAddonAPI的示例代码已更改。
   详情可查看： https://webviewer-demo.foxitsoftware.cn/docs/API_Reference/html/
3. 事件名称更改如下：

已弃用	替代
annotationReplyAdd	annotationReplyAdded
annotationReviewStateAnnotAdd	annotationReviewStateAnnotAdded
annotationMarkedStateAnnotAdd	annotationMarkedStateAnnotAdded
annotationMovedPosition	annotationPositionMoved
actionAdd	actionAdded
layerVisibleChange	layerVisibleChanged
pageInfoChange	pageInfoChanged
pageRotationChange	pageRotationChanged
drmEncryptSuccess	drmEncryptSucceeded
removePwdAndPerm	pwdAndPermRemoved
insertPages	pagesInserted
applyRedaction	redactionApplied
removeReviewState	reviewStateRemoved

4. 缩略图、搜索侧边栏面板、打印和印章功能的用户界面已更改。

---

Web SDK 8.2.1迁移注意事项

移除lib/adaptive.js。

---

Foxit PDF SDK for Web 8.2.0迁移注意事项

发布日期：2021年11月29日

1. pdfDoc.movePagesTo()的返回值已更改为数组，而不是布尔值。

8.1.0返回值

    {Promise.<bool>}  true表示成功，false表示失败。

8.2.0 返回值
    {Promise.<Array>} - 页面ID列表

2. pdfpage.addWatermark(data)的参数已更改。
   1). 以下参数已弃用：
   watermarkConfig.watermarkSettings.scaleX,
   watermarkConfig.watermarkSettings.scaleY,
   watermarkConfig.watermarkTextProperties.lineSpace,
   watermarkConfig.watermarkTextProperties.alignment
   2). 添加两个新参数：watermarkConfig.watermarkSettings.scale 和 watermarkConfig.useRelativeScale

---

Web SDK 8.1.0迁移注意事项

发布日期：2021年8月31日

Foxit PDF SDK for Web 8.1.0与其先前版本完全向后兼容。

---

Web SDK 8.0.0迁移注意事项

PDFViewCtrl

PDF.PDFForm.addControl()的返回值已更改为对象，而不是布尔值。

7.6版本返回值

    {Promise.<bool>}  true表示成功，false表示失败。

8.0版本返回值
{
    success:boolean, - true表示成功，false表示失败
    newFieldName:string -如果指定的字段名不能用于指定字段类型的新字段，它将为指定字段类型使用一个新的字段名。
}

---

Web SDK 7.6.0迁移注意事项

PDFViewCtrl

1. 常量STATE_HANDLER_SELECT_TEXT_ANNOTATION已弃用。如果您使用的是7.6.0或更高版本，应将处理程序更改为STATE_HANDLER_SELECT_TEXT_IMAGE或STATE_HANDLER_SELECT_ANNOTATION。

相关API:
PDFViewCtrl.contants.STATE_HANDLER_NAMES

PDFUI

1. 为创建用户印章，在PDFViewCtrl::stateHandler::StampStateHandlerParams中添加了两个新参数url和showUrl。如果未声明url和showUrl，印章在页面上将显示为空白矩形。
   相关接口:

PDFViewCtrl.constants.STATE_HANDLER_NAMES.STATE_HANDLER_CREATE_STAMP
PDFViewCtrl::stateHandler::StampStateHandlerParams

---

Web SDK 7.5.0迁移注意事项

Foxit PDF SDK for Web 7.5.0与其先前版本完全向后兼容。

---

Web SDK 7.4.0迁移注意事项

PDFUI

1. 如果您的用户界面使用UIExtension内置模板，并且有自定义<tab>，在升级前应了解此更改。添加自定义<tab>的方法调整如下：

[{
    target: 'toolbar-tabs',
    action: FRAGMENT_ACTION.APPEND,
    template: '<gtab name="new-tab" group="toolbar-tab" body="new-tab-body">Tab inserted via fragment-configuration</gtab>'
}, {
    target: 'toolbar-tab-bodies',
    action: FRAGMENT_ACTION.APPEND,
    template: '<div name="new-tab-body" style="line-height:1"><text>New tab body</text></div>'
}];

详情可查看： https://webviewer-demo.foxitsoftware.com/docs/developer-guide/ui-extension/components/tab.html#examples

2. <tab>组件已替换为<gtab>。如果您的用户界面使用UIExtension内置模板，应添加以下CSS：

css .fv__ui-toolbar.fv__ui-gtab-item { color: #fff; } .fv__ui-toolbar.fv__ui-gtab-item.active { color: #636363;y background-color: #fff; }