ComPDFKit
产品介绍
New
开发文档
联系我们
PDF SDKIDPConversion SDK
PDF SDK
技术支持

ComPDFKit ​

提供用于全局库初始化、配置和实用工具方法的静态方法。

init_ ​

使用您的 ComPDFKit 商业许可证密钥离线初始化 ComPDFKit SDK。请联系销售部门获取试用许可证。

参数：

名称类型描述
licensestring您的 ComPDFKit 许可证密钥

返回一个 Promise。

名称类型描述
resultboolean如果初始化成功，返回 true，否则返回 false。
tsx
ComPDFKit.init_('your compdfkit license')

initialize ​

使用您的 ComPDFKit 商业许可证密钥，通过在线认证初始化 ComPDFKit SDK。请联系销售部门获取试用许可证。

参数：

名称类型描述
androidOnlineLicensestring您的 ComPDFKit for React Native Android 在线许可证密钥。
iosOnlineLicensestring您的 ComPDFKit for React Native iOS 在线许可证密钥。

返回一个 Promise。

名称类型描述
resultboolean如果初始化成功，返回 true，否则返回 false。
tsx
ComPDFKit.initialize('android online license', 'ios online license')

getVersionCode ​

获取 ComPDFKit SDK 的版本号。

例如：'2.0.1'

返回一个 Promise。

名称类型描述
versionCodeStringComPDFKit SDK 的版本号。
tsx
ComPDFKit.getVersionCode().then((versionCode : string) => {
  console.log('ComPDFKit SDK Version:', versionCode)
})

getSDKBuildTag ​

获取 ComPDFKit PDF SDK 的构建标记。

例如："build_beta_2.0.0_42db96987_202404081007"

返回一个 Promise。

名称类型描述
buildTagStringComPDFKit PDF SDK 的构建标记。
tsx
ComPDFKit.getSDKBuildTag().then((buildTag : string) => {
  console.log('ComPDFKit Build Tag:', buildTag)
})

openDocument ​

用于展示 PDF 文档。

参数：

名称类型描述
documentstring要展示的 PDF 文档路径。
passwordstringPDF 文档的密码。
configurationstring配置对象，用于自定义 ComPDFKit 的外观和行为。
  • (Android) 对于本地存储文件路径：
tsx
document = '/storage/emulated/0/Download/PDF_document.pdf'
ComPDFKit.openDocument(document, '', ComPDFKit.getDefaultConfig({}))
  • (Android) 对于内容 Uri：
tsx
document = 'content://...'
ComPDFKit.openDocument(document, '', ComPDFKit.getDefaultConfig({}))
  • (Android) 对于 assets 路径：
tsx
document = "file:///android_asset/..."
ComPDFKit.openDocument(document, '', ComPDFKit.getDefaultConfig({}))
  • (iOS) 对于应用程序包文件路径：
tsx
document = 'pdf_document.pdf'
ComPDFKit.openDocument(document, '', ComPDFKit.getDefaultConfig({}))

getDefaultConfig ​

当使用 ComPDFKit.openDocument 方法或 CPDFReaderView UI 组件展示 PDF 文件时，您需要传递配置参数来定制 UI 特性和 PDF 查看属性。ComPDFKit 提供了通过 ComPDFKit.getDefaultConfig 获取的默认配置参数。您可以使用以下示例来获取它们：

tsx
ComPDFKit.getDefaultConfig({})

您可以修改某些参数以满足您的需求。以下是一些使用示例：

  1. 设置初始显示模式和可用模式列表。以下代码示例仅启用查看模式和注释模式：
tsx
ComPDFKit.getDefaultConfig({
  modeConfig: {
    initialViewMode: CPDFViewMode.VIEWER,
    availableViewModes: [
      CPDFViewMode.VIEWER,
      CPDFViewMode.ANNOTATIONS
    ]
  }
})
  1. 设置启用的注释类型和默认注释属性值列表。例如，仅启用注释注释并设置注释的颜色和透明度：
tsx
ComPDFKit.getDefaultConfig({
  annotationsConfig:{
    availableType:[
      CPDFAnnotationType.NOTE
    ],
    availableTools:[
      CPDFConfigTool.SETTING,
      CPDFConfigTool.UNDO,
      CPDFConfigTool.REDO
    ],
    initAttribute:{
      note:{
        color: '#1460F3',
        alpha: 255
      }
    }
  }
})
  1. 设置显示模式和翻页方向：
tsx
ComPDFKit.getDefaultConfig({
  readerViewConfig:{
    displayMode: CPDFDisplayMode.DOUBLE_PAGE,
    verticalMode: false
  }
})

有关更多配置参数的描述，请参阅 CPDFCONFIGURATION.md。

removeSignFileList ​

删除电子签名注释列表中保存的签名。

返回一个 Promise。

名称类型描述
resultboolean如果删除成功，返回 true，否则返回 false。
tsx
ComPDFKit.removeSignFileList();