跳到主要内容

QiTechWebOCR.WebOCR() 构造函数

.WebOCR 方法负责配置您的文档检查组件实例。此方法具有以下配置选项。

名称描述必填
htmlComponent将承载 SDK HTML 的父 HTML 组件。
webToken标识所收集数据来自您应用的客户密钥。如果您尚未收到 web-token,请联系支持团队
sessionId用于定义在 SDK 中启动会话的标识密钥。用于通过日志跟踪用户在 Web OCR 执行过程中的完整流程。此字段接受最多 255 个字符的字符串。每个会话必须唯一。
.setThemeConfiguration(object)用于自定义 WebOCR 元素组件视觉标识的方法。
.setShowInstructionScreen(boolean)用于渲染带有所选文档采集提示的介绍界面的方法。接受 true 或 false。如未使用,默认值为 true。
.setShowSuccessScreen(boolean)用于在采集流程结束时渲染成功界面的方法。接受 true 或 false。如未使用,默认值为 true。
.setSandboxEnvironment()用于将环境配置为沙盒模式的方法。如未使用,默认值为 Production。

.setThemeConfiguration 方法应接受包含以下字段的对象:

名称类型描述
companyLogoString(推荐) 您公司徽标资源的路径或公开 URLPNG)。如未提供,默认为占位符。
buttonColorString(推荐) 界面按钮颜色的十六进制值。如未提供,默认为 #1C49AD。
fontColorString(推荐) 界面显示文本颜色的十六进制值。如未提供,默认为 #FCFCFC。
backgroundColorString(推荐) 界面背景颜色的十六进制值。如未提供,默认为 #1C49AD。
fontFamilyString(推荐) 要配置到 SDK 文本中的 Font Family 名称。如未提供,将配置默认字体。