Class: TencentCloud::Essbasic::V20210526::Component

Inherits:

Common::AbstractModel

• Object
• Common::AbstractModel
• TencentCloud::Essbasic::V20210526::Component

Defined in:

lib/v20210526/models.rb

Overview

在通过文件发起合同时，对应的component有三种定位方式

1. 绝对定位方式 （可以通过 PDF坐标计算助手计算控件的坐标）
2. 表单域(FIELD)定位方式
3. 关键字(KEYWORD)定位方式，使用关键字定位时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找

Instance Attribute Summary

• #ChannelComponentId ⇒ Object
• #ComponentDateFontSize ⇒ Object
• #ComponentDescription ⇒ Object
• #ComponentExtra ⇒ Object
• #ComponentHeight ⇒ Object
• #ComponentId ⇒ Object
• #ComponentName ⇒ Object
• #ComponentPage ⇒ Object
• #ComponentPosX ⇒ Object
• #ComponentPosY ⇒ Object
• #ComponentRecipientId ⇒ Object
• #ComponentRequired ⇒ Object
• #ComponentType ⇒ Object
• #ComponentValue ⇒ Object
• #ComponentWidth ⇒ Object
• #DocumentId ⇒ Object
• #FileIndex ⇒ Object
• #ForbidMoveAndDelete ⇒ Object
• #GenerateMode ⇒ Object
• #KeywordIndexes ⇒ Object
• #KeywordOrder ⇒ Object
• #KeywordPage ⇒ Object
• #LockComponentValue ⇒ Object
• #OffsetX ⇒ Object
• #OffsetY ⇒ Object
• #Placeholder ⇒ Object
• #RelativeLocation ⇒ Object

Instance Method Summary

• #deserialize(params) ⇒ Object
• #initialize(componentid = nil, componenttype = nil, componentname = nil, componentrequired = nil, componentrecipientid = nil, fileindex = nil, generatemode = nil, componentwidth = nil, componentheight = nil, componentpage = nil, componentposx = nil, componentposy = nil, componentextra = nil, componentvalue = nil, componentdatefontsize = nil, documentid = nil, componentdescription = nil, offsetx = nil, offsety = nil, channelcomponentid = nil, keywordorder = nil, keywordpage = nil, relativelocation = nil, keywordindexes = nil, placeholder = nil, lockcomponentvalue = nil, forbidmoveanddelete = nil) ⇒ Component constructor

  A new instance of Component.

Constructor Details

#initialize(componentid = nil, componenttype = nil, componentname = nil, componentrequired = nil, componentrecipientid = nil, fileindex = nil, generatemode = nil, componentwidth = nil, componentheight = nil, componentpage = nil, componentposx = nil, componentposy = nil, componentextra = nil, componentvalue = nil, componentdatefontsize = nil, documentid = nil, componentdescription = nil, offsetx = nil, offsety = nil, channelcomponentid = nil, keywordorder = nil, keywordpage = nil, relativelocation = nil, keywordindexes = nil, placeholder = nil, lockcomponentvalue = nil, forbidmoveanddelete = nil) ⇒ Component

Returns a new instance of Component.

# File 'lib/v20210526/models.rb', line 5331

def initialize(componentid=nil, componenttype=nil, componentname=nil, componentrequired=nil, componentrecipientid=nil, fileindex=nil, generatemode=nil, componentwidth=nil, componentheight=nil, componentpage=nil, componentposx=nil, componentposy=nil, componentextra=nil, componentvalue=nil, componentdatefontsize=nil, documentid=nil, componentdescription=nil, offsetx=nil, offsety=nil, channelcomponentid=nil, keywordorder=nil, keywordpage=nil, relativelocation=nil, keywordindexes=nil, placeholder=nil, lockcomponentvalue=nil, forbidmoveanddelete=nil)
  @ComponentId = componentid
  @ComponentType = componenttype
  @ComponentName = componentname
  @ComponentRequired = componentrequired
  @ComponentRecipientId = componentrecipientid
  @FileIndex = fileindex
  @GenerateMode = generatemode
  @ComponentWidth = componentwidth
  @ComponentHeight = componentheight
  @ComponentPage = componentpage
  @ComponentPosX = componentposx
  @ComponentPosY = componentposy
  @ComponentExtra = componentextra
  @ComponentValue = componentvalue
  @ComponentDateFontSize = componentdatefontsize
  @DocumentId = documentid
  @ComponentDescription = componentdescription
  @OffsetX = offsetx
  @OffsetY = offsety
  @ChannelComponentId = channelcomponentid
  @KeywordOrder = keywordorder
  @KeywordPage = keywordpage
  @RelativeLocation = relativelocation
  @KeywordIndexes = keywordindexes
  @Placeholder = placeholder
  @LockComponentValue = lockcomponentvalue
  @ForbidMoveAndDelete = forbidmoveanddelete
end

Instance Attribute Details

#ChannelComponentId ⇒ Object

Parameters:

• ComponentId: (p) —

  控件唯一ID。

  在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

  例：

  • 如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。
  • 如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。

  注：控件ID可以在一个PDF中不可重复
  点击查看ComponentId在模板页面的位置

• ComponentType: (p) —

  如果是Component填写控件类型，则可选的字段为：

  • TEXT : 普通文本控件，输入文本字符串；
  • MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；
  • CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
  • FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；
  • DYNAMIC_TABLE : 动态表格控件；
  • ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
  • SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；
  • DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；
  • DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
  • VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容

  如果是SignComponent签署控件类型，
  需要根据签署人的类型可选的字段为

  • 企业方
    • SIGN_SEAL : 签署印章控件；
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
    • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。

  • 个人方
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择

  注：表单域的控件不能作为印章和签名控件

• ComponentName: (p) —

  在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。

  注：控件名可以在一个PDF中可以重复

  点击查看ComponentName在模板页面的位置

• ComponentRequired: (p) —

  如果是填写控件，ComponentRequired表示在填写页面此控件是否必填

  • false（默认）：可以不填写
  • true ：必须填写此填写控件

  如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响

• ComponentRecipientId: (p) —

  在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可

• FileIndex: (p) —

  【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0

• GenerateMode: (p) —

  控件生成的方式：

  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）

• ComponentWidth: (p) —

  在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。

• ComponentHeight: (p) —

  在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。

• ComponentPage: (p) —

  在绝对定位方式方式下，指定控件所在PDF文件上的页码
  在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。

  注：

  1. 页码编号是从1开始编号的。
  2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。

• ComponentPosX: (p) —

  在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。

• ComponentPosY: (p) —

  在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。

• ComponentExtra: (p) —

  在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。

  ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • FontAlign： Left/Right/Center，左对齐/居中/右对齐
  • FontColor：字符串类型，格式为RGB颜色数字
  • Bold是否加粗：true/false

  参数样例：{"FontColor":"255,0,0","FontSize":12,"Bold":false}

  ComponentType为DATE时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72

  参数样例：{"FontColor":"255,0,0","FontSize":12}

  ComponentType为WATERMARK时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • Opacity： 透明度，范围0 :1
  • Rotate： 水印旋转角度，范围0 :359
  • Density： 水印样式，1-宽松，2-标准（默认值），3-密集，
  • Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中
  • SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息

  参数样例："{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"

  ComponentType为FILL_IMAGE时，支持以下参数：

  • NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中
  • FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放

  ComponentType为SELECTOR时，支持以下参数：

  • WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成

  ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以ComponentTypeLimit参数控制签署方式

  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

  参考样例：{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}印章的对应关系参考下图
  
  ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型，支持指定以下印章类型

  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章
  • OTHER : 其他

  参考样例：{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。
  
  

  ComponentType为SIGN_DATE时，支持以下参数：

  • Font :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"
  • FontSize : 数字类型，范围6-72，默认值为12
  • FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
  • Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
  • Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数

  如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"

  ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：

  • PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）

  参数样例："{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"

  签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时，可以通过以下参数设置签署图片的旋转角度：

  • Rotate：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。
  • RotateRelation：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。

  参数样例：{"Rotate":-30,"RotateRelation":"Component_Id1"}

  签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：

  • Opacity：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度

  参数样例：{"Opacity":0.7}

  签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：

  • UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false

  参数样例：{"UseSealSize":true}

  签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：

  • Values：签署意见预设的需要用户填写的文本
  • ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）

  参数样例：{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}

  关键字模式下支持关键字找不到的情况下不进行报错的设置

  • IgnoreKeywordError :1-关键字查找不到时不进行报错

  场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例："{"IgnoreKeywordError":1}"

  ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：

  • Children: 绝对定位模式下，用来指定此签批控件的组合子控件
  参数样例：
  {"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}
  • ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件
  ChildrenComponent结构体定义:

  字段名称	类型	描述
  ComponentType	string	子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT
  ComponentName	string	子控件名称
  Placeholder	string	子控件提示语
  ComponentValue	string	子控件值（签署方不可设置）
  ComponentOffsetX	float	控件偏移位置X（相对于父控件（签批控件的ComponentX））
  ComponentOffsetY	float	控件偏移位置Y 相对于父控件（签批控件的ComponentY））
  ComponentWidth	float	控件宽
  ComponentHeight	float	控件高
  ComponentExtra	string	控件的附属信息，根据ComponentType设置

  参数样例：

  {    "ChildrenComponents": [        {            "ComponentType": "SIGN_SIGNATURE",            "ComponentName": "个人签名",            "Placeholder": "请签名",            "ComponentOffsetX": 10,            "ComponentOffsetY": 30,            "ComponentWidth": 119,            "ComponentHeight": 43,            "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"        },        {            "ComponentType": "SIGN_SELECTOR",            "ComponentName": "是否同意此协议",            "Placeholder": "",            "ComponentOffsetX": 50,            "ComponentOffsetY": 130,            "ComponentWidth": 120,            "ComponentHeight": 43,            "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"        },        {            "ComponentType": "SIGN_MULTI_LINE_TEXT",            "ComponentName": "批注附言",            "Placeholder": "",            "ComponentOffsetX": 150,            "ComponentOffsetY": 300,            "ComponentWidth": 200,            "ComponentHeight": 86,            "ComponentExtra": ""        }    ]}

• ComponentValue: (p) —

  控件填充vaule，ComponentType和传入值类型对应关系：

  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
  • DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
  • SIGN_SEAL : 印章ID，于控制台查询获取，点击查看在控制上的位置
  • SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取，点击查看在控制上的位置

  控件值约束说明：

  特殊控件	填写约束
  企业全称控件	企业名称中文字符中文括号
  统一社会信用代码控件	企业注册的统一社会信用代码
  法人名称控件	最大50个字符，2到25个汉字或者1到50个字母
  签署意见控件	签署意见最大长度为50字符
  签署人手机号控件	国内手机号 13,14,15,16,17,18,19号段长度11位
  签署人身份证控件	合法的身份证号码检查
  控件名称	控件名称最大长度为20字符，不支持表情
  单行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  多行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  勾选框控件	选择填字符串true，不选填字符串false
  选择器控件	同单行文本控件约束，填写选择值中的字符串
  数字控件	请输入有效的数字(可带小数点)
  日期控件	格式：yyyy年mm月dd日
  附件控件	JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID
  图片控件	JPG或PNG图片，填写上传的图片资源ID
  邮箱控件	有效的邮箱地址, w3c标准
  地址控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  省市区控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  性别控件	选择值中的字符串
  学历控件	选择值中的字符串
  水印控件	水印控件设置为CUSTOM_WATERMARK类型时的水印内容

  注： 部分特殊控件需要在控制台配置模板形式创建

• ComponentDateFontSize: (p) —

  【暂未使用】日期签署控件的字号，默认为 12

• DocumentId: (p) —

  【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可

• ComponentDescription: (p) —

  【暂未使用】控件描述，用户自定义，不影响合同发起流程

• OffsetX: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
  注意： 向左调整设置为负数， 向右调整设置成正数

• OffsetY: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
  注意： 向上调整设置为负数， 向下调整设置成正数

• ChannelComponentId: (p) —

  【暂未使用】第三方应用集成平台模板控件 ID 标识

• KeywordOrder: (p) —

  如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。

  • Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列
  • Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列

  在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。

• KeywordPage: (p) —

  如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。

• RelativeLocation: (p) —

  如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值

  • Middle :居中
  • Below :正下方
  • Right :正右方
  • LowerRight :右下角
  • UpperRight :右上角。

  示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方

• KeywordIndexes: (p) —

  如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

  注意：关键字索引是从0开始计数的

• Placeholder: (p) —

  填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
  注：签署控件设置此字段无效

• LockComponentValue: (p) —

  web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑

  • false（默认）：不锁定控件值，允许在页面编辑控件值
  • true：锁定控件值，在页面无法编辑控件值

• ForbidMoveAndDelete: (p) —

  web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件

  • false（默认） :可以移动和删除控件
  • true : 禁止移动和删除控件

# File 'lib/v20210526/models.rb', line 5329

def ChannelComponentId
  @ChannelComponentId
end

#ComponentDateFontSize ⇒ Object

Parameters:

• ComponentId: (p) —

  控件唯一ID。

  在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

  例：

  • 如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。
  • 如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。

  注：控件ID可以在一个PDF中不可重复
  点击查看ComponentId在模板页面的位置

• ComponentType: (p) —

  如果是Component填写控件类型，则可选的字段为：

  • TEXT : 普通文本控件，输入文本字符串；
  • MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；
  • CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
  • FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；
  • DYNAMIC_TABLE : 动态表格控件；
  • ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
  • SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；
  • DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；
  • DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
  • VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容

  如果是SignComponent签署控件类型，
  需要根据签署人的类型可选的字段为

  • 企业方
    • SIGN_SEAL : 签署印章控件；
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
    • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。

  • 个人方
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择

  注：表单域的控件不能作为印章和签名控件

• ComponentName: (p) —

  在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。

  注：控件名可以在一个PDF中可以重复

  点击查看ComponentName在模板页面的位置

• ComponentRequired: (p) —

  如果是填写控件，ComponentRequired表示在填写页面此控件是否必填

  • false（默认）：可以不填写
  • true ：必须填写此填写控件

  如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响

• ComponentRecipientId: (p) —

  在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可

• FileIndex: (p) —

  【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0

• GenerateMode: (p) —

  控件生成的方式：

  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）

• ComponentWidth: (p) —

  在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。

• ComponentHeight: (p) —

  在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。

• ComponentPage: (p) —

  在绝对定位方式方式下，指定控件所在PDF文件上的页码
  在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。

  注：

  1. 页码编号是从1开始编号的。
  2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。

• ComponentPosX: (p) —

  在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。

• ComponentPosY: (p) —

  在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。

• ComponentExtra: (p) —

  在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。

  ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • FontAlign： Left/Right/Center，左对齐/居中/右对齐
  • FontColor：字符串类型，格式为RGB颜色数字
  • Bold是否加粗：true/false

  参数样例：{"FontColor":"255,0,0","FontSize":12,"Bold":false}

  ComponentType为DATE时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72

  参数样例：{"FontColor":"255,0,0","FontSize":12}

  ComponentType为WATERMARK时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • Opacity： 透明度，范围0 :1
  • Rotate： 水印旋转角度，范围0 :359
  • Density： 水印样式，1-宽松，2-标准（默认值），3-密集，
  • Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中
  • SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息

  参数样例："{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"

  ComponentType为FILL_IMAGE时，支持以下参数：

  • NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中
  • FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放

  ComponentType为SELECTOR时，支持以下参数：

  • WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成

  ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以ComponentTypeLimit参数控制签署方式

  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

  参考样例：{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}印章的对应关系参考下图
  
  ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型，支持指定以下印章类型

  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章
  • OTHER : 其他

  参考样例：{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。
  
  

  ComponentType为SIGN_DATE时，支持以下参数：

  • Font :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"
  • FontSize : 数字类型，范围6-72，默认值为12
  • FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
  • Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
  • Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数

  如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"

  ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：

  • PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）

  参数样例："{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"

  签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时，可以通过以下参数设置签署图片的旋转角度：

  • Rotate：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。
  • RotateRelation：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。

  参数样例：{"Rotate":-30,"RotateRelation":"Component_Id1"}

  签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：

  • Opacity：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度

  参数样例：{"Opacity":0.7}

  签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：

  • UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false

  参数样例：{"UseSealSize":true}

  签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：

  • Values：签署意见预设的需要用户填写的文本
  • ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）

  参数样例：{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}

  关键字模式下支持关键字找不到的情况下不进行报错的设置

  • IgnoreKeywordError :1-关键字查找不到时不进行报错

  场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例："{"IgnoreKeywordError":1}"

  ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：

  • Children: 绝对定位模式下，用来指定此签批控件的组合子控件
  参数样例：
  {"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}
  • ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件
  ChildrenComponent结构体定义:

  字段名称	类型	描述
  ComponentType	string	子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT
  ComponentName	string	子控件名称
  Placeholder	string	子控件提示语
  ComponentValue	string	子控件值（签署方不可设置）
  ComponentOffsetX	float	控件偏移位置X（相对于父控件（签批控件的ComponentX））
  ComponentOffsetY	float	控件偏移位置Y 相对于父控件（签批控件的ComponentY））
  ComponentWidth	float	控件宽
  ComponentHeight	float	控件高
  ComponentExtra	string	控件的附属信息，根据ComponentType设置

  参数样例：

  {    "ChildrenComponents": [        {            "ComponentType": "SIGN_SIGNATURE",            "ComponentName": "个人签名",            "Placeholder": "请签名",            "ComponentOffsetX": 10,            "ComponentOffsetY": 30,            "ComponentWidth": 119,            "ComponentHeight": 43,            "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"        },        {            "ComponentType": "SIGN_SELECTOR",            "ComponentName": "是否同意此协议",            "Placeholder": "",            "ComponentOffsetX": 50,            "ComponentOffsetY": 130,            "ComponentWidth": 120,            "ComponentHeight": 43,            "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"        },        {            "ComponentType": "SIGN_MULTI_LINE_TEXT",            "ComponentName": "批注附言",            "Placeholder": "",            "ComponentOffsetX": 150,            "ComponentOffsetY": 300,            "ComponentWidth": 200,            "ComponentHeight": 86,            "ComponentExtra": ""        }    ]}

• ComponentValue: (p) —

  控件填充vaule，ComponentType和传入值类型对应关系：

  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
  • DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
  • SIGN_SEAL : 印章ID，于控制台查询获取，点击查看在控制上的位置
  • SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取，点击查看在控制上的位置

  控件值约束说明：

  特殊控件	填写约束
  企业全称控件	企业名称中文字符中文括号
  统一社会信用代码控件	企业注册的统一社会信用代码
  法人名称控件	最大50个字符，2到25个汉字或者1到50个字母
  签署意见控件	签署意见最大长度为50字符
  签署人手机号控件	国内手机号 13,14,15,16,17,18,19号段长度11位
  签署人身份证控件	合法的身份证号码检查
  控件名称	控件名称最大长度为20字符，不支持表情
  单行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  多行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  勾选框控件	选择填字符串true，不选填字符串false
  选择器控件	同单行文本控件约束，填写选择值中的字符串
  数字控件	请输入有效的数字(可带小数点)
  日期控件	格式：yyyy年mm月dd日
  附件控件	JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID
  图片控件	JPG或PNG图片，填写上传的图片资源ID
  邮箱控件	有效的邮箱地址, w3c标准
  地址控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  省市区控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  性别控件	选择值中的字符串
  学历控件	选择值中的字符串
  水印控件	水印控件设置为CUSTOM_WATERMARK类型时的水印内容

  注： 部分特殊控件需要在控制台配置模板形式创建

• ComponentDateFontSize: (p) —

  【暂未使用】日期签署控件的字号，默认为 12

• DocumentId: (p) —

  【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可

• ComponentDescription: (p) —

  【暂未使用】控件描述，用户自定义，不影响合同发起流程

• OffsetX: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
  注意： 向左调整设置为负数， 向右调整设置成正数

• OffsetY: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
  注意： 向上调整设置为负数， 向下调整设置成正数

• ChannelComponentId: (p) —

  【暂未使用】第三方应用集成平台模板控件 ID 标识

• KeywordOrder: (p) —

  如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。

  • Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列
  • Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列

  在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。

• KeywordPage: (p) —

  如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。

• RelativeLocation: (p) —

  如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值

  • Middle :居中
  • Below :正下方
  • Right :正右方
  • LowerRight :右下角
  • UpperRight :右上角。

  示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方

• KeywordIndexes: (p) —

  如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

  注意：关键字索引是从0开始计数的

• Placeholder: (p) —

  填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
  注：签署控件设置此字段无效

• LockComponentValue: (p) —

  web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑

  • false（默认）：不锁定控件值，允许在页面编辑控件值
  • true：锁定控件值，在页面无法编辑控件值

• ForbidMoveAndDelete: (p) —

  web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件

  • false（默认） :可以移动和删除控件
  • true : 禁止移动和删除控件

# File 'lib/v20210526/models.rb', line 5329

def ComponentDateFontSize
  @ComponentDateFontSize
end

#ComponentDescription ⇒ Object

Parameters:

• ComponentId: (p) —

  控件唯一ID。

  在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

  例：

  • 如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。
  • 如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。

  注：控件ID可以在一个PDF中不可重复
  点击查看ComponentId在模板页面的位置

• ComponentType: (p) —

  如果是Component填写控件类型，则可选的字段为：

  • TEXT : 普通文本控件，输入文本字符串；
  • MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；
  • CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
  • FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；
  • DYNAMIC_TABLE : 动态表格控件；
  • ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
  • SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；
  • DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；
  • DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
  • VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容

  如果是SignComponent签署控件类型，
  需要根据签署人的类型可选的字段为

  • 企业方
    • SIGN_SEAL : 签署印章控件；
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
    • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。

  • 个人方
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择

  注：表单域的控件不能作为印章和签名控件

• ComponentName: (p) —

  在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。

  注：控件名可以在一个PDF中可以重复

  点击查看ComponentName在模板页面的位置

• ComponentRequired: (p) —

  如果是填写控件，ComponentRequired表示在填写页面此控件是否必填

  • false（默认）：可以不填写
  • true ：必须填写此填写控件

  如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响

• ComponentRecipientId: (p) —

  在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可

• FileIndex: (p) —

  【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0

• GenerateMode: (p) —

  控件生成的方式：

  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）

• ComponentWidth: (p) —

  在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。

• ComponentHeight: (p) —

  在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。

• ComponentPage: (p) —

  在绝对定位方式方式下，指定控件所在PDF文件上的页码
  在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。

  注：

  1. 页码编号是从1开始编号的。
  2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。

• ComponentPosX: (p) —

  在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。

• ComponentPosY: (p) —

  在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。

• ComponentExtra: (p) —

  在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。

  ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • FontAlign： Left/Right/Center，左对齐/居中/右对齐
  • FontColor：字符串类型，格式为RGB颜色数字
  • Bold是否加粗：true/false

  参数样例：{"FontColor":"255,0,0","FontSize":12,"Bold":false}

  ComponentType为DATE时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72

  参数样例：{"FontColor":"255,0,0","FontSize":12}

  ComponentType为WATERMARK时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • Opacity： 透明度，范围0 :1
  • Rotate： 水印旋转角度，范围0 :359
  • Density： 水印样式，1-宽松，2-标准（默认值），3-密集，
  • Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中
  • SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息

  参数样例："{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"

  ComponentType为FILL_IMAGE时，支持以下参数：

  • NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中
  • FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放

  ComponentType为SELECTOR时，支持以下参数：

  • WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成

  ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以ComponentTypeLimit参数控制签署方式

  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

  参考样例：{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}印章的对应关系参考下图
  
  ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型，支持指定以下印章类型

  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章
  • OTHER : 其他

  参考样例：{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。
  
  

  ComponentType为SIGN_DATE时，支持以下参数：

  • Font :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"
  • FontSize : 数字类型，范围6-72，默认值为12
  • FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
  • Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
  • Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数

  如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"

  ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：

  • PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）

  参数样例："{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"

  签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时，可以通过以下参数设置签署图片的旋转角度：

  • Rotate：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。
  • RotateRelation：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。

  参数样例：{"Rotate":-30,"RotateRelation":"Component_Id1"}

  签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：

  • Opacity：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度

  参数样例：{"Opacity":0.7}

  签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：

  • UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false

  参数样例：{"UseSealSize":true}

  签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：

  • Values：签署意见预设的需要用户填写的文本
  • ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）

  参数样例：{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}

  关键字模式下支持关键字找不到的情况下不进行报错的设置

  • IgnoreKeywordError :1-关键字查找不到时不进行报错

  场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例："{"IgnoreKeywordError":1}"

  ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：

  • Children: 绝对定位模式下，用来指定此签批控件的组合子控件
  参数样例：
  {"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}
  • ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件
  ChildrenComponent结构体定义:

  字段名称	类型	描述
  ComponentType	string	子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT
  ComponentName	string	子控件名称
  Placeholder	string	子控件提示语
  ComponentValue	string	子控件值（签署方不可设置）
  ComponentOffsetX	float	控件偏移位置X（相对于父控件（签批控件的ComponentX））
  ComponentOffsetY	float	控件偏移位置Y 相对于父控件（签批控件的ComponentY））
  ComponentWidth	float	控件宽
  ComponentHeight	float	控件高
  ComponentExtra	string	控件的附属信息，根据ComponentType设置

  参数样例：

  {    "ChildrenComponents": [        {            "ComponentType": "SIGN_SIGNATURE",            "ComponentName": "个人签名",            "Placeholder": "请签名",            "ComponentOffsetX": 10,            "ComponentOffsetY": 30,            "ComponentWidth": 119,            "ComponentHeight": 43,            "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"        },        {            "ComponentType": "SIGN_SELECTOR",            "ComponentName": "是否同意此协议",            "Placeholder": "",            "ComponentOffsetX": 50,            "ComponentOffsetY": 130,            "ComponentWidth": 120,            "ComponentHeight": 43,            "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"        },        {            "ComponentType": "SIGN_MULTI_LINE_TEXT",            "ComponentName": "批注附言",            "Placeholder": "",            "ComponentOffsetX": 150,            "ComponentOffsetY": 300,            "ComponentWidth": 200,            "ComponentHeight": 86,            "ComponentExtra": ""        }    ]}

• ComponentValue: (p) —

  控件填充vaule，ComponentType和传入值类型对应关系：

  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
  • DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
  • SIGN_SEAL : 印章ID，于控制台查询获取，点击查看在控制上的位置
  • SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取，点击查看在控制上的位置

  控件值约束说明：

  特殊控件	填写约束
  企业全称控件	企业名称中文字符中文括号
  统一社会信用代码控件	企业注册的统一社会信用代码
  法人名称控件	最大50个字符，2到25个汉字或者1到50个字母
  签署意见控件	签署意见最大长度为50字符
  签署人手机号控件	国内手机号 13,14,15,16,17,18,19号段长度11位
  签署人身份证控件	合法的身份证号码检查
  控件名称	控件名称最大长度为20字符，不支持表情
  单行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  多行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  勾选框控件	选择填字符串true，不选填字符串false
  选择器控件	同单行文本控件约束，填写选择值中的字符串
  数字控件	请输入有效的数字(可带小数点)
  日期控件	格式：yyyy年mm月dd日
  附件控件	JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID
  图片控件	JPG或PNG图片，填写上传的图片资源ID
  邮箱控件	有效的邮箱地址, w3c标准
  地址控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  省市区控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  性别控件	选择值中的字符串
  学历控件	选择值中的字符串
  水印控件	水印控件设置为CUSTOM_WATERMARK类型时的水印内容

  注： 部分特殊控件需要在控制台配置模板形式创建

• ComponentDateFontSize: (p) —

  【暂未使用】日期签署控件的字号，默认为 12

• DocumentId: (p) —

  【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可

• ComponentDescription: (p) —

  【暂未使用】控件描述，用户自定义，不影响合同发起流程

• OffsetX: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
  注意： 向左调整设置为负数， 向右调整设置成正数

• OffsetY: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
  注意： 向上调整设置为负数， 向下调整设置成正数

• ChannelComponentId: (p) —

  【暂未使用】第三方应用集成平台模板控件 ID 标识

• KeywordOrder: (p) —

  如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。

  • Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列
  • Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列

  在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。

• KeywordPage: (p) —

  如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。

• RelativeLocation: (p) —

  如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值

  • Middle :居中
  • Below :正下方
  • Right :正右方
  • LowerRight :右下角
  • UpperRight :右上角。

  示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方

• KeywordIndexes: (p) —

  如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

  注意：关键字索引是从0开始计数的

• Placeholder: (p) —

  填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
  注：签署控件设置此字段无效

• LockComponentValue: (p) —

  web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑

  • false（默认）：不锁定控件值，允许在页面编辑控件值
  • true：锁定控件值，在页面无法编辑控件值

• ForbidMoveAndDelete: (p) —

  web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件

  • false（默认） :可以移动和删除控件
  • true : 禁止移动和删除控件

# File 'lib/v20210526/models.rb', line 5329

def ComponentDescription
  @ComponentDescription
end

#ComponentExtra ⇒ Object

Parameters:

• ComponentId: (p) —

  控件唯一ID。

  在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

  例：

  • 如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。
  • 如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。

  注：控件ID可以在一个PDF中不可重复
  点击查看ComponentId在模板页面的位置

• ComponentType: (p) —

  如果是Component填写控件类型，则可选的字段为：

  • TEXT : 普通文本控件，输入文本字符串；
  • MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；
  • CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
  • FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；
  • DYNAMIC_TABLE : 动态表格控件；
  • ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
  • SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；
  • DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；
  • DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
  • VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容

  如果是SignComponent签署控件类型，
  需要根据签署人的类型可选的字段为

  • 企业方
    • SIGN_SEAL : 签署印章控件；
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
    • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。

  • 个人方
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择

  注：表单域的控件不能作为印章和签名控件

• ComponentName: (p) —

  在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。

  注：控件名可以在一个PDF中可以重复

  点击查看ComponentName在模板页面的位置

• ComponentRequired: (p) —

  如果是填写控件，ComponentRequired表示在填写页面此控件是否必填

  • false（默认）：可以不填写
  • true ：必须填写此填写控件

  如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响

• ComponentRecipientId: (p) —

  在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可

• FileIndex: (p) —

  【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0

• GenerateMode: (p) —

  控件生成的方式：

  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）

• ComponentWidth: (p) —

  在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。

• ComponentHeight: (p) —

  在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。

• ComponentPage: (p) —

  在绝对定位方式方式下，指定控件所在PDF文件上的页码
  在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。

  注：

  1. 页码编号是从1开始编号的。
  2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。

• ComponentPosX: (p) —

  在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。

• ComponentPosY: (p) —

  在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。

• ComponentExtra: (p) —

  在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。

  ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • FontAlign： Left/Right/Center，左对齐/居中/右对齐
  • FontColor：字符串类型，格式为RGB颜色数字
  • Bold是否加粗：true/false

  参数样例：{"FontColor":"255,0,0","FontSize":12,"Bold":false}

  ComponentType为DATE时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72

  参数样例：{"FontColor":"255,0,0","FontSize":12}

  ComponentType为WATERMARK时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • Opacity： 透明度，范围0 :1
  • Rotate： 水印旋转角度，范围0 :359
  • Density： 水印样式，1-宽松，2-标准（默认值），3-密集，
  • Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中
  • SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息

  参数样例："{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"

  ComponentType为FILL_IMAGE时，支持以下参数：

  • NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中
  • FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放

  ComponentType为SELECTOR时，支持以下参数：

  • WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成

  ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以ComponentTypeLimit参数控制签署方式

  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

  参考样例：{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}印章的对应关系参考下图
  
  ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型，支持指定以下印章类型

  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章
  • OTHER : 其他

  参考样例：{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。
  
  

  ComponentType为SIGN_DATE时，支持以下参数：

  • Font :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"
  • FontSize : 数字类型，范围6-72，默认值为12
  • FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
  • Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
  • Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数

  如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"

  ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：

  • PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）

  参数样例："{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"

  签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时，可以通过以下参数设置签署图片的旋转角度：

  • Rotate：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。
  • RotateRelation：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。

  参数样例：{"Rotate":-30,"RotateRelation":"Component_Id1"}

  签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：

  • Opacity：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度

  参数样例：{"Opacity":0.7}

  签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：

  • UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false

  参数样例：{"UseSealSize":true}

  签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：

  • Values：签署意见预设的需要用户填写的文本
  • ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）

  参数样例：{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}

  关键字模式下支持关键字找不到的情况下不进行报错的设置

  • IgnoreKeywordError :1-关键字查找不到时不进行报错

  场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例："{"IgnoreKeywordError":1}"

  ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：

  • Children: 绝对定位模式下，用来指定此签批控件的组合子控件
  参数样例：
  {"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}
  • ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件
  ChildrenComponent结构体定义:

  字段名称	类型	描述
  ComponentType	string	子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT
  ComponentName	string	子控件名称
  Placeholder	string	子控件提示语
  ComponentValue	string	子控件值（签署方不可设置）
  ComponentOffsetX	float	控件偏移位置X（相对于父控件（签批控件的ComponentX））
  ComponentOffsetY	float	控件偏移位置Y 相对于父控件（签批控件的ComponentY））
  ComponentWidth	float	控件宽
  ComponentHeight	float	控件高
  ComponentExtra	string	控件的附属信息，根据ComponentType设置

  参数样例：

  {    "ChildrenComponents": [        {            "ComponentType": "SIGN_SIGNATURE",            "ComponentName": "个人签名",            "Placeholder": "请签名",            "ComponentOffsetX": 10,            "ComponentOffsetY": 30,            "ComponentWidth": 119,            "ComponentHeight": 43,            "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"        },        {            "ComponentType": "SIGN_SELECTOR",            "ComponentName": "是否同意此协议",            "Placeholder": "",            "ComponentOffsetX": 50,            "ComponentOffsetY": 130,            "ComponentWidth": 120,            "ComponentHeight": 43,            "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"        },        {            "ComponentType": "SIGN_MULTI_LINE_TEXT",            "ComponentName": "批注附言",            "Placeholder": "",            "ComponentOffsetX": 150,            "ComponentOffsetY": 300,            "ComponentWidth": 200,            "ComponentHeight": 86,            "ComponentExtra": ""        }    ]}

• ComponentValue: (p) —

  控件填充vaule，ComponentType和传入值类型对应关系：

  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
  • DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
  • SIGN_SEAL : 印章ID，于控制台查询获取，点击查看在控制上的位置
  • SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取，点击查看在控制上的位置

  控件值约束说明：

  特殊控件	填写约束
  企业全称控件	企业名称中文字符中文括号
  统一社会信用代码控件	企业注册的统一社会信用代码
  法人名称控件	最大50个字符，2到25个汉字或者1到50个字母
  签署意见控件	签署意见最大长度为50字符
  签署人手机号控件	国内手机号 13,14,15,16,17,18,19号段长度11位
  签署人身份证控件	合法的身份证号码检查
  控件名称	控件名称最大长度为20字符，不支持表情
  单行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  多行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  勾选框控件	选择填字符串true，不选填字符串false
  选择器控件	同单行文本控件约束，填写选择值中的字符串
  数字控件	请输入有效的数字(可带小数点)
  日期控件	格式：yyyy年mm月dd日
  附件控件	JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID
  图片控件	JPG或PNG图片，填写上传的图片资源ID
  邮箱控件	有效的邮箱地址, w3c标准
  地址控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  省市区控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  性别控件	选择值中的字符串
  学历控件	选择值中的字符串
  水印控件	水印控件设置为CUSTOM_WATERMARK类型时的水印内容

  注： 部分特殊控件需要在控制台配置模板形式创建

• ComponentDateFontSize: (p) —

  【暂未使用】日期签署控件的字号，默认为 12

• DocumentId: (p) —

  【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可

• ComponentDescription: (p) —

  【暂未使用】控件描述，用户自定义，不影响合同发起流程

• OffsetX: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
  注意： 向左调整设置为负数， 向右调整设置成正数

• OffsetY: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
  注意： 向上调整设置为负数， 向下调整设置成正数

• ChannelComponentId: (p) —

  【暂未使用】第三方应用集成平台模板控件 ID 标识

• KeywordOrder: (p) —

  如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。

  • Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列
  • Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列

  在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。

• KeywordPage: (p) —

  如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。

• RelativeLocation: (p) —

  如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值

  • Middle :居中
  • Below :正下方
  • Right :正右方
  • LowerRight :右下角
  • UpperRight :右上角。

  示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方

• KeywordIndexes: (p) —

  如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

  注意：关键字索引是从0开始计数的

• Placeholder: (p) —

  填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
  注：签署控件设置此字段无效

• LockComponentValue: (p) —

  web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑

  • false（默认）：不锁定控件值，允许在页面编辑控件值
  • true：锁定控件值，在页面无法编辑控件值

• ForbidMoveAndDelete: (p) —

  web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件

  • false（默认） :可以移动和删除控件
  • true : 禁止移动和删除控件

# File 'lib/v20210526/models.rb', line 5329

def ComponentExtra
  @ComponentExtra
end

#ComponentHeight ⇒ Object

Parameters:

• ComponentId: (p) —

  控件唯一ID。

  在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

  例：

  • 如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。
  • 如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。

  注：控件ID可以在一个PDF中不可重复
  点击查看ComponentId在模板页面的位置

• ComponentType: (p) —

  如果是Component填写控件类型，则可选的字段为：

  • TEXT : 普通文本控件，输入文本字符串；
  • MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；
  • CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
  • FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；
  • DYNAMIC_TABLE : 动态表格控件；
  • ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
  • SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；
  • DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；
  • DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
  • VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容

  如果是SignComponent签署控件类型，
  需要根据签署人的类型可选的字段为

  • 企业方
    • SIGN_SEAL : 签署印章控件；
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
    • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。

  • 个人方
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择

  注：表单域的控件不能作为印章和签名控件

• ComponentName: (p) —

  在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。

  注：控件名可以在一个PDF中可以重复

  点击查看ComponentName在模板页面的位置

• ComponentRequired: (p) —

  如果是填写控件，ComponentRequired表示在填写页面此控件是否必填

  • false（默认）：可以不填写
  • true ：必须填写此填写控件

  如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响

• ComponentRecipientId: (p) —

  在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可

• FileIndex: (p) —

  【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0

• GenerateMode: (p) —

  控件生成的方式：

  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）

• ComponentWidth: (p) —

  在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。

• ComponentHeight: (p) —

  在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。

• ComponentPage: (p) —

  在绝对定位方式方式下，指定控件所在PDF文件上的页码
  在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。

  注：

  1. 页码编号是从1开始编号的。
  2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。

• ComponentPosX: (p) —

  在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。

• ComponentPosY: (p) —

  在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。

• ComponentExtra: (p) —

  在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。

  ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • FontAlign： Left/Right/Center，左对齐/居中/右对齐
  • FontColor：字符串类型，格式为RGB颜色数字
  • Bold是否加粗：true/false

  参数样例：{"FontColor":"255,0,0","FontSize":12,"Bold":false}

  ComponentType为DATE时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72

  参数样例：{"FontColor":"255,0,0","FontSize":12}

  ComponentType为WATERMARK时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • Opacity： 透明度，范围0 :1
  • Rotate： 水印旋转角度，范围0 :359
  • Density： 水印样式，1-宽松，2-标准（默认值），3-密集，
  • Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中
  • SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息

  参数样例："{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"

  ComponentType为FILL_IMAGE时，支持以下参数：

  • NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中
  • FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放

  ComponentType为SELECTOR时，支持以下参数：

  • WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成

  ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以ComponentTypeLimit参数控制签署方式

  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

  参考样例：{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}印章的对应关系参考下图
  
  ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型，支持指定以下印章类型

  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章
  • OTHER : 其他

  参考样例：{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。
  
  

  ComponentType为SIGN_DATE时，支持以下参数：

  • Font :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"
  • FontSize : 数字类型，范围6-72，默认值为12
  • FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
  • Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
  • Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数

  如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"

  ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：

  • PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）

  参数样例："{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"

  签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时，可以通过以下参数设置签署图片的旋转角度：

  • Rotate：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。
  • RotateRelation：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。

  参数样例：{"Rotate":-30,"RotateRelation":"Component_Id1"}

  签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：

  • Opacity：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度

  参数样例：{"Opacity":0.7}

  签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：

  • UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false

  参数样例：{"UseSealSize":true}

  签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：

  • Values：签署意见预设的需要用户填写的文本
  • ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）

  参数样例：{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}

  关键字模式下支持关键字找不到的情况下不进行报错的设置

  • IgnoreKeywordError :1-关键字查找不到时不进行报错

  场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例："{"IgnoreKeywordError":1}"

  ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：

  • Children: 绝对定位模式下，用来指定此签批控件的组合子控件
  参数样例：
  {"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}
  • ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件
  ChildrenComponent结构体定义:

  字段名称	类型	描述
  ComponentType	string	子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT
  ComponentName	string	子控件名称
  Placeholder	string	子控件提示语
  ComponentValue	string	子控件值（签署方不可设置）
  ComponentOffsetX	float	控件偏移位置X（相对于父控件（签批控件的ComponentX））
  ComponentOffsetY	float	控件偏移位置Y 相对于父控件（签批控件的ComponentY））
  ComponentWidth	float	控件宽
  ComponentHeight	float	控件高
  ComponentExtra	string	控件的附属信息，根据ComponentType设置

  参数样例：

  {    "ChildrenComponents": [        {            "ComponentType": "SIGN_SIGNATURE",            "ComponentName": "个人签名",            "Placeholder": "请签名",            "ComponentOffsetX": 10,            "ComponentOffsetY": 30,            "ComponentWidth": 119,            "ComponentHeight": 43,            "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"        },        {            "ComponentType": "SIGN_SELECTOR",            "ComponentName": "是否同意此协议",            "Placeholder": "",            "ComponentOffsetX": 50,            "ComponentOffsetY": 130,            "ComponentWidth": 120,            "ComponentHeight": 43,            "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"        },        {            "ComponentType": "SIGN_MULTI_LINE_TEXT",            "ComponentName": "批注附言",            "Placeholder": "",            "ComponentOffsetX": 150,            "ComponentOffsetY": 300,            "ComponentWidth": 200,            "ComponentHeight": 86,            "ComponentExtra": ""        }    ]}

• ComponentValue: (p) —

  控件填充vaule，ComponentType和传入值类型对应关系：

  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
  • DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
  • SIGN_SEAL : 印章ID，于控制台查询获取，点击查看在控制上的位置
  • SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取，点击查看在控制上的位置

  控件值约束说明：

  特殊控件	填写约束
  企业全称控件	企业名称中文字符中文括号
  统一社会信用代码控件	企业注册的统一社会信用代码
  法人名称控件	最大50个字符，2到25个汉字或者1到50个字母
  签署意见控件	签署意见最大长度为50字符
  签署人手机号控件	国内手机号 13,14,15,16,17,18,19号段长度11位
  签署人身份证控件	合法的身份证号码检查
  控件名称	控件名称最大长度为20字符，不支持表情
  单行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  多行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  勾选框控件	选择填字符串true，不选填字符串false
  选择器控件	同单行文本控件约束，填写选择值中的字符串
  数字控件	请输入有效的数字(可带小数点)
  日期控件	格式：yyyy年mm月dd日
  附件控件	JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID
  图片控件	JPG或PNG图片，填写上传的图片资源ID
  邮箱控件	有效的邮箱地址, w3c标准
  地址控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  省市区控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  性别控件	选择值中的字符串
  学历控件	选择值中的字符串
  水印控件	水印控件设置为CUSTOM_WATERMARK类型时的水印内容

  注： 部分特殊控件需要在控制台配置模板形式创建

• ComponentDateFontSize: (p) —

  【暂未使用】日期签署控件的字号，默认为 12

• DocumentId: (p) —

  【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可

• ComponentDescription: (p) —

  【暂未使用】控件描述，用户自定义，不影响合同发起流程

• OffsetX: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
  注意： 向左调整设置为负数， 向右调整设置成正数

• OffsetY: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
  注意： 向上调整设置为负数， 向下调整设置成正数

• ChannelComponentId: (p) —

  【暂未使用】第三方应用集成平台模板控件 ID 标识

• KeywordOrder: (p) —

  如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。

  • Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列
  • Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列

  在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。

• KeywordPage: (p) —

  如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。

• RelativeLocation: (p) —

  如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值

  • Middle :居中
  • Below :正下方
  • Right :正右方
  • LowerRight :右下角
  • UpperRight :右上角。

  示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方

• KeywordIndexes: (p) —

  如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

  注意：关键字索引是从0开始计数的

• Placeholder: (p) —

  填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
  注：签署控件设置此字段无效

• LockComponentValue: (p) —

  web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑

  • false（默认）：不锁定控件值，允许在页面编辑控件值
  • true：锁定控件值，在页面无法编辑控件值

• ForbidMoveAndDelete: (p) —

  web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件

  • false（默认） :可以移动和删除控件
  • true : 禁止移动和删除控件

# File 'lib/v20210526/models.rb', line 5329

def ComponentHeight
  @ComponentHeight
end

#ComponentId ⇒ Object

Parameters:

• ComponentId: (p) —

  控件唯一ID。

  在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

  例：

  • 如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。
  • 如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。

  注：控件ID可以在一个PDF中不可重复
  点击查看ComponentId在模板页面的位置

• ComponentType: (p) —

  如果是Component填写控件类型，则可选的字段为：

  • TEXT : 普通文本控件，输入文本字符串；
  • MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；
  • CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
  • FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；
  • DYNAMIC_TABLE : 动态表格控件；
  • ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
  • SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；
  • DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；
  • DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
  • VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容

  如果是SignComponent签署控件类型，
  需要根据签署人的类型可选的字段为

  • 企业方
    • SIGN_SEAL : 签署印章控件；
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
    • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。

  • 个人方
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择

  注：表单域的控件不能作为印章和签名控件

• ComponentName: (p) —

  在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。

  注：控件名可以在一个PDF中可以重复

  点击查看ComponentName在模板页面的位置

• ComponentRequired: (p) —

  如果是填写控件，ComponentRequired表示在填写页面此控件是否必填

  • false（默认）：可以不填写
  • true ：必须填写此填写控件

  如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响

• ComponentRecipientId: (p) —

  在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可

• FileIndex: (p) —

  【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0

• GenerateMode: (p) —

  控件生成的方式：

  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）

• ComponentWidth: (p) —

  在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。

• ComponentHeight: (p) —

  在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。

• ComponentPage: (p) —

  在绝对定位方式方式下，指定控件所在PDF文件上的页码
  在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。

  注：

  1. 页码编号是从1开始编号的。
  2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。

• ComponentPosX: (p) —

  在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。

• ComponentPosY: (p) —

  在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。

• ComponentExtra: (p) —

  在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。

  ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • FontAlign： Left/Right/Center，左对齐/居中/右对齐
  • FontColor：字符串类型，格式为RGB颜色数字
  • Bold是否加粗：true/false

  参数样例：{"FontColor":"255,0,0","FontSize":12,"Bold":false}

  ComponentType为DATE时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72

  参数样例：{"FontColor":"255,0,0","FontSize":12}

  ComponentType为WATERMARK时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • Opacity： 透明度，范围0 :1
  • Rotate： 水印旋转角度，范围0 :359
  • Density： 水印样式，1-宽松，2-标准（默认值），3-密集，
  • Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中
  • SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息

  参数样例："{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"

  ComponentType为FILL_IMAGE时，支持以下参数：

  • NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中
  • FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放

  ComponentType为SELECTOR时，支持以下参数：

  • WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成

  ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以ComponentTypeLimit参数控制签署方式

  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

  参考样例：{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}印章的对应关系参考下图
  
  ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型，支持指定以下印章类型

  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章
  • OTHER : 其他

  参考样例：{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。
  
  

  ComponentType为SIGN_DATE时，支持以下参数：

  • Font :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"
  • FontSize : 数字类型，范围6-72，默认值为12
  • FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
  • Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
  • Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数

  如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"

  ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：

  • PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）

  参数样例："{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"

  签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时，可以通过以下参数设置签署图片的旋转角度：

  • Rotate：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。
  • RotateRelation：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。

  参数样例：{"Rotate":-30,"RotateRelation":"Component_Id1"}

  签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：

  • Opacity：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度

  参数样例：{"Opacity":0.7}

  签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：

  • UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false

  参数样例：{"UseSealSize":true}

  签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：

  • Values：签署意见预设的需要用户填写的文本
  • ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）

  参数样例：{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}

  关键字模式下支持关键字找不到的情况下不进行报错的设置

  • IgnoreKeywordError :1-关键字查找不到时不进行报错

  场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例："{"IgnoreKeywordError":1}"

  ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：

  • Children: 绝对定位模式下，用来指定此签批控件的组合子控件
  参数样例：
  {"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}
  • ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件
  ChildrenComponent结构体定义:

  字段名称	类型	描述
  ComponentType	string	子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT
  ComponentName	string	子控件名称
  Placeholder	string	子控件提示语
  ComponentValue	string	子控件值（签署方不可设置）
  ComponentOffsetX	float	控件偏移位置X（相对于父控件（签批控件的ComponentX））
  ComponentOffsetY	float	控件偏移位置Y 相对于父控件（签批控件的ComponentY））
  ComponentWidth	float	控件宽
  ComponentHeight	float	控件高
  ComponentExtra	string	控件的附属信息，根据ComponentType设置

  参数样例：

  {    "ChildrenComponents": [        {            "ComponentType": "SIGN_SIGNATURE",            "ComponentName": "个人签名",            "Placeholder": "请签名",            "ComponentOffsetX": 10,            "ComponentOffsetY": 30,            "ComponentWidth": 119,            "ComponentHeight": 43,            "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"        },        {            "ComponentType": "SIGN_SELECTOR",            "ComponentName": "是否同意此协议",            "Placeholder": "",            "ComponentOffsetX": 50,            "ComponentOffsetY": 130,            "ComponentWidth": 120,            "ComponentHeight": 43,            "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"        },        {            "ComponentType": "SIGN_MULTI_LINE_TEXT",            "ComponentName": "批注附言",            "Placeholder": "",            "ComponentOffsetX": 150,            "ComponentOffsetY": 300,            "ComponentWidth": 200,            "ComponentHeight": 86,            "ComponentExtra": ""        }    ]}

• ComponentValue: (p) —

  控件填充vaule，ComponentType和传入值类型对应关系：

  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
  • DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
  • SIGN_SEAL : 印章ID，于控制台查询获取，点击查看在控制上的位置
  • SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取，点击查看在控制上的位置

  控件值约束说明：

  特殊控件	填写约束
  企业全称控件	企业名称中文字符中文括号
  统一社会信用代码控件	企业注册的统一社会信用代码
  法人名称控件	最大50个字符，2到25个汉字或者1到50个字母
  签署意见控件	签署意见最大长度为50字符
  签署人手机号控件	国内手机号 13,14,15,16,17,18,19号段长度11位
  签署人身份证控件	合法的身份证号码检查
  控件名称	控件名称最大长度为20字符，不支持表情
  单行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  多行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  勾选框控件	选择填字符串true，不选填字符串false
  选择器控件	同单行文本控件约束，填写选择值中的字符串
  数字控件	请输入有效的数字(可带小数点)
  日期控件	格式：yyyy年mm月dd日
  附件控件	JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID
  图片控件	JPG或PNG图片，填写上传的图片资源ID
  邮箱控件	有效的邮箱地址, w3c标准
  地址控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  省市区控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  性别控件	选择值中的字符串
  学历控件	选择值中的字符串
  水印控件	水印控件设置为CUSTOM_WATERMARK类型时的水印内容

  注： 部分特殊控件需要在控制台配置模板形式创建

• ComponentDateFontSize: (p) —

  【暂未使用】日期签署控件的字号，默认为 12

• DocumentId: (p) —

  【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可

• ComponentDescription: (p) —

  【暂未使用】控件描述，用户自定义，不影响合同发起流程

• OffsetX: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
  注意： 向左调整设置为负数， 向右调整设置成正数

• OffsetY: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
  注意： 向上调整设置为负数， 向下调整设置成正数

• ChannelComponentId: (p) —

  【暂未使用】第三方应用集成平台模板控件 ID 标识

• KeywordOrder: (p) —

  如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。

  • Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列
  • Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列

  在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。

• KeywordPage: (p) —

  如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。

• RelativeLocation: (p) —

  如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值

  • Middle :居中
  • Below :正下方
  • Right :正右方
  • LowerRight :右下角
  • UpperRight :右上角。

  示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方

• KeywordIndexes: (p) —

  如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

  注意：关键字索引是从0开始计数的

• Placeholder: (p) —

  填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
  注：签署控件设置此字段无效

• LockComponentValue: (p) —

  web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑

  • false（默认）：不锁定控件值，允许在页面编辑控件值
  • true：锁定控件值，在页面无法编辑控件值

• ForbidMoveAndDelete: (p) —

  web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件

  • false（默认） :可以移动和删除控件
  • true : 禁止移动和删除控件

# File 'lib/v20210526/models.rb', line 5329

def ComponentId
  @ComponentId
end

#ComponentName ⇒ Object

Parameters:

• ComponentId: (p) —

  控件唯一ID。

  在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

  例：

  • 如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。
  • 如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。

  注：控件ID可以在一个PDF中不可重复
  点击查看ComponentId在模板页面的位置

• ComponentType: (p) —

  如果是Component填写控件类型，则可选的字段为：

  • TEXT : 普通文本控件，输入文本字符串；
  • MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；
  • CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
  • FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；
  • DYNAMIC_TABLE : 动态表格控件；
  • ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
  • SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；
  • DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；
  • DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
  • VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容

  如果是SignComponent签署控件类型，
  需要根据签署人的类型可选的字段为

  • 企业方
    • SIGN_SEAL : 签署印章控件；
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
    • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。

  • 个人方
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择

  注：表单域的控件不能作为印章和签名控件

• ComponentName: (p) —

  在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。

  注：控件名可以在一个PDF中可以重复

  点击查看ComponentName在模板页面的位置

• ComponentRequired: (p) —

  如果是填写控件，ComponentRequired表示在填写页面此控件是否必填

  • false（默认）：可以不填写
  • true ：必须填写此填写控件

  如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响

• ComponentRecipientId: (p) —

  在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可

• FileIndex: (p) —

  【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0

• GenerateMode: (p) —

  控件生成的方式：

  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）

• ComponentWidth: (p) —

  在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。

• ComponentHeight: (p) —

  在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。

• ComponentPage: (p) —

  在绝对定位方式方式下，指定控件所在PDF文件上的页码
  在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。

  注：

  1. 页码编号是从1开始编号的。
  2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。

• ComponentPosX: (p) —

  在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。

• ComponentPosY: (p) —

  在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。

• ComponentExtra: (p) —

  在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。

  ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • FontAlign： Left/Right/Center，左对齐/居中/右对齐
  • FontColor：字符串类型，格式为RGB颜色数字
  • Bold是否加粗：true/false

  参数样例：{"FontColor":"255,0,0","FontSize":12,"Bold":false}

  ComponentType为DATE时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72

  参数样例：{"FontColor":"255,0,0","FontSize":12}

  ComponentType为WATERMARK时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • Opacity： 透明度，范围0 :1
  • Rotate： 水印旋转角度，范围0 :359
  • Density： 水印样式，1-宽松，2-标准（默认值），3-密集，
  • Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中
  • SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息

  参数样例："{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"

  ComponentType为FILL_IMAGE时，支持以下参数：

  • NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中
  • FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放

  ComponentType为SELECTOR时，支持以下参数：

  • WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成

  ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以ComponentTypeLimit参数控制签署方式

  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

  参考样例：{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}印章的对应关系参考下图
  
  ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型，支持指定以下印章类型

  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章
  • OTHER : 其他

  参考样例：{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。
  
  

  ComponentType为SIGN_DATE时，支持以下参数：

  • Font :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"
  • FontSize : 数字类型，范围6-72，默认值为12
  • FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
  • Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
  • Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数

  如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"

  ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：

  • PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）

  参数样例："{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"

  签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时，可以通过以下参数设置签署图片的旋转角度：

  • Rotate：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。
  • RotateRelation：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。

  参数样例：{"Rotate":-30,"RotateRelation":"Component_Id1"}

  签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：

  • Opacity：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度

  参数样例：{"Opacity":0.7}

  签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：

  • UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false

  参数样例：{"UseSealSize":true}

  签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：

  • Values：签署意见预设的需要用户填写的文本
  • ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）

  参数样例：{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}

  关键字模式下支持关键字找不到的情况下不进行报错的设置

  • IgnoreKeywordError :1-关键字查找不到时不进行报错

  场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例："{"IgnoreKeywordError":1}"

  ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：

  • Children: 绝对定位模式下，用来指定此签批控件的组合子控件
  参数样例：
  {"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}
  • ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件
  ChildrenComponent结构体定义:

  字段名称	类型	描述
  ComponentType	string	子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT
  ComponentName	string	子控件名称
  Placeholder	string	子控件提示语
  ComponentValue	string	子控件值（签署方不可设置）
  ComponentOffsetX	float	控件偏移位置X（相对于父控件（签批控件的ComponentX））
  ComponentOffsetY	float	控件偏移位置Y 相对于父控件（签批控件的ComponentY））
  ComponentWidth	float	控件宽
  ComponentHeight	float	控件高
  ComponentExtra	string	控件的附属信息，根据ComponentType设置

  参数样例：

  {    "ChildrenComponents": [        {            "ComponentType": "SIGN_SIGNATURE",            "ComponentName": "个人签名",            "Placeholder": "请签名",            "ComponentOffsetX": 10,            "ComponentOffsetY": 30,            "ComponentWidth": 119,            "ComponentHeight": 43,            "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"        },        {            "ComponentType": "SIGN_SELECTOR",            "ComponentName": "是否同意此协议",            "Placeholder": "",            "ComponentOffsetX": 50,            "ComponentOffsetY": 130,            "ComponentWidth": 120,            "ComponentHeight": 43,            "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"        },        {            "ComponentType": "SIGN_MULTI_LINE_TEXT",            "ComponentName": "批注附言",            "Placeholder": "",            "ComponentOffsetX": 150,            "ComponentOffsetY": 300,            "ComponentWidth": 200,            "ComponentHeight": 86,            "ComponentExtra": ""        }    ]}

• ComponentValue: (p) —

  控件填充vaule，ComponentType和传入值类型对应关系：

  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
  • DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
  • SIGN_SEAL : 印章ID，于控制台查询获取，点击查看在控制上的位置
  • SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取，点击查看在控制上的位置

  控件值约束说明：

  特殊控件	填写约束
  企业全称控件	企业名称中文字符中文括号
  统一社会信用代码控件	企业注册的统一社会信用代码
  法人名称控件	最大50个字符，2到25个汉字或者1到50个字母
  签署意见控件	签署意见最大长度为50字符
  签署人手机号控件	国内手机号 13,14,15,16,17,18,19号段长度11位
  签署人身份证控件	合法的身份证号码检查
  控件名称	控件名称最大长度为20字符，不支持表情
  单行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  多行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  勾选框控件	选择填字符串true，不选填字符串false
  选择器控件	同单行文本控件约束，填写选择值中的字符串
  数字控件	请输入有效的数字(可带小数点)
  日期控件	格式：yyyy年mm月dd日
  附件控件	JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID
  图片控件	JPG或PNG图片，填写上传的图片资源ID
  邮箱控件	有效的邮箱地址, w3c标准
  地址控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  省市区控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  性别控件	选择值中的字符串
  学历控件	选择值中的字符串
  水印控件	水印控件设置为CUSTOM_WATERMARK类型时的水印内容

  注： 部分特殊控件需要在控制台配置模板形式创建

• ComponentDateFontSize: (p) —

  【暂未使用】日期签署控件的字号，默认为 12

• DocumentId: (p) —

  【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可

• ComponentDescription: (p) —

  【暂未使用】控件描述，用户自定义，不影响合同发起流程

• OffsetX: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
  注意： 向左调整设置为负数， 向右调整设置成正数

• OffsetY: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
  注意： 向上调整设置为负数， 向下调整设置成正数

• ChannelComponentId: (p) —

  【暂未使用】第三方应用集成平台模板控件 ID 标识

• KeywordOrder: (p) —

  如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。

  • Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列
  • Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列

  在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。

• KeywordPage: (p) —

  如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。

• RelativeLocation: (p) —

  如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值

  • Middle :居中
  • Below :正下方
  • Right :正右方
  • LowerRight :右下角
  • UpperRight :右上角。

  示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方

• KeywordIndexes: (p) —

  如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

  注意：关键字索引是从0开始计数的

• Placeholder: (p) —

  填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
  注：签署控件设置此字段无效

• LockComponentValue: (p) —

  web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑

  • false（默认）：不锁定控件值，允许在页面编辑控件值
  • true：锁定控件值，在页面无法编辑控件值

• ForbidMoveAndDelete: (p) —

  web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件

  • false（默认） :可以移动和删除控件
  • true : 禁止移动和删除控件

# File 'lib/v20210526/models.rb', line 5329

def ComponentName
  @ComponentName
end

#ComponentPage ⇒ Object

Parameters:

• ComponentId: (p) —

  控件唯一ID。

  在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

  例：

  • 如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。
  • 如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。

  注：控件ID可以在一个PDF中不可重复
  点击查看ComponentId在模板页面的位置

• ComponentType: (p) —

  如果是Component填写控件类型，则可选的字段为：

  • TEXT : 普通文本控件，输入文本字符串；
  • MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；
  • CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
  • FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；
  • DYNAMIC_TABLE : 动态表格控件；
  • ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
  • SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；
  • DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；
  • DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
  • VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容

  如果是SignComponent签署控件类型，
  需要根据签署人的类型可选的字段为

  • 企业方
    • SIGN_SEAL : 签署印章控件；
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
    • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。

  • 个人方
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择

  注：表单域的控件不能作为印章和签名控件

• ComponentName: (p) —

  在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。

  注：控件名可以在一个PDF中可以重复

  点击查看ComponentName在模板页面的位置

• ComponentRequired: (p) —

  如果是填写控件，ComponentRequired表示在填写页面此控件是否必填

  • false（默认）：可以不填写
  • true ：必须填写此填写控件

  如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响

• ComponentRecipientId: (p) —

  在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可

• FileIndex: (p) —

  【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0

• GenerateMode: (p) —

  控件生成的方式：

  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）

• ComponentWidth: (p) —

  在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。

• ComponentHeight: (p) —

  在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。

• ComponentPage: (p) —

  在绝对定位方式方式下，指定控件所在PDF文件上的页码
  在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。

  注：

  1. 页码编号是从1开始编号的。
  2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。

• ComponentPosX: (p) —

  在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。

• ComponentPosY: (p) —

  在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。

• ComponentExtra: (p) —

  在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。

  ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • FontAlign： Left/Right/Center，左对齐/居中/右对齐
  • FontColor：字符串类型，格式为RGB颜色数字
  • Bold是否加粗：true/false

  参数样例：{"FontColor":"255,0,0","FontSize":12,"Bold":false}

  ComponentType为DATE时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72

  参数样例：{"FontColor":"255,0,0","FontSize":12}

  ComponentType为WATERMARK时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • Opacity： 透明度，范围0 :1
  • Rotate： 水印旋转角度，范围0 :359
  • Density： 水印样式，1-宽松，2-标准（默认值），3-密集，
  • Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中
  • SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息

  参数样例："{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"

  ComponentType为FILL_IMAGE时，支持以下参数：

  • NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中
  • FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放

  ComponentType为SELECTOR时，支持以下参数：

  • WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成

  ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以ComponentTypeLimit参数控制签署方式

  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

  参考样例：{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}印章的对应关系参考下图
  
  ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型，支持指定以下印章类型

  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章
  • OTHER : 其他

  参考样例：{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。
  
  

  ComponentType为SIGN_DATE时，支持以下参数：

  • Font :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"
  • FontSize : 数字类型，范围6-72，默认值为12
  • FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
  • Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
  • Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数

  如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"

  ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：

  • PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）

  参数样例："{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"

  签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时，可以通过以下参数设置签署图片的旋转角度：

  • Rotate：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。
  • RotateRelation：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。

  参数样例：{"Rotate":-30,"RotateRelation":"Component_Id1"}

  签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：

  • Opacity：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度

  参数样例：{"Opacity":0.7}

  签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：

  • UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false

  参数样例：{"UseSealSize":true}

  签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：

  • Values：签署意见预设的需要用户填写的文本
  • ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）

  参数样例：{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}

  关键字模式下支持关键字找不到的情况下不进行报错的设置

  • IgnoreKeywordError :1-关键字查找不到时不进行报错

  场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例："{"IgnoreKeywordError":1}"

  ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：

  • Children: 绝对定位模式下，用来指定此签批控件的组合子控件
  参数样例：
  {"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}
  • ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件
  ChildrenComponent结构体定义:

  字段名称	类型	描述
  ComponentType	string	子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT
  ComponentName	string	子控件名称
  Placeholder	string	子控件提示语
  ComponentValue	string	子控件值（签署方不可设置）
  ComponentOffsetX	float	控件偏移位置X（相对于父控件（签批控件的ComponentX））
  ComponentOffsetY	float	控件偏移位置Y 相对于父控件（签批控件的ComponentY））
  ComponentWidth	float	控件宽
  ComponentHeight	float	控件高
  ComponentExtra	string	控件的附属信息，根据ComponentType设置

  参数样例：

  {    "ChildrenComponents": [        {            "ComponentType": "SIGN_SIGNATURE",            "ComponentName": "个人签名",            "Placeholder": "请签名",            "ComponentOffsetX": 10,            "ComponentOffsetY": 30,            "ComponentWidth": 119,            "ComponentHeight": 43,            "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"        },        {            "ComponentType": "SIGN_SELECTOR",            "ComponentName": "是否同意此协议",            "Placeholder": "",            "ComponentOffsetX": 50,            "ComponentOffsetY": 130,            "ComponentWidth": 120,            "ComponentHeight": 43,            "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"        },        {            "ComponentType": "SIGN_MULTI_LINE_TEXT",            "ComponentName": "批注附言",            "Placeholder": "",            "ComponentOffsetX": 150,            "ComponentOffsetY": 300,            "ComponentWidth": 200,            "ComponentHeight": 86,            "ComponentExtra": ""        }    ]}

• ComponentValue: (p) —

  控件填充vaule，ComponentType和传入值类型对应关系：

  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
  • DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
  • SIGN_SEAL : 印章ID，于控制台查询获取，点击查看在控制上的位置
  • SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取，点击查看在控制上的位置

  控件值约束说明：

  特殊控件	填写约束
  企业全称控件	企业名称中文字符中文括号
  统一社会信用代码控件	企业注册的统一社会信用代码
  法人名称控件	最大50个字符，2到25个汉字或者1到50个字母
  签署意见控件	签署意见最大长度为50字符
  签署人手机号控件	国内手机号 13,14,15,16,17,18,19号段长度11位
  签署人身份证控件	合法的身份证号码检查
  控件名称	控件名称最大长度为20字符，不支持表情
  单行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  多行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  勾选框控件	选择填字符串true，不选填字符串false
  选择器控件	同单行文本控件约束，填写选择值中的字符串
  数字控件	请输入有效的数字(可带小数点)
  日期控件	格式：yyyy年mm月dd日
  附件控件	JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID
  图片控件	JPG或PNG图片，填写上传的图片资源ID
  邮箱控件	有效的邮箱地址, w3c标准
  地址控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  省市区控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  性别控件	选择值中的字符串
  学历控件	选择值中的字符串
  水印控件	水印控件设置为CUSTOM_WATERMARK类型时的水印内容

  注： 部分特殊控件需要在控制台配置模板形式创建

• ComponentDateFontSize: (p) —

  【暂未使用】日期签署控件的字号，默认为 12

• DocumentId: (p) —

  【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可

• ComponentDescription: (p) —

  【暂未使用】控件描述，用户自定义，不影响合同发起流程

• OffsetX: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
  注意： 向左调整设置为负数， 向右调整设置成正数

• OffsetY: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
  注意： 向上调整设置为负数， 向下调整设置成正数

• ChannelComponentId: (p) —

  【暂未使用】第三方应用集成平台模板控件 ID 标识

• KeywordOrder: (p) —

  如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。

  • Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列
  • Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列

  在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。

• KeywordPage: (p) —

  如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。

• RelativeLocation: (p) —

  如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值

  • Middle :居中
  • Below :正下方
  • Right :正右方
  • LowerRight :右下角
  • UpperRight :右上角。

  示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方

• KeywordIndexes: (p) —

  如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

  注意：关键字索引是从0开始计数的

• Placeholder: (p) —

  填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
  注：签署控件设置此字段无效

• LockComponentValue: (p) —

  web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑

  • false（默认）：不锁定控件值，允许在页面编辑控件值
  • true：锁定控件值，在页面无法编辑控件值

• ForbidMoveAndDelete: (p) —

  web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件

  • false（默认） :可以移动和删除控件
  • true : 禁止移动和删除控件

# File 'lib/v20210526/models.rb', line 5329

def ComponentPage
  @ComponentPage
end

#ComponentPosX ⇒ Object

Parameters:

• ComponentId: (p) —

  控件唯一ID。

  在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

  例：

  • 如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。
  • 如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。

  注：控件ID可以在一个PDF中不可重复
  点击查看ComponentId在模板页面的位置

• ComponentType: (p) —

  如果是Component填写控件类型，则可选的字段为：

  • TEXT : 普通文本控件，输入文本字符串；
  • MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；
  • CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
  • FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；
  • DYNAMIC_TABLE : 动态表格控件；
  • ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
  • SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；
  • DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；
  • DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
  • VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容

  如果是SignComponent签署控件类型，
  需要根据签署人的类型可选的字段为

  • 企业方
    • SIGN_SEAL : 签署印章控件；
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
    • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。

  • 个人方
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择

  注：表单域的控件不能作为印章和签名控件

• ComponentName: (p) —

  在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。

  注：控件名可以在一个PDF中可以重复

  点击查看ComponentName在模板页面的位置

• ComponentRequired: (p) —

  如果是填写控件，ComponentRequired表示在填写页面此控件是否必填

  • false（默认）：可以不填写
  • true ：必须填写此填写控件

  如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响

• ComponentRecipientId: (p) —

  在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可

• FileIndex: (p) —

  【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0

• GenerateMode: (p) —

  控件生成的方式：

  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）

• ComponentWidth: (p) —

  在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。

• ComponentHeight: (p) —

  在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。

• ComponentPage: (p) —

  在绝对定位方式方式下，指定控件所在PDF文件上的页码
  在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。

  注：

  1. 页码编号是从1开始编号的。
  2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。

• ComponentPosX: (p) —

  在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。

• ComponentPosY: (p) —

  在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。

• ComponentExtra: (p) —

  在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。

  ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • FontAlign： Left/Right/Center，左对齐/居中/右对齐
  • FontColor：字符串类型，格式为RGB颜色数字
  • Bold是否加粗：true/false

  参数样例：{"FontColor":"255,0,0","FontSize":12,"Bold":false}

  ComponentType为DATE时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72

  参数样例：{"FontColor":"255,0,0","FontSize":12}

  ComponentType为WATERMARK时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • Opacity： 透明度，范围0 :1
  • Rotate： 水印旋转角度，范围0 :359
  • Density： 水印样式，1-宽松，2-标准（默认值），3-密集，
  • Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中
  • SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息

  参数样例："{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"

  ComponentType为FILL_IMAGE时，支持以下参数：

  • NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中
  • FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放

  ComponentType为SELECTOR时，支持以下参数：

  • WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成

  ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以ComponentTypeLimit参数控制签署方式

  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

  参考样例：{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}印章的对应关系参考下图
  
  ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型，支持指定以下印章类型

  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章
  • OTHER : 其他

  参考样例：{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。
  
  

  ComponentType为SIGN_DATE时，支持以下参数：

  • Font :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"
  • FontSize : 数字类型，范围6-72，默认值为12
  • FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
  • Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
  • Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数

  如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"

  ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：

  • PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）

  参数样例："{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"

  签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时，可以通过以下参数设置签署图片的旋转角度：

  • Rotate：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。
  • RotateRelation：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。

  参数样例：{"Rotate":-30,"RotateRelation":"Component_Id1"}

  签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：

  • Opacity：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度

  参数样例：{"Opacity":0.7}

  签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：

  • UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false

  参数样例：{"UseSealSize":true}

  签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：

  • Values：签署意见预设的需要用户填写的文本
  • ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）

  参数样例：{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}

  关键字模式下支持关键字找不到的情况下不进行报错的设置

  • IgnoreKeywordError :1-关键字查找不到时不进行报错

  场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例："{"IgnoreKeywordError":1}"

  ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：

  • Children: 绝对定位模式下，用来指定此签批控件的组合子控件
  参数样例：
  {"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}
  • ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件
  ChildrenComponent结构体定义:

  字段名称	类型	描述
  ComponentType	string	子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT
  ComponentName	string	子控件名称
  Placeholder	string	子控件提示语
  ComponentValue	string	子控件值（签署方不可设置）
  ComponentOffsetX	float	控件偏移位置X（相对于父控件（签批控件的ComponentX））
  ComponentOffsetY	float	控件偏移位置Y 相对于父控件（签批控件的ComponentY））
  ComponentWidth	float	控件宽
  ComponentHeight	float	控件高
  ComponentExtra	string	控件的附属信息，根据ComponentType设置

  参数样例：

  {    "ChildrenComponents": [        {            "ComponentType": "SIGN_SIGNATURE",            "ComponentName": "个人签名",            "Placeholder": "请签名",            "ComponentOffsetX": 10,            "ComponentOffsetY": 30,            "ComponentWidth": 119,            "ComponentHeight": 43,            "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"        },        {            "ComponentType": "SIGN_SELECTOR",            "ComponentName": "是否同意此协议",            "Placeholder": "",            "ComponentOffsetX": 50,            "ComponentOffsetY": 130,            "ComponentWidth": 120,            "ComponentHeight": 43,            "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"        },        {            "ComponentType": "SIGN_MULTI_LINE_TEXT",            "ComponentName": "批注附言",            "Placeholder": "",            "ComponentOffsetX": 150,            "ComponentOffsetY": 300,            "ComponentWidth": 200,            "ComponentHeight": 86,            "ComponentExtra": ""        }    ]}

• ComponentValue: (p) —

  控件填充vaule，ComponentType和传入值类型对应关系：

  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
  • DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
  • SIGN_SEAL : 印章ID，于控制台查询获取，点击查看在控制上的位置
  • SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取，点击查看在控制上的位置

  控件值约束说明：

  特殊控件	填写约束
  企业全称控件	企业名称中文字符中文括号
  统一社会信用代码控件	企业注册的统一社会信用代码
  法人名称控件	最大50个字符，2到25个汉字或者1到50个字母
  签署意见控件	签署意见最大长度为50字符
  签署人手机号控件	国内手机号 13,14,15,16,17,18,19号段长度11位
  签署人身份证控件	合法的身份证号码检查
  控件名称	控件名称最大长度为20字符，不支持表情
  单行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  多行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  勾选框控件	选择填字符串true，不选填字符串false
  选择器控件	同单行文本控件约束，填写选择值中的字符串
  数字控件	请输入有效的数字(可带小数点)
  日期控件	格式：yyyy年mm月dd日
  附件控件	JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID
  图片控件	JPG或PNG图片，填写上传的图片资源ID
  邮箱控件	有效的邮箱地址, w3c标准
  地址控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  省市区控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  性别控件	选择值中的字符串
  学历控件	选择值中的字符串
  水印控件	水印控件设置为CUSTOM_WATERMARK类型时的水印内容

  注： 部分特殊控件需要在控制台配置模板形式创建

• ComponentDateFontSize: (p) —

  【暂未使用】日期签署控件的字号，默认为 12

• DocumentId: (p) —

  【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可

• ComponentDescription: (p) —

  【暂未使用】控件描述，用户自定义，不影响合同发起流程

• OffsetX: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
  注意： 向左调整设置为负数， 向右调整设置成正数

• OffsetY: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
  注意： 向上调整设置为负数， 向下调整设置成正数

• ChannelComponentId: (p) —

  【暂未使用】第三方应用集成平台模板控件 ID 标识

• KeywordOrder: (p) —

  如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。

  • Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列
  • Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列

  在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。

• KeywordPage: (p) —

  如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。

• RelativeLocation: (p) —

  如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值

  • Middle :居中
  • Below :正下方
  • Right :正右方
  • LowerRight :右下角
  • UpperRight :右上角。

  示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方

• KeywordIndexes: (p) —

  如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

  注意：关键字索引是从0开始计数的

• Placeholder: (p) —

  填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
  注：签署控件设置此字段无效

• LockComponentValue: (p) —

  web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑

  • false（默认）：不锁定控件值，允许在页面编辑控件值
  • true：锁定控件值，在页面无法编辑控件值

• ForbidMoveAndDelete: (p) —

  web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件

  • false（默认） :可以移动和删除控件
  • true : 禁止移动和删除控件

# File 'lib/v20210526/models.rb', line 5329

def ComponentPosX
  @ComponentPosX
end

#ComponentPosY ⇒ Object

Parameters:

• ComponentId: (p) —

  控件唯一ID。

  在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

  例：

  • 如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。
  • 如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。

  注：控件ID可以在一个PDF中不可重复
  点击查看ComponentId在模板页面的位置

• ComponentType: (p) —

  如果是Component填写控件类型，则可选的字段为：

  • TEXT : 普通文本控件，输入文本字符串；
  • MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；
  • CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
  • FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；
  • DYNAMIC_TABLE : 动态表格控件；
  • ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
  • SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；
  • DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；
  • DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
  • VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容

  如果是SignComponent签署控件类型，
  需要根据签署人的类型可选的字段为

  • 企业方
    • SIGN_SEAL : 签署印章控件；
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
    • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。

  • 个人方
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择

  注：表单域的控件不能作为印章和签名控件

• ComponentName: (p) —

  在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。

  注：控件名可以在一个PDF中可以重复

  点击查看ComponentName在模板页面的位置

• ComponentRequired: (p) —

  如果是填写控件，ComponentRequired表示在填写页面此控件是否必填

  • false（默认）：可以不填写
  • true ：必须填写此填写控件

  如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响

• ComponentRecipientId: (p) —

  在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可

• FileIndex: (p) —

  【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0

• GenerateMode: (p) —

  控件生成的方式：

  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）

• ComponentWidth: (p) —

  在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。

• ComponentHeight: (p) —

  在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。

• ComponentPage: (p) —

  在绝对定位方式方式下，指定控件所在PDF文件上的页码
  在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。

  注：

  1. 页码编号是从1开始编号的。
  2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。

• ComponentPosX: (p) —

  在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。

• ComponentPosY: (p) —

  在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。

• ComponentExtra: (p) —

  在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。

  ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • FontAlign： Left/Right/Center，左对齐/居中/右对齐
  • FontColor：字符串类型，格式为RGB颜色数字
  • Bold是否加粗：true/false

  参数样例：{"FontColor":"255,0,0","FontSize":12,"Bold":false}

  ComponentType为DATE时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72

  参数样例：{"FontColor":"255,0,0","FontSize":12}

  ComponentType为WATERMARK时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • Opacity： 透明度，范围0 :1
  • Rotate： 水印旋转角度，范围0 :359
  • Density： 水印样式，1-宽松，2-标准（默认值），3-密集，
  • Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中
  • SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息

  参数样例："{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"

  ComponentType为FILL_IMAGE时，支持以下参数：

  • NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中
  • FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放

  ComponentType为SELECTOR时，支持以下参数：

  • WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成

  ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以ComponentTypeLimit参数控制签署方式

  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

  参考样例：{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}印章的对应关系参考下图
  
  ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型，支持指定以下印章类型

  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章
  • OTHER : 其他

  参考样例：{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。
  
  

  ComponentType为SIGN_DATE时，支持以下参数：

  • Font :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"
  • FontSize : 数字类型，范围6-72，默认值为12
  • FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
  • Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
  • Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数

  如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"

  ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：

  • PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）

  参数样例："{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"

  签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时，可以通过以下参数设置签署图片的旋转角度：

  • Rotate：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。
  • RotateRelation：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。

  参数样例：{"Rotate":-30,"RotateRelation":"Component_Id1"}

  签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：

  • Opacity：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度

  参数样例：{"Opacity":0.7}

  签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：

  • UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false

  参数样例：{"UseSealSize":true}

  签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：

  • Values：签署意见预设的需要用户填写的文本
  • ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）

  参数样例：{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}

  关键字模式下支持关键字找不到的情况下不进行报错的设置

  • IgnoreKeywordError :1-关键字查找不到时不进行报错

  场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例："{"IgnoreKeywordError":1}"

  ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：

  • Children: 绝对定位模式下，用来指定此签批控件的组合子控件
  参数样例：
  {"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}
  • ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件
  ChildrenComponent结构体定义:

  字段名称	类型	描述
  ComponentType	string	子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT
  ComponentName	string	子控件名称
  Placeholder	string	子控件提示语
  ComponentValue	string	子控件值（签署方不可设置）
  ComponentOffsetX	float	控件偏移位置X（相对于父控件（签批控件的ComponentX））
  ComponentOffsetY	float	控件偏移位置Y 相对于父控件（签批控件的ComponentY））
  ComponentWidth	float	控件宽
  ComponentHeight	float	控件高
  ComponentExtra	string	控件的附属信息，根据ComponentType设置

  参数样例：

  {    "ChildrenComponents": [        {            "ComponentType": "SIGN_SIGNATURE",            "ComponentName": "个人签名",            "Placeholder": "请签名",            "ComponentOffsetX": 10,            "ComponentOffsetY": 30,            "ComponentWidth": 119,            "ComponentHeight": 43,            "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"        },        {            "ComponentType": "SIGN_SELECTOR",            "ComponentName": "是否同意此协议",            "Placeholder": "",            "ComponentOffsetX": 50,            "ComponentOffsetY": 130,            "ComponentWidth": 120,            "ComponentHeight": 43,            "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"        },        {            "ComponentType": "SIGN_MULTI_LINE_TEXT",            "ComponentName": "批注附言",            "Placeholder": "",            "ComponentOffsetX": 150,            "ComponentOffsetY": 300,            "ComponentWidth": 200,            "ComponentHeight": 86,            "ComponentExtra": ""        }    ]}

• ComponentValue: (p) —

  控件填充vaule，ComponentType和传入值类型对应关系：

  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
  • DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
  • SIGN_SEAL : 印章ID，于控制台查询获取，点击查看在控制上的位置
  • SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取，点击查看在控制上的位置

  控件值约束说明：

  特殊控件	填写约束
  企业全称控件	企业名称中文字符中文括号
  统一社会信用代码控件	企业注册的统一社会信用代码
  法人名称控件	最大50个字符，2到25个汉字或者1到50个字母
  签署意见控件	签署意见最大长度为50字符
  签署人手机号控件	国内手机号 13,14,15,16,17,18,19号段长度11位
  签署人身份证控件	合法的身份证号码检查
  控件名称	控件名称最大长度为20字符，不支持表情
  单行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  多行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  勾选框控件	选择填字符串true，不选填字符串false
  选择器控件	同单行文本控件约束，填写选择值中的字符串
  数字控件	请输入有效的数字(可带小数点)
  日期控件	格式：yyyy年mm月dd日
  附件控件	JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID
  图片控件	JPG或PNG图片，填写上传的图片资源ID
  邮箱控件	有效的邮箱地址, w3c标准
  地址控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  省市区控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  性别控件	选择值中的字符串
  学历控件	选择值中的字符串
  水印控件	水印控件设置为CUSTOM_WATERMARK类型时的水印内容

  注： 部分特殊控件需要在控制台配置模板形式创建

• ComponentDateFontSize: (p) —

  【暂未使用】日期签署控件的字号，默认为 12

• DocumentId: (p) —

  【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可

• ComponentDescription: (p) —

  【暂未使用】控件描述，用户自定义，不影响合同发起流程

• OffsetX: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
  注意： 向左调整设置为负数， 向右调整设置成正数

• OffsetY: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
  注意： 向上调整设置为负数， 向下调整设置成正数

• ChannelComponentId: (p) —

  【暂未使用】第三方应用集成平台模板控件 ID 标识

• KeywordOrder: (p) —

  如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。

  • Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列
  • Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列

  在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。

• KeywordPage: (p) —

  如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。

• RelativeLocation: (p) —

  如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值

  • Middle :居中
  • Below :正下方
  • Right :正右方
  • LowerRight :右下角
  • UpperRight :右上角。

  示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方

• KeywordIndexes: (p) —

  如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

  注意：关键字索引是从0开始计数的

• Placeholder: (p) —

  填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
  注：签署控件设置此字段无效

• LockComponentValue: (p) —

  web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑

  • false（默认）：不锁定控件值，允许在页面编辑控件值
  • true：锁定控件值，在页面无法编辑控件值

• ForbidMoveAndDelete: (p) —

  web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件

  • false（默认） :可以移动和删除控件
  • true : 禁止移动和删除控件

# File 'lib/v20210526/models.rb', line 5329

def ComponentPosY
  @ComponentPosY
end

#ComponentRecipientId ⇒ Object

Parameters:

• ComponentId: (p) —

  控件唯一ID。

  在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

  例：

  • 如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。
  • 如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。

  注：控件ID可以在一个PDF中不可重复
  点击查看ComponentId在模板页面的位置

• ComponentType: (p) —

  如果是Component填写控件类型，则可选的字段为：

  • TEXT : 普通文本控件，输入文本字符串；
  • MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；
  • CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
  • FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；
  • DYNAMIC_TABLE : 动态表格控件；
  • ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
  • SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；
  • DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；
  • DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
  • VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容

  如果是SignComponent签署控件类型，
  需要根据签署人的类型可选的字段为

  • 企业方
    • SIGN_SEAL : 签署印章控件；
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
    • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。

  • 个人方
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择

  注：表单域的控件不能作为印章和签名控件

• ComponentName: (p) —

  在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。

  注：控件名可以在一个PDF中可以重复

  点击查看ComponentName在模板页面的位置

• ComponentRequired: (p) —

  如果是填写控件，ComponentRequired表示在填写页面此控件是否必填

  • false（默认）：可以不填写
  • true ：必须填写此填写控件

  如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响

• ComponentRecipientId: (p) —

  在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可

• FileIndex: (p) —

  【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0

• GenerateMode: (p) —

  控件生成的方式：

  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）

• ComponentWidth: (p) —

  在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。

• ComponentHeight: (p) —

  在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。

• ComponentPage: (p) —

  在绝对定位方式方式下，指定控件所在PDF文件上的页码
  在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。

  注：

  1. 页码编号是从1开始编号的。
  2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。

• ComponentPosX: (p) —

  在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。

• ComponentPosY: (p) —

  在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。

• ComponentExtra: (p) —

  在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。

  ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • FontAlign： Left/Right/Center，左对齐/居中/右对齐
  • FontColor：字符串类型，格式为RGB颜色数字
  • Bold是否加粗：true/false

  参数样例：{"FontColor":"255,0,0","FontSize":12,"Bold":false}

  ComponentType为DATE时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72

  参数样例：{"FontColor":"255,0,0","FontSize":12}

  ComponentType为WATERMARK时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • Opacity： 透明度，范围0 :1
  • Rotate： 水印旋转角度，范围0 :359
  • Density： 水印样式，1-宽松，2-标准（默认值），3-密集，
  • Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中
  • SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息

  参数样例："{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"

  ComponentType为FILL_IMAGE时，支持以下参数：

  • NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中
  • FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放

  ComponentType为SELECTOR时，支持以下参数：

  • WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成

  ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以ComponentTypeLimit参数控制签署方式

  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

  参考样例：{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}印章的对应关系参考下图
  
  ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型，支持指定以下印章类型

  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章
  • OTHER : 其他

  参考样例：{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。
  
  

  ComponentType为SIGN_DATE时，支持以下参数：

  • Font :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"
  • FontSize : 数字类型，范围6-72，默认值为12
  • FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
  • Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
  • Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数

  如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"

  ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：

  • PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）

  参数样例："{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"

  签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时，可以通过以下参数设置签署图片的旋转角度：

  • Rotate：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。
  • RotateRelation：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。

  参数样例：{"Rotate":-30,"RotateRelation":"Component_Id1"}

  签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：

  • Opacity：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度

  参数样例：{"Opacity":0.7}

  签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：

  • UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false

  参数样例：{"UseSealSize":true}

  签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：

  • Values：签署意见预设的需要用户填写的文本
  • ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）

  参数样例：{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}

  关键字模式下支持关键字找不到的情况下不进行报错的设置

  • IgnoreKeywordError :1-关键字查找不到时不进行报错

  场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例："{"IgnoreKeywordError":1}"

  ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：

  • Children: 绝对定位模式下，用来指定此签批控件的组合子控件
  参数样例：
  {"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}
  • ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件
  ChildrenComponent结构体定义:

  字段名称	类型	描述
  ComponentType	string	子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT
  ComponentName	string	子控件名称
  Placeholder	string	子控件提示语
  ComponentValue	string	子控件值（签署方不可设置）
  ComponentOffsetX	float	控件偏移位置X（相对于父控件（签批控件的ComponentX））
  ComponentOffsetY	float	控件偏移位置Y 相对于父控件（签批控件的ComponentY））
  ComponentWidth	float	控件宽
  ComponentHeight	float	控件高
  ComponentExtra	string	控件的附属信息，根据ComponentType设置

  参数样例：

  {    "ChildrenComponents": [        {            "ComponentType": "SIGN_SIGNATURE",            "ComponentName": "个人签名",            "Placeholder": "请签名",            "ComponentOffsetX": 10,            "ComponentOffsetY": 30,            "ComponentWidth": 119,            "ComponentHeight": 43,            "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"        },        {            "ComponentType": "SIGN_SELECTOR",            "ComponentName": "是否同意此协议",            "Placeholder": "",            "ComponentOffsetX": 50,            "ComponentOffsetY": 130,            "ComponentWidth": 120,            "ComponentHeight": 43,            "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"        },        {            "ComponentType": "SIGN_MULTI_LINE_TEXT",            "ComponentName": "批注附言",            "Placeholder": "",            "ComponentOffsetX": 150,            "ComponentOffsetY": 300,            "ComponentWidth": 200,            "ComponentHeight": 86,            "ComponentExtra": ""        }    ]}

• ComponentValue: (p) —

  控件填充vaule，ComponentType和传入值类型对应关系：

  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
  • DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
  • SIGN_SEAL : 印章ID，于控制台查询获取，点击查看在控制上的位置
  • SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取，点击查看在控制上的位置

  控件值约束说明：

  特殊控件	填写约束
  企业全称控件	企业名称中文字符中文括号
  统一社会信用代码控件	企业注册的统一社会信用代码
  法人名称控件	最大50个字符，2到25个汉字或者1到50个字母
  签署意见控件	签署意见最大长度为50字符
  签署人手机号控件	国内手机号 13,14,15,16,17,18,19号段长度11位
  签署人身份证控件	合法的身份证号码检查
  控件名称	控件名称最大长度为20字符，不支持表情
  单行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  多行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  勾选框控件	选择填字符串true，不选填字符串false
  选择器控件	同单行文本控件约束，填写选择值中的字符串
  数字控件	请输入有效的数字(可带小数点)
  日期控件	格式：yyyy年mm月dd日
  附件控件	JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID
  图片控件	JPG或PNG图片，填写上传的图片资源ID
  邮箱控件	有效的邮箱地址, w3c标准
  地址控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  省市区控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  性别控件	选择值中的字符串
  学历控件	选择值中的字符串
  水印控件	水印控件设置为CUSTOM_WATERMARK类型时的水印内容

  注： 部分特殊控件需要在控制台配置模板形式创建

• ComponentDateFontSize: (p) —

  【暂未使用】日期签署控件的字号，默认为 12

• DocumentId: (p) —

  【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可

• ComponentDescription: (p) —

  【暂未使用】控件描述，用户自定义，不影响合同发起流程

• OffsetX: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
  注意： 向左调整设置为负数， 向右调整设置成正数

• OffsetY: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
  注意： 向上调整设置为负数， 向下调整设置成正数

• ChannelComponentId: (p) —

  【暂未使用】第三方应用集成平台模板控件 ID 标识

• KeywordOrder: (p) —

  如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。

  • Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列
  • Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列

  在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。

• KeywordPage: (p) —

  如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。

• RelativeLocation: (p) —

  如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值

  • Middle :居中
  • Below :正下方
  • Right :正右方
  • LowerRight :右下角
  • UpperRight :右上角。

  示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方

• KeywordIndexes: (p) —

  如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

  注意：关键字索引是从0开始计数的

• Placeholder: (p) —

  填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
  注：签署控件设置此字段无效

• LockComponentValue: (p) —

  web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑

  • false（默认）：不锁定控件值，允许在页面编辑控件值
  • true：锁定控件值，在页面无法编辑控件值

• ForbidMoveAndDelete: (p) —

  web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件

  • false（默认） :可以移动和删除控件
  • true : 禁止移动和删除控件

# File 'lib/v20210526/models.rb', line 5329

def ComponentRecipientId
  @ComponentRecipientId
end

#ComponentRequired ⇒ Object

Parameters:

• ComponentId: (p) —

  控件唯一ID。

  在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

  例：

  • 如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。
  • 如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。

  注：控件ID可以在一个PDF中不可重复
  点击查看ComponentId在模板页面的位置

• ComponentType: (p) —

  如果是Component填写控件类型，则可选的字段为：

  • TEXT : 普通文本控件，输入文本字符串；
  • MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；
  • CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
  • FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；
  • DYNAMIC_TABLE : 动态表格控件；
  • ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
  • SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；
  • DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；
  • DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
  • VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容

  如果是SignComponent签署控件类型，
  需要根据签署人的类型可选的字段为

  • 企业方
    • SIGN_SEAL : 签署印章控件；
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
    • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。

  • 个人方
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择

  注：表单域的控件不能作为印章和签名控件

• ComponentName: (p) —

  在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。

  注：控件名可以在一个PDF中可以重复

  点击查看ComponentName在模板页面的位置

• ComponentRequired: (p) —

  如果是填写控件，ComponentRequired表示在填写页面此控件是否必填

  • false（默认）：可以不填写
  • true ：必须填写此填写控件

  如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响

• ComponentRecipientId: (p) —

  在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可

• FileIndex: (p) —

  【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0

• GenerateMode: (p) —

  控件生成的方式：

  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）

• ComponentWidth: (p) —

  在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。

• ComponentHeight: (p) —

  在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。

• ComponentPage: (p) —

  在绝对定位方式方式下，指定控件所在PDF文件上的页码
  在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。

  注：

  1. 页码编号是从1开始编号的。
  2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。

• ComponentPosX: (p) —

  在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。

• ComponentPosY: (p) —

  在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。

• ComponentExtra: (p) —

  在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。

  ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • FontAlign： Left/Right/Center，左对齐/居中/右对齐
  • FontColor：字符串类型，格式为RGB颜色数字
  • Bold是否加粗：true/false

  参数样例：{"FontColor":"255,0,0","FontSize":12,"Bold":false}

  ComponentType为DATE时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72

  参数样例：{"FontColor":"255,0,0","FontSize":12}

  ComponentType为WATERMARK时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • Opacity： 透明度，范围0 :1
  • Rotate： 水印旋转角度，范围0 :359
  • Density： 水印样式，1-宽松，2-标准（默认值），3-密集，
  • Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中
  • SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息

  参数样例："{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"

  ComponentType为FILL_IMAGE时，支持以下参数：

  • NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中
  • FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放

  ComponentType为SELECTOR时，支持以下参数：

  • WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成

  ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以ComponentTypeLimit参数控制签署方式

  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

  参考样例：{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}印章的对应关系参考下图
  
  ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型，支持指定以下印章类型

  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章
  • OTHER : 其他

  参考样例：{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。
  
  

  ComponentType为SIGN_DATE时，支持以下参数：

  • Font :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"
  • FontSize : 数字类型，范围6-72，默认值为12
  • FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
  • Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
  • Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数

  如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"

  ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：

  • PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）

  参数样例："{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"

  签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时，可以通过以下参数设置签署图片的旋转角度：

  • Rotate：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。
  • RotateRelation：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。

  参数样例：{"Rotate":-30,"RotateRelation":"Component_Id1"}

  签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：

  • Opacity：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度

  参数样例：{"Opacity":0.7}

  签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：

  • UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false

  参数样例：{"UseSealSize":true}

  签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：

  • Values：签署意见预设的需要用户填写的文本
  • ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）

  参数样例：{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}

  关键字模式下支持关键字找不到的情况下不进行报错的设置

  • IgnoreKeywordError :1-关键字查找不到时不进行报错

  场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例："{"IgnoreKeywordError":1}"

  ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：

  • Children: 绝对定位模式下，用来指定此签批控件的组合子控件
  参数样例：
  {"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}
  • ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件
  ChildrenComponent结构体定义:

  字段名称	类型	描述
  ComponentType	string	子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT
  ComponentName	string	子控件名称
  Placeholder	string	子控件提示语
  ComponentValue	string	子控件值（签署方不可设置）
  ComponentOffsetX	float	控件偏移位置X（相对于父控件（签批控件的ComponentX））
  ComponentOffsetY	float	控件偏移位置Y 相对于父控件（签批控件的ComponentY））
  ComponentWidth	float	控件宽
  ComponentHeight	float	控件高
  ComponentExtra	string	控件的附属信息，根据ComponentType设置

  参数样例：

  {    "ChildrenComponents": [        {            "ComponentType": "SIGN_SIGNATURE",            "ComponentName": "个人签名",            "Placeholder": "请签名",            "ComponentOffsetX": 10,            "ComponentOffsetY": 30,            "ComponentWidth": 119,            "ComponentHeight": 43,            "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"        },        {            "ComponentType": "SIGN_SELECTOR",            "ComponentName": "是否同意此协议",            "Placeholder": "",            "ComponentOffsetX": 50,            "ComponentOffsetY": 130,            "ComponentWidth": 120,            "ComponentHeight": 43,            "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"        },        {            "ComponentType": "SIGN_MULTI_LINE_TEXT",            "ComponentName": "批注附言",            "Placeholder": "",            "ComponentOffsetX": 150,            "ComponentOffsetY": 300,            "ComponentWidth": 200,            "ComponentHeight": 86,            "ComponentExtra": ""        }    ]}

• ComponentValue: (p) —

  控件填充vaule，ComponentType和传入值类型对应关系：

  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
  • DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
  • SIGN_SEAL : 印章ID，于控制台查询获取，点击查看在控制上的位置
  • SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取，点击查看在控制上的位置

  控件值约束说明：

  特殊控件	填写约束
  企业全称控件	企业名称中文字符中文括号
  统一社会信用代码控件	企业注册的统一社会信用代码
  法人名称控件	最大50个字符，2到25个汉字或者1到50个字母
  签署意见控件	签署意见最大长度为50字符
  签署人手机号控件	国内手机号 13,14,15,16,17,18,19号段长度11位
  签署人身份证控件	合法的身份证号码检查
  控件名称	控件名称最大长度为20字符，不支持表情
  单行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  多行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  勾选框控件	选择填字符串true，不选填字符串false
  选择器控件	同单行文本控件约束，填写选择值中的字符串
  数字控件	请输入有效的数字(可带小数点)
  日期控件	格式：yyyy年mm月dd日
  附件控件	JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID
  图片控件	JPG或PNG图片，填写上传的图片资源ID
  邮箱控件	有效的邮箱地址, w3c标准
  地址控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  省市区控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  性别控件	选择值中的字符串
  学历控件	选择值中的字符串
  水印控件	水印控件设置为CUSTOM_WATERMARK类型时的水印内容

  注： 部分特殊控件需要在控制台配置模板形式创建

• ComponentDateFontSize: (p) —

  【暂未使用】日期签署控件的字号，默认为 12

• DocumentId: (p) —

  【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可

• ComponentDescription: (p) —

  【暂未使用】控件描述，用户自定义，不影响合同发起流程

• OffsetX: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
  注意： 向左调整设置为负数， 向右调整设置成正数

• OffsetY: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
  注意： 向上调整设置为负数， 向下调整设置成正数

• ChannelComponentId: (p) —

  【暂未使用】第三方应用集成平台模板控件 ID 标识

• KeywordOrder: (p) —

  如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。

  • Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列
  • Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列

  在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。

• KeywordPage: (p) —

  如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。

• RelativeLocation: (p) —

  如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值

  • Middle :居中
  • Below :正下方
  • Right :正右方
  • LowerRight :右下角
  • UpperRight :右上角。

  示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方

• KeywordIndexes: (p) —

  如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

  注意：关键字索引是从0开始计数的

• Placeholder: (p) —

  填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
  注：签署控件设置此字段无效

• LockComponentValue: (p) —

  web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑

  • false（默认）：不锁定控件值，允许在页面编辑控件值
  • true：锁定控件值，在页面无法编辑控件值

• ForbidMoveAndDelete: (p) —

  web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件

  • false（默认） :可以移动和删除控件
  • true : 禁止移动和删除控件

# File 'lib/v20210526/models.rb', line 5329

def ComponentRequired
  @ComponentRequired
end

#ComponentType ⇒ Object

Parameters:

• ComponentId: (p) —

  控件唯一ID。

  在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

  例：

  • 如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。
  • 如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。

  注：控件ID可以在一个PDF中不可重复
  点击查看ComponentId在模板页面的位置

• ComponentType: (p) —

  如果是Component填写控件类型，则可选的字段为：

  • TEXT : 普通文本控件，输入文本字符串；
  • MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；
  • CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
  • FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；
  • DYNAMIC_TABLE : 动态表格控件；
  • ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
  • SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；
  • DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；
  • DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
  • VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容

  如果是SignComponent签署控件类型，
  需要根据签署人的类型可选的字段为

  • 企业方
    • SIGN_SEAL : 签署印章控件；
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
    • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。

  • 个人方
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择

  注：表单域的控件不能作为印章和签名控件

• ComponentName: (p) —

  在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。

  注：控件名可以在一个PDF中可以重复

  点击查看ComponentName在模板页面的位置

• ComponentRequired: (p) —

  如果是填写控件，ComponentRequired表示在填写页面此控件是否必填

  • false（默认）：可以不填写
  • true ：必须填写此填写控件

  如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响

• ComponentRecipientId: (p) —

  在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可

• FileIndex: (p) —

  【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0

• GenerateMode: (p) —

  控件生成的方式：

  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）

• ComponentWidth: (p) —

  在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。

• ComponentHeight: (p) —

  在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。

• ComponentPage: (p) —

  在绝对定位方式方式下，指定控件所在PDF文件上的页码
  在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。

  注：

  1. 页码编号是从1开始编号的。
  2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。

• ComponentPosX: (p) —

  在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。

• ComponentPosY: (p) —

  在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。

• ComponentExtra: (p) —

  在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。

  ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • FontAlign： Left/Right/Center，左对齐/居中/右对齐
  • FontColor：字符串类型，格式为RGB颜色数字
  • Bold是否加粗：true/false

  参数样例：{"FontColor":"255,0,0","FontSize":12,"Bold":false}

  ComponentType为DATE时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72

  参数样例：{"FontColor":"255,0,0","FontSize":12}

  ComponentType为WATERMARK时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • Opacity： 透明度，范围0 :1
  • Rotate： 水印旋转角度，范围0 :359
  • Density： 水印样式，1-宽松，2-标准（默认值），3-密集，
  • Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中
  • SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息

  参数样例："{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"

  ComponentType为FILL_IMAGE时，支持以下参数：

  • NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中
  • FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放

  ComponentType为SELECTOR时，支持以下参数：

  • WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成

  ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以ComponentTypeLimit参数控制签署方式

  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

  参考样例：{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}印章的对应关系参考下图
  
  ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型，支持指定以下印章类型

  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章
  • OTHER : 其他

  参考样例：{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。
  
  

  ComponentType为SIGN_DATE时，支持以下参数：

  • Font :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"
  • FontSize : 数字类型，范围6-72，默认值为12
  • FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
  • Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
  • Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数

  如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"

  ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：

  • PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）

  参数样例："{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"

  签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时，可以通过以下参数设置签署图片的旋转角度：

  • Rotate：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。
  • RotateRelation：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。

  参数样例：{"Rotate":-30,"RotateRelation":"Component_Id1"}

  签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：

  • Opacity：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度

  参数样例：{"Opacity":0.7}

  签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：

  • UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false

  参数样例：{"UseSealSize":true}

  签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：

  • Values：签署意见预设的需要用户填写的文本
  • ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）

  参数样例：{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}

  关键字模式下支持关键字找不到的情况下不进行报错的设置

  • IgnoreKeywordError :1-关键字查找不到时不进行报错

  场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例："{"IgnoreKeywordError":1}"

  ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：

  • Children: 绝对定位模式下，用来指定此签批控件的组合子控件
  参数样例：
  {"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}
  • ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件
  ChildrenComponent结构体定义:

  字段名称	类型	描述
  ComponentType	string	子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT
  ComponentName	string	子控件名称
  Placeholder	string	子控件提示语
  ComponentValue	string	子控件值（签署方不可设置）
  ComponentOffsetX	float	控件偏移位置X（相对于父控件（签批控件的ComponentX））
  ComponentOffsetY	float	控件偏移位置Y 相对于父控件（签批控件的ComponentY））
  ComponentWidth	float	控件宽
  ComponentHeight	float	控件高
  ComponentExtra	string	控件的附属信息，根据ComponentType设置

  参数样例：

  {    "ChildrenComponents": [        {            "ComponentType": "SIGN_SIGNATURE",            "ComponentName": "个人签名",            "Placeholder": "请签名",            "ComponentOffsetX": 10,            "ComponentOffsetY": 30,            "ComponentWidth": 119,            "ComponentHeight": 43,            "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"        },        {            "ComponentType": "SIGN_SELECTOR",            "ComponentName": "是否同意此协议",            "Placeholder": "",            "ComponentOffsetX": 50,            "ComponentOffsetY": 130,            "ComponentWidth": 120,            "ComponentHeight": 43,            "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"        },        {            "ComponentType": "SIGN_MULTI_LINE_TEXT",            "ComponentName": "批注附言",            "Placeholder": "",            "ComponentOffsetX": 150,            "ComponentOffsetY": 300,            "ComponentWidth": 200,            "ComponentHeight": 86,            "ComponentExtra": ""        }    ]}

• ComponentValue: (p) —

  控件填充vaule，ComponentType和传入值类型对应关系：

  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
  • DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
  • SIGN_SEAL : 印章ID，于控制台查询获取，点击查看在控制上的位置
  • SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取，点击查看在控制上的位置

  控件值约束说明：

  特殊控件	填写约束
  企业全称控件	企业名称中文字符中文括号
  统一社会信用代码控件	企业注册的统一社会信用代码
  法人名称控件	最大50个字符，2到25个汉字或者1到50个字母
  签署意见控件	签署意见最大长度为50字符
  签署人手机号控件	国内手机号 13,14,15,16,17,18,19号段长度11位
  签署人身份证控件	合法的身份证号码检查
  控件名称	控件名称最大长度为20字符，不支持表情
  单行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  多行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  勾选框控件	选择填字符串true，不选填字符串false
  选择器控件	同单行文本控件约束，填写选择值中的字符串
  数字控件	请输入有效的数字(可带小数点)
  日期控件	格式：yyyy年mm月dd日
  附件控件	JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID
  图片控件	JPG或PNG图片，填写上传的图片资源ID
  邮箱控件	有效的邮箱地址, w3c标准
  地址控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  省市区控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  性别控件	选择值中的字符串
  学历控件	选择值中的字符串
  水印控件	水印控件设置为CUSTOM_WATERMARK类型时的水印内容

  注： 部分特殊控件需要在控制台配置模板形式创建

• ComponentDateFontSize: (p) —

  【暂未使用】日期签署控件的字号，默认为 12

• DocumentId: (p) —

  【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可

• ComponentDescription: (p) —

  【暂未使用】控件描述，用户自定义，不影响合同发起流程

• OffsetX: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
  注意： 向左调整设置为负数， 向右调整设置成正数

• OffsetY: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
  注意： 向上调整设置为负数， 向下调整设置成正数

• ChannelComponentId: (p) —

  【暂未使用】第三方应用集成平台模板控件 ID 标识

• KeywordOrder: (p) —

  如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。

  • Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列
  • Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列

  在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。

• KeywordPage: (p) —

  如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。

• RelativeLocation: (p) —

  如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值

  • Middle :居中
  • Below :正下方
  • Right :正右方
  • LowerRight :右下角
  • UpperRight :右上角。

  示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方

• KeywordIndexes: (p) —

  如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

  注意：关键字索引是从0开始计数的

• Placeholder: (p) —

  填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
  注：签署控件设置此字段无效

• LockComponentValue: (p) —

  web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑

  • false（默认）：不锁定控件值，允许在页面编辑控件值
  • true：锁定控件值，在页面无法编辑控件值

• ForbidMoveAndDelete: (p) —

  web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件

  • false（默认） :可以移动和删除控件
  • true : 禁止移动和删除控件

# File 'lib/v20210526/models.rb', line 5329

def ComponentType
  @ComponentType
end

#ComponentValue ⇒ Object

Parameters:

• ComponentId: (p) —

  控件唯一ID。

  在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

  例：

  • 如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。
  • 如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。

  注：控件ID可以在一个PDF中不可重复
  点击查看ComponentId在模板页面的位置

• ComponentType: (p) —

  如果是Component填写控件类型，则可选的字段为：

  • TEXT : 普通文本控件，输入文本字符串；
  • MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；
  • CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
  • FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；
  • DYNAMIC_TABLE : 动态表格控件；
  • ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
  • SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；
  • DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；
  • DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
  • VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容

  如果是SignComponent签署控件类型，
  需要根据签署人的类型可选的字段为

  • 企业方
    • SIGN_SEAL : 签署印章控件；
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
    • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。

  • 个人方
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择

  注：表单域的控件不能作为印章和签名控件

• ComponentName: (p) —

  在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。

  注：控件名可以在一个PDF中可以重复

  点击查看ComponentName在模板页面的位置

• ComponentRequired: (p) —

  如果是填写控件，ComponentRequired表示在填写页面此控件是否必填

  • false（默认）：可以不填写
  • true ：必须填写此填写控件

  如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响

• ComponentRecipientId: (p) —

  在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可

• FileIndex: (p) —

  【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0

• GenerateMode: (p) —

  控件生成的方式：

  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）

• ComponentWidth: (p) —

  在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。

• ComponentHeight: (p) —

  在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。

• ComponentPage: (p) —

  在绝对定位方式方式下，指定控件所在PDF文件上的页码
  在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。

  注：

  1. 页码编号是从1开始编号的。
  2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。

• ComponentPosX: (p) —

  在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。

• ComponentPosY: (p) —

  在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。

• ComponentExtra: (p) —

  在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。

  ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • FontAlign： Left/Right/Center，左对齐/居中/右对齐
  • FontColor：字符串类型，格式为RGB颜色数字
  • Bold是否加粗：true/false

  参数样例：{"FontColor":"255,0,0","FontSize":12,"Bold":false}

  ComponentType为DATE时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72

  参数样例：{"FontColor":"255,0,0","FontSize":12}

  ComponentType为WATERMARK时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • Opacity： 透明度，范围0 :1
  • Rotate： 水印旋转角度，范围0 :359
  • Density： 水印样式，1-宽松，2-标准（默认值），3-密集，
  • Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中
  • SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息

  参数样例："{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"

  ComponentType为FILL_IMAGE时，支持以下参数：

  • NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中
  • FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放

  ComponentType为SELECTOR时，支持以下参数：

  • WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成

  ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以ComponentTypeLimit参数控制签署方式

  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

  参考样例：{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}印章的对应关系参考下图
  
  ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型，支持指定以下印章类型

  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章
  • OTHER : 其他

  参考样例：{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。
  
  

  ComponentType为SIGN_DATE时，支持以下参数：

  • Font :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"
  • FontSize : 数字类型，范围6-72，默认值为12
  • FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
  • Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
  • Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数

  如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"

  ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：

  • PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）

  参数样例："{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"

  签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时，可以通过以下参数设置签署图片的旋转角度：

  • Rotate：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。
  • RotateRelation：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。

  参数样例：{"Rotate":-30,"RotateRelation":"Component_Id1"}

  签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：

  • Opacity：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度

  参数样例：{"Opacity":0.7}

  签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：

  • UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false

  参数样例：{"UseSealSize":true}

  签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：

  • Values：签署意见预设的需要用户填写的文本
  • ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）

  参数样例：{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}

  关键字模式下支持关键字找不到的情况下不进行报错的设置

  • IgnoreKeywordError :1-关键字查找不到时不进行报错

  场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例："{"IgnoreKeywordError":1}"

  ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：

  • Children: 绝对定位模式下，用来指定此签批控件的组合子控件
  参数样例：
  {"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}
  • ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件
  ChildrenComponent结构体定义:

  字段名称	类型	描述
  ComponentType	string	子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT
  ComponentName	string	子控件名称
  Placeholder	string	子控件提示语
  ComponentValue	string	子控件值（签署方不可设置）
  ComponentOffsetX	float	控件偏移位置X（相对于父控件（签批控件的ComponentX））
  ComponentOffsetY	float	控件偏移位置Y 相对于父控件（签批控件的ComponentY））
  ComponentWidth	float	控件宽
  ComponentHeight	float	控件高
  ComponentExtra	string	控件的附属信息，根据ComponentType设置

  参数样例：

  {    "ChildrenComponents": [        {            "ComponentType": "SIGN_SIGNATURE",            "ComponentName": "个人签名",            "Placeholder": "请签名",            "ComponentOffsetX": 10,            "ComponentOffsetY": 30,            "ComponentWidth": 119,            "ComponentHeight": 43,            "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"        },        {            "ComponentType": "SIGN_SELECTOR",            "ComponentName": "是否同意此协议",            "Placeholder": "",            "ComponentOffsetX": 50,            "ComponentOffsetY": 130,            "ComponentWidth": 120,            "ComponentHeight": 43,            "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"        },        {            "ComponentType": "SIGN_MULTI_LINE_TEXT",            "ComponentName": "批注附言",            "Placeholder": "",            "ComponentOffsetX": 150,            "ComponentOffsetY": 300,            "ComponentWidth": 200,            "ComponentHeight": 86,            "ComponentExtra": ""        }    ]}

• ComponentValue: (p) —

  控件填充vaule，ComponentType和传入值类型对应关系：

  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
  • DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
  • SIGN_SEAL : 印章ID，于控制台查询获取，点击查看在控制上的位置
  • SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取，点击查看在控制上的位置

  控件值约束说明：

  特殊控件	填写约束
  企业全称控件	企业名称中文字符中文括号
  统一社会信用代码控件	企业注册的统一社会信用代码
  法人名称控件	最大50个字符，2到25个汉字或者1到50个字母
  签署意见控件	签署意见最大长度为50字符
  签署人手机号控件	国内手机号 13,14,15,16,17,18,19号段长度11位
  签署人身份证控件	合法的身份证号码检查
  控件名称	控件名称最大长度为20字符，不支持表情
  单行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  多行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  勾选框控件	选择填字符串true，不选填字符串false
  选择器控件	同单行文本控件约束，填写选择值中的字符串
  数字控件	请输入有效的数字(可带小数点)
  日期控件	格式：yyyy年mm月dd日
  附件控件	JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID
  图片控件	JPG或PNG图片，填写上传的图片资源ID
  邮箱控件	有效的邮箱地址, w3c标准
  地址控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  省市区控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  性别控件	选择值中的字符串
  学历控件	选择值中的字符串
  水印控件	水印控件设置为CUSTOM_WATERMARK类型时的水印内容

  注： 部分特殊控件需要在控制台配置模板形式创建

• ComponentDateFontSize: (p) —

  【暂未使用】日期签署控件的字号，默认为 12

• DocumentId: (p) —

  【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可

• ComponentDescription: (p) —

  【暂未使用】控件描述，用户自定义，不影响合同发起流程

• OffsetX: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
  注意： 向左调整设置为负数， 向右调整设置成正数

• OffsetY: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
  注意： 向上调整设置为负数， 向下调整设置成正数

• ChannelComponentId: (p) —

  【暂未使用】第三方应用集成平台模板控件 ID 标识

• KeywordOrder: (p) —

  如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。

  • Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列
  • Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列

  在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。

• KeywordPage: (p) —

  如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。

• RelativeLocation: (p) —

  如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值

  • Middle :居中
  • Below :正下方
  • Right :正右方
  • LowerRight :右下角
  • UpperRight :右上角。

  示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方

• KeywordIndexes: (p) —

  如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

  注意：关键字索引是从0开始计数的

• Placeholder: (p) —

  填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
  注：签署控件设置此字段无效

• LockComponentValue: (p) —

  web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑

  • false（默认）：不锁定控件值，允许在页面编辑控件值
  • true：锁定控件值，在页面无法编辑控件值

• ForbidMoveAndDelete: (p) —

  web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件

  • false（默认） :可以移动和删除控件
  • true : 禁止移动和删除控件

# File 'lib/v20210526/models.rb', line 5329

def ComponentValue
  @ComponentValue
end

#ComponentWidth ⇒ Object

Parameters:

• ComponentId: (p) —

  控件唯一ID。

  在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

  例：

  • 如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。
  • 如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。

  注：控件ID可以在一个PDF中不可重复
  点击查看ComponentId在模板页面的位置

• ComponentType: (p) —

  如果是Component填写控件类型，则可选的字段为：

  • TEXT : 普通文本控件，输入文本字符串；
  • MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；
  • CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
  • FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；
  • DYNAMIC_TABLE : 动态表格控件；
  • ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
  • SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；
  • DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；
  • DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
  • VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容

  如果是SignComponent签署控件类型，
  需要根据签署人的类型可选的字段为

  • 企业方
    • SIGN_SEAL : 签署印章控件；
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
    • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。

  • 个人方
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择

  注：表单域的控件不能作为印章和签名控件

• ComponentName: (p) —

  在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。

  注：控件名可以在一个PDF中可以重复

  点击查看ComponentName在模板页面的位置

• ComponentRequired: (p) —

  如果是填写控件，ComponentRequired表示在填写页面此控件是否必填

  • false（默认）：可以不填写
  • true ：必须填写此填写控件

  如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响

• ComponentRecipientId: (p) —

  在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可

• FileIndex: (p) —

  【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0

• GenerateMode: (p) —

  控件生成的方式：

  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）

• ComponentWidth: (p) —

  在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。

• ComponentHeight: (p) —

  在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。

• ComponentPage: (p) —

  在绝对定位方式方式下，指定控件所在PDF文件上的页码
  在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。

  注：

  1. 页码编号是从1开始编号的。
  2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。

• ComponentPosX: (p) —

  在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。

• ComponentPosY: (p) —

  在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。

• ComponentExtra: (p) —

  在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。

  ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • FontAlign： Left/Right/Center，左对齐/居中/右对齐
  • FontColor：字符串类型，格式为RGB颜色数字
  • Bold是否加粗：true/false

  参数样例：{"FontColor":"255,0,0","FontSize":12,"Bold":false}

  ComponentType为DATE时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72

  参数样例：{"FontColor":"255,0,0","FontSize":12}

  ComponentType为WATERMARK时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • Opacity： 透明度，范围0 :1
  • Rotate： 水印旋转角度，范围0 :359
  • Density： 水印样式，1-宽松，2-标准（默认值），3-密集，
  • Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中
  • SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息

  参数样例："{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"

  ComponentType为FILL_IMAGE时，支持以下参数：

  • NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中
  • FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放

  ComponentType为SELECTOR时，支持以下参数：

  • WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成

  ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以ComponentTypeLimit参数控制签署方式

  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

  参考样例：{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}印章的对应关系参考下图
  
  ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型，支持指定以下印章类型

  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章
  • OTHER : 其他

  参考样例：{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。
  
  

  ComponentType为SIGN_DATE时，支持以下参数：

  • Font :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"
  • FontSize : 数字类型，范围6-72，默认值为12
  • FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
  • Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
  • Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数

  如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"

  ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：

  • PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）

  参数样例："{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"

  签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时，可以通过以下参数设置签署图片的旋转角度：

  • Rotate：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。
  • RotateRelation：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。

  参数样例：{"Rotate":-30,"RotateRelation":"Component_Id1"}

  签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：

  • Opacity：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度

  参数样例：{"Opacity":0.7}

  签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：

  • UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false

  参数样例：{"UseSealSize":true}

  签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：

  • Values：签署意见预设的需要用户填写的文本
  • ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）

  参数样例：{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}

  关键字模式下支持关键字找不到的情况下不进行报错的设置

  • IgnoreKeywordError :1-关键字查找不到时不进行报错

  场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例："{"IgnoreKeywordError":1}"

  ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：

  • Children: 绝对定位模式下，用来指定此签批控件的组合子控件
  参数样例：
  {"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}
  • ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件
  ChildrenComponent结构体定义:

  字段名称	类型	描述
  ComponentType	string	子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT
  ComponentName	string	子控件名称
  Placeholder	string	子控件提示语
  ComponentValue	string	子控件值（签署方不可设置）
  ComponentOffsetX	float	控件偏移位置X（相对于父控件（签批控件的ComponentX））
  ComponentOffsetY	float	控件偏移位置Y 相对于父控件（签批控件的ComponentY））
  ComponentWidth	float	控件宽
  ComponentHeight	float	控件高
  ComponentExtra	string	控件的附属信息，根据ComponentType设置

  参数样例：

  {    "ChildrenComponents": [        {            "ComponentType": "SIGN_SIGNATURE",            "ComponentName": "个人签名",            "Placeholder": "请签名",            "ComponentOffsetX": 10,            "ComponentOffsetY": 30,            "ComponentWidth": 119,            "ComponentHeight": 43,            "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"        },        {            "ComponentType": "SIGN_SELECTOR",            "ComponentName": "是否同意此协议",            "Placeholder": "",            "ComponentOffsetX": 50,            "ComponentOffsetY": 130,            "ComponentWidth": 120,            "ComponentHeight": 43,            "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"        },        {            "ComponentType": "SIGN_MULTI_LINE_TEXT",            "ComponentName": "批注附言",            "Placeholder": "",            "ComponentOffsetX": 150,            "ComponentOffsetY": 300,            "ComponentWidth": 200,            "ComponentHeight": 86,            "ComponentExtra": ""        }    ]}

• ComponentValue: (p) —

  控件填充vaule，ComponentType和传入值类型对应关系：

  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
  • DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
  • SIGN_SEAL : 印章ID，于控制台查询获取，点击查看在控制上的位置
  • SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取，点击查看在控制上的位置

  控件值约束说明：

  特殊控件	填写约束
  企业全称控件	企业名称中文字符中文括号
  统一社会信用代码控件	企业注册的统一社会信用代码
  法人名称控件	最大50个字符，2到25个汉字或者1到50个字母
  签署意见控件	签署意见最大长度为50字符
  签署人手机号控件	国内手机号 13,14,15,16,17,18,19号段长度11位
  签署人身份证控件	合法的身份证号码检查
  控件名称	控件名称最大长度为20字符，不支持表情
  单行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  多行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  勾选框控件	选择填字符串true，不选填字符串false
  选择器控件	同单行文本控件约束，填写选择值中的字符串
  数字控件	请输入有效的数字(可带小数点)
  日期控件	格式：yyyy年mm月dd日
  附件控件	JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID
  图片控件	JPG或PNG图片，填写上传的图片资源ID
  邮箱控件	有效的邮箱地址, w3c标准
  地址控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  省市区控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  性别控件	选择值中的字符串
  学历控件	选择值中的字符串
  水印控件	水印控件设置为CUSTOM_WATERMARK类型时的水印内容

  注： 部分特殊控件需要在控制台配置模板形式创建

• ComponentDateFontSize: (p) —

  【暂未使用】日期签署控件的字号，默认为 12

• DocumentId: (p) —

  【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可

• ComponentDescription: (p) —

  【暂未使用】控件描述，用户自定义，不影响合同发起流程

• OffsetX: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
  注意： 向左调整设置为负数， 向右调整设置成正数

• OffsetY: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
  注意： 向上调整设置为负数， 向下调整设置成正数

• ChannelComponentId: (p) —

  【暂未使用】第三方应用集成平台模板控件 ID 标识

• KeywordOrder: (p) —

  如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。

  • Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列
  • Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列

  在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。

• KeywordPage: (p) —

  如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。

• RelativeLocation: (p) —

  如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值

  • Middle :居中
  • Below :正下方
  • Right :正右方
  • LowerRight :右下角
  • UpperRight :右上角。

  示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方

• KeywordIndexes: (p) —

  如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

  注意：关键字索引是从0开始计数的

• Placeholder: (p) —

  填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
  注：签署控件设置此字段无效

• LockComponentValue: (p) —

  web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑

  • false（默认）：不锁定控件值，允许在页面编辑控件值
  • true：锁定控件值，在页面无法编辑控件值

• ForbidMoveAndDelete: (p) —

  web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件

  • false（默认） :可以移动和删除控件
  • true : 禁止移动和删除控件

# File 'lib/v20210526/models.rb', line 5329

def ComponentWidth
  @ComponentWidth
end

#DocumentId ⇒ Object

Parameters:

• ComponentId: (p) —

  控件唯一ID。

  在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

  例：

  • 如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。
  • 如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。

  注：控件ID可以在一个PDF中不可重复
  点击查看ComponentId在模板页面的位置

• ComponentType: (p) —

  如果是Component填写控件类型，则可选的字段为：

  • TEXT : 普通文本控件，输入文本字符串；
  • MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；
  • CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
  • FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；
  • DYNAMIC_TABLE : 动态表格控件；
  • ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
  • SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；
  • DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；
  • DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
  • VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容

  如果是SignComponent签署控件类型，
  需要根据签署人的类型可选的字段为

  • 企业方
    • SIGN_SEAL : 签署印章控件；
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
    • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。

  • 个人方
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择

  注：表单域的控件不能作为印章和签名控件

• ComponentName: (p) —

  在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。

  注：控件名可以在一个PDF中可以重复

  点击查看ComponentName在模板页面的位置

• ComponentRequired: (p) —

  如果是填写控件，ComponentRequired表示在填写页面此控件是否必填

  • false（默认）：可以不填写
  • true ：必须填写此填写控件

  如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响

• ComponentRecipientId: (p) —

  在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可

• FileIndex: (p) —

  【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0

• GenerateMode: (p) —

  控件生成的方式：

  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）

• ComponentWidth: (p) —

  在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。

• ComponentHeight: (p) —

  在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。

• ComponentPage: (p) —

  在绝对定位方式方式下，指定控件所在PDF文件上的页码
  在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。

  注：

  1. 页码编号是从1开始编号的。
  2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。

• ComponentPosX: (p) —

  在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。

• ComponentPosY: (p) —

  在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。

• ComponentExtra: (p) —

  在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。

  ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • FontAlign： Left/Right/Center，左对齐/居中/右对齐
  • FontColor：字符串类型，格式为RGB颜色数字
  • Bold是否加粗：true/false

  参数样例：{"FontColor":"255,0,0","FontSize":12,"Bold":false}

  ComponentType为DATE时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72

  参数样例：{"FontColor":"255,0,0","FontSize":12}

  ComponentType为WATERMARK时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • Opacity： 透明度，范围0 :1
  • Rotate： 水印旋转角度，范围0 :359
  • Density： 水印样式，1-宽松，2-标准（默认值），3-密集，
  • Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中
  • SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息

  参数样例："{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"

  ComponentType为FILL_IMAGE时，支持以下参数：

  • NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中
  • FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放

  ComponentType为SELECTOR时，支持以下参数：

  • WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成

  ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以ComponentTypeLimit参数控制签署方式

  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

  参考样例：{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}印章的对应关系参考下图
  
  ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型，支持指定以下印章类型

  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章
  • OTHER : 其他

  参考样例：{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。
  
  

  ComponentType为SIGN_DATE时，支持以下参数：

  • Font :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"
  • FontSize : 数字类型，范围6-72，默认值为12
  • FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
  • Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
  • Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数

  如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"

  ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：

  • PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）

  参数样例："{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"

  签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时，可以通过以下参数设置签署图片的旋转角度：

  • Rotate：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。
  • RotateRelation：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。

  参数样例：{"Rotate":-30,"RotateRelation":"Component_Id1"}

  签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：

  • Opacity：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度

  参数样例：{"Opacity":0.7}

  签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：

  • UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false

  参数样例：{"UseSealSize":true}

  签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：

  • Values：签署意见预设的需要用户填写的文本
  • ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）

  参数样例：{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}

  关键字模式下支持关键字找不到的情况下不进行报错的设置

  • IgnoreKeywordError :1-关键字查找不到时不进行报错

  场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例："{"IgnoreKeywordError":1}"

  ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：

  • Children: 绝对定位模式下，用来指定此签批控件的组合子控件
  参数样例：
  {"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}
  • ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件
  ChildrenComponent结构体定义:

  字段名称	类型	描述
  ComponentType	string	子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT
  ComponentName	string	子控件名称
  Placeholder	string	子控件提示语
  ComponentValue	string	子控件值（签署方不可设置）
  ComponentOffsetX	float	控件偏移位置X（相对于父控件（签批控件的ComponentX））
  ComponentOffsetY	float	控件偏移位置Y 相对于父控件（签批控件的ComponentY））
  ComponentWidth	float	控件宽
  ComponentHeight	float	控件高
  ComponentExtra	string	控件的附属信息，根据ComponentType设置

  参数样例：

  {    "ChildrenComponents": [        {            "ComponentType": "SIGN_SIGNATURE",            "ComponentName": "个人签名",            "Placeholder": "请签名",            "ComponentOffsetX": 10,            "ComponentOffsetY": 30,            "ComponentWidth": 119,            "ComponentHeight": 43,            "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"        },        {            "ComponentType": "SIGN_SELECTOR",            "ComponentName": "是否同意此协议",            "Placeholder": "",            "ComponentOffsetX": 50,            "ComponentOffsetY": 130,            "ComponentWidth": 120,            "ComponentHeight": 43,            "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"        },        {            "ComponentType": "SIGN_MULTI_LINE_TEXT",            "ComponentName": "批注附言",            "Placeholder": "",            "ComponentOffsetX": 150,            "ComponentOffsetY": 300,            "ComponentWidth": 200,            "ComponentHeight": 86,            "ComponentExtra": ""        }    ]}

• ComponentValue: (p) —

  控件填充vaule，ComponentType和传入值类型对应关系：

  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
  • DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
  • SIGN_SEAL : 印章ID，于控制台查询获取，点击查看在控制上的位置
  • SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取，点击查看在控制上的位置

  控件值约束说明：

  特殊控件	填写约束
  企业全称控件	企业名称中文字符中文括号
  统一社会信用代码控件	企业注册的统一社会信用代码
  法人名称控件	最大50个字符，2到25个汉字或者1到50个字母
  签署意见控件	签署意见最大长度为50字符
  签署人手机号控件	国内手机号 13,14,15,16,17,18,19号段长度11位
  签署人身份证控件	合法的身份证号码检查
  控件名称	控件名称最大长度为20字符，不支持表情
  单行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  多行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  勾选框控件	选择填字符串true，不选填字符串false
  选择器控件	同单行文本控件约束，填写选择值中的字符串
  数字控件	请输入有效的数字(可带小数点)
  日期控件	格式：yyyy年mm月dd日
  附件控件	JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID
  图片控件	JPG或PNG图片，填写上传的图片资源ID
  邮箱控件	有效的邮箱地址, w3c标准
  地址控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  省市区控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  性别控件	选择值中的字符串
  学历控件	选择值中的字符串
  水印控件	水印控件设置为CUSTOM_WATERMARK类型时的水印内容

  注： 部分特殊控件需要在控制台配置模板形式创建

• ComponentDateFontSize: (p) —

  【暂未使用】日期签署控件的字号，默认为 12

• DocumentId: (p) —

  【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可

• ComponentDescription: (p) —

  【暂未使用】控件描述，用户自定义，不影响合同发起流程

• OffsetX: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
  注意： 向左调整设置为负数， 向右调整设置成正数

• OffsetY: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
  注意： 向上调整设置为负数， 向下调整设置成正数

• ChannelComponentId: (p) —

  【暂未使用】第三方应用集成平台模板控件 ID 标识

• KeywordOrder: (p) —

  如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。

  • Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列
  • Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列

  在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。

• KeywordPage: (p) —

  如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。

• RelativeLocation: (p) —

  如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值

  • Middle :居中
  • Below :正下方
  • Right :正右方
  • LowerRight :右下角
  • UpperRight :右上角。

  示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方

• KeywordIndexes: (p) —

  如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

  注意：关键字索引是从0开始计数的

• Placeholder: (p) —

  填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
  注：签署控件设置此字段无效

• LockComponentValue: (p) —

  web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑

  • false（默认）：不锁定控件值，允许在页面编辑控件值
  • true：锁定控件值，在页面无法编辑控件值

• ForbidMoveAndDelete: (p) —

  web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件

  • false（默认） :可以移动和删除控件
  • true : 禁止移动和删除控件

# File 'lib/v20210526/models.rb', line 5329

def DocumentId
  @DocumentId
end

#FileIndex ⇒ Object

Parameters:

• ComponentId: (p) —

  控件唯一ID。

  在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

  例：

  • 如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。
  • 如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。

  注：控件ID可以在一个PDF中不可重复
  点击查看ComponentId在模板页面的位置

• ComponentType: (p) —

  如果是Component填写控件类型，则可选的字段为：

  • TEXT : 普通文本控件，输入文本字符串；
  • MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；
  • CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
  • FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；
  • DYNAMIC_TABLE : 动态表格控件；
  • ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
  • SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；
  • DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；
  • DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
  • VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容

  如果是SignComponent签署控件类型，
  需要根据签署人的类型可选的字段为

  • 企业方
    • SIGN_SEAL : 签署印章控件；
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
    • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。

  • 个人方
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择

  注：表单域的控件不能作为印章和签名控件

• ComponentName: (p) —

  在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。

  注：控件名可以在一个PDF中可以重复

  点击查看ComponentName在模板页面的位置

• ComponentRequired: (p) —

  如果是填写控件，ComponentRequired表示在填写页面此控件是否必填

  • false（默认）：可以不填写
  • true ：必须填写此填写控件

  如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响

• ComponentRecipientId: (p) —

  在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可

• FileIndex: (p) —

  【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0

• GenerateMode: (p) —

  控件生成的方式：

  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）

• ComponentWidth: (p) —

  在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。

• ComponentHeight: (p) —

  在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。

• ComponentPage: (p) —

  在绝对定位方式方式下，指定控件所在PDF文件上的页码
  在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。

  注：

  1. 页码编号是从1开始编号的。
  2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。

• ComponentPosX: (p) —

  在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。

• ComponentPosY: (p) —

  在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。

• ComponentExtra: (p) —

  在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。

  ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • FontAlign： Left/Right/Center，左对齐/居中/右对齐
  • FontColor：字符串类型，格式为RGB颜色数字
  • Bold是否加粗：true/false

  参数样例：{"FontColor":"255,0,0","FontSize":12,"Bold":false}

  ComponentType为DATE时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72

  参数样例：{"FontColor":"255,0,0","FontSize":12}

  ComponentType为WATERMARK时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • Opacity： 透明度，范围0 :1
  • Rotate： 水印旋转角度，范围0 :359
  • Density： 水印样式，1-宽松，2-标准（默认值），3-密集，
  • Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中
  • SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息

  参数样例："{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"

  ComponentType为FILL_IMAGE时，支持以下参数：

  • NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中
  • FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放

  ComponentType为SELECTOR时，支持以下参数：

  • WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成

  ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以ComponentTypeLimit参数控制签署方式

  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

  参考样例：{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}印章的对应关系参考下图
  
  ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型，支持指定以下印章类型

  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章
  • OTHER : 其他

  参考样例：{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。
  
  

  ComponentType为SIGN_DATE时，支持以下参数：

  • Font :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"
  • FontSize : 数字类型，范围6-72，默认值为12
  • FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
  • Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
  • Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数

  如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"

  ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：

  • PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）

  参数样例："{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"

  签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时，可以通过以下参数设置签署图片的旋转角度：

  • Rotate：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。
  • RotateRelation：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。

  参数样例：{"Rotate":-30,"RotateRelation":"Component_Id1"}

  签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：

  • Opacity：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度

  参数样例：{"Opacity":0.7}

  签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：

  • UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false

  参数样例：{"UseSealSize":true}

  签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：

  • Values：签署意见预设的需要用户填写的文本
  • ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）

  参数样例：{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}

  关键字模式下支持关键字找不到的情况下不进行报错的设置

  • IgnoreKeywordError :1-关键字查找不到时不进行报错

  场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例："{"IgnoreKeywordError":1}"

  ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：

  • Children: 绝对定位模式下，用来指定此签批控件的组合子控件
  参数样例：
  {"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}
  • ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件
  ChildrenComponent结构体定义:

  字段名称	类型	描述
  ComponentType	string	子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT
  ComponentName	string	子控件名称
  Placeholder	string	子控件提示语
  ComponentValue	string	子控件值（签署方不可设置）
  ComponentOffsetX	float	控件偏移位置X（相对于父控件（签批控件的ComponentX））
  ComponentOffsetY	float	控件偏移位置Y 相对于父控件（签批控件的ComponentY））
  ComponentWidth	float	控件宽
  ComponentHeight	float	控件高
  ComponentExtra	string	控件的附属信息，根据ComponentType设置

  参数样例：

  {    "ChildrenComponents": [        {            "ComponentType": "SIGN_SIGNATURE",            "ComponentName": "个人签名",            "Placeholder": "请签名",            "ComponentOffsetX": 10,            "ComponentOffsetY": 30,            "ComponentWidth": 119,            "ComponentHeight": 43,            "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"        },        {            "ComponentType": "SIGN_SELECTOR",            "ComponentName": "是否同意此协议",            "Placeholder": "",            "ComponentOffsetX": 50,            "ComponentOffsetY": 130,            "ComponentWidth": 120,            "ComponentHeight": 43,            "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"        },        {            "ComponentType": "SIGN_MULTI_LINE_TEXT",            "ComponentName": "批注附言",            "Placeholder": "",            "ComponentOffsetX": 150,            "ComponentOffsetY": 300,            "ComponentWidth": 200,            "ComponentHeight": 86,            "ComponentExtra": ""        }    ]}

• ComponentValue: (p) —

  控件填充vaule，ComponentType和传入值类型对应关系：

  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
  • DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
  • SIGN_SEAL : 印章ID，于控制台查询获取，点击查看在控制上的位置
  • SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取，点击查看在控制上的位置

  控件值约束说明：

  特殊控件	填写约束
  企业全称控件	企业名称中文字符中文括号
  统一社会信用代码控件	企业注册的统一社会信用代码
  法人名称控件	最大50个字符，2到25个汉字或者1到50个字母
  签署意见控件	签署意见最大长度为50字符
  签署人手机号控件	国内手机号 13,14,15,16,17,18,19号段长度11位
  签署人身份证控件	合法的身份证号码检查
  控件名称	控件名称最大长度为20字符，不支持表情
  单行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  多行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  勾选框控件	选择填字符串true，不选填字符串false
  选择器控件	同单行文本控件约束，填写选择值中的字符串
  数字控件	请输入有效的数字(可带小数点)
  日期控件	格式：yyyy年mm月dd日
  附件控件	JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID
  图片控件	JPG或PNG图片，填写上传的图片资源ID
  邮箱控件	有效的邮箱地址, w3c标准
  地址控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  省市区控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  性别控件	选择值中的字符串
  学历控件	选择值中的字符串
  水印控件	水印控件设置为CUSTOM_WATERMARK类型时的水印内容

  注： 部分特殊控件需要在控制台配置模板形式创建

• ComponentDateFontSize: (p) —

  【暂未使用】日期签署控件的字号，默认为 12

• DocumentId: (p) —

  【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可

• ComponentDescription: (p) —

  【暂未使用】控件描述，用户自定义，不影响合同发起流程

• OffsetX: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
  注意： 向左调整设置为负数， 向右调整设置成正数

• OffsetY: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
  注意： 向上调整设置为负数， 向下调整设置成正数

• ChannelComponentId: (p) —

  【暂未使用】第三方应用集成平台模板控件 ID 标识

• KeywordOrder: (p) —

  如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。

  • Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列
  • Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列

  在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。

• KeywordPage: (p) —

  如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。

• RelativeLocation: (p) —

  如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值

  • Middle :居中
  • Below :正下方
  • Right :正右方
  • LowerRight :右下角
  • UpperRight :右上角。

  示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方

• KeywordIndexes: (p) —

  如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

  注意：关键字索引是从0开始计数的

• Placeholder: (p) —

  填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
  注：签署控件设置此字段无效

• LockComponentValue: (p) —

  web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑

  • false（默认）：不锁定控件值，允许在页面编辑控件值
  • true：锁定控件值，在页面无法编辑控件值

• ForbidMoveAndDelete: (p) —

  web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件

  • false（默认） :可以移动和删除控件
  • true : 禁止移动和删除控件

# File 'lib/v20210526/models.rb', line 5329

def FileIndex
  @FileIndex
end

#ForbidMoveAndDelete ⇒ Object

Parameters:

• ComponentId: (p) —

  控件唯一ID。

  在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

  例：

  • 如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。
  • 如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。

  注：控件ID可以在一个PDF中不可重复
  点击查看ComponentId在模板页面的位置

• ComponentType: (p) —

  如果是Component填写控件类型，则可选的字段为：

  • TEXT : 普通文本控件，输入文本字符串；
  • MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；
  • CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
  • FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；
  • DYNAMIC_TABLE : 动态表格控件；
  • ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
  • SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；
  • DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；
  • DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
  • VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容

  如果是SignComponent签署控件类型，
  需要根据签署人的类型可选的字段为

  • 企业方
    • SIGN_SEAL : 签署印章控件；
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
    • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。

  • 个人方
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择

  注：表单域的控件不能作为印章和签名控件

• ComponentName: (p) —

  在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。

  注：控件名可以在一个PDF中可以重复

  点击查看ComponentName在模板页面的位置

• ComponentRequired: (p) —

  如果是填写控件，ComponentRequired表示在填写页面此控件是否必填

  • false（默认）：可以不填写
  • true ：必须填写此填写控件

  如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响

• ComponentRecipientId: (p) —

  在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可

• FileIndex: (p) —

  【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0

• GenerateMode: (p) —

  控件生成的方式：

  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）

• ComponentWidth: (p) —

  在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。

• ComponentHeight: (p) —

  在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。

• ComponentPage: (p) —

  在绝对定位方式方式下，指定控件所在PDF文件上的页码
  在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。

  注：

  1. 页码编号是从1开始编号的。
  2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。

• ComponentPosX: (p) —

  在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。

• ComponentPosY: (p) —

  在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。

• ComponentExtra: (p) —

  在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。

  ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • FontAlign： Left/Right/Center，左对齐/居中/右对齐
  • FontColor：字符串类型，格式为RGB颜色数字
  • Bold是否加粗：true/false

  参数样例：{"FontColor":"255,0,0","FontSize":12,"Bold":false}

  ComponentType为DATE时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72

  参数样例：{"FontColor":"255,0,0","FontSize":12}

  ComponentType为WATERMARK时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • Opacity： 透明度，范围0 :1
  • Rotate： 水印旋转角度，范围0 :359
  • Density： 水印样式，1-宽松，2-标准（默认值），3-密集，
  • Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中
  • SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息

  参数样例："{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"

  ComponentType为FILL_IMAGE时，支持以下参数：

  • NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中
  • FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放

  ComponentType为SELECTOR时，支持以下参数：

  • WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成

  ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以ComponentTypeLimit参数控制签署方式

  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

  参考样例：{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}印章的对应关系参考下图
  
  ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型，支持指定以下印章类型

  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章
  • OTHER : 其他

  参考样例：{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。
  
  

  ComponentType为SIGN_DATE时，支持以下参数：

  • Font :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"
  • FontSize : 数字类型，范围6-72，默认值为12
  • FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
  • Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
  • Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数

  如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"

  ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：

  • PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）

  参数样例："{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"

  签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时，可以通过以下参数设置签署图片的旋转角度：

  • Rotate：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。
  • RotateRelation：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。

  参数样例：{"Rotate":-30,"RotateRelation":"Component_Id1"}

  签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：

  • Opacity：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度

  参数样例：{"Opacity":0.7}

  签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：

  • UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false

  参数样例：{"UseSealSize":true}

  签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：

  • Values：签署意见预设的需要用户填写的文本
  • ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）

  参数样例：{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}

  关键字模式下支持关键字找不到的情况下不进行报错的设置

  • IgnoreKeywordError :1-关键字查找不到时不进行报错

  场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例："{"IgnoreKeywordError":1}"

  ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：

  • Children: 绝对定位模式下，用来指定此签批控件的组合子控件
  参数样例：
  {"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}
  • ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件
  ChildrenComponent结构体定义:

  字段名称	类型	描述
  ComponentType	string	子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT
  ComponentName	string	子控件名称
  Placeholder	string	子控件提示语
  ComponentValue	string	子控件值（签署方不可设置）
  ComponentOffsetX	float	控件偏移位置X（相对于父控件（签批控件的ComponentX））
  ComponentOffsetY	float	控件偏移位置Y 相对于父控件（签批控件的ComponentY））
  ComponentWidth	float	控件宽
  ComponentHeight	float	控件高
  ComponentExtra	string	控件的附属信息，根据ComponentType设置

  参数样例：

  {    "ChildrenComponents": [        {            "ComponentType": "SIGN_SIGNATURE",            "ComponentName": "个人签名",            "Placeholder": "请签名",            "ComponentOffsetX": 10,            "ComponentOffsetY": 30,            "ComponentWidth": 119,            "ComponentHeight": 43,            "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"        },        {            "ComponentType": "SIGN_SELECTOR",            "ComponentName": "是否同意此协议",            "Placeholder": "",            "ComponentOffsetX": 50,            "ComponentOffsetY": 130,            "ComponentWidth": 120,            "ComponentHeight": 43,            "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"        },        {            "ComponentType": "SIGN_MULTI_LINE_TEXT",            "ComponentName": "批注附言",            "Placeholder": "",            "ComponentOffsetX": 150,            "ComponentOffsetY": 300,            "ComponentWidth": 200,            "ComponentHeight": 86,            "ComponentExtra": ""        }    ]}

• ComponentValue: (p) —

  控件填充vaule，ComponentType和传入值类型对应关系：

  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
  • DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
  • SIGN_SEAL : 印章ID，于控制台查询获取，点击查看在控制上的位置
  • SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取，点击查看在控制上的位置

  控件值约束说明：

  特殊控件	填写约束
  企业全称控件	企业名称中文字符中文括号
  统一社会信用代码控件	企业注册的统一社会信用代码
  法人名称控件	最大50个字符，2到25个汉字或者1到50个字母
  签署意见控件	签署意见最大长度为50字符
  签署人手机号控件	国内手机号 13,14,15,16,17,18,19号段长度11位
  签署人身份证控件	合法的身份证号码检查
  控件名称	控件名称最大长度为20字符，不支持表情
  单行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  多行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  勾选框控件	选择填字符串true，不选填字符串false
  选择器控件	同单行文本控件约束，填写选择值中的字符串
  数字控件	请输入有效的数字(可带小数点)
  日期控件	格式：yyyy年mm月dd日
  附件控件	JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID
  图片控件	JPG或PNG图片，填写上传的图片资源ID
  邮箱控件	有效的邮箱地址, w3c标准
  地址控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  省市区控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  性别控件	选择值中的字符串
  学历控件	选择值中的字符串
  水印控件	水印控件设置为CUSTOM_WATERMARK类型时的水印内容

  注： 部分特殊控件需要在控制台配置模板形式创建

• ComponentDateFontSize: (p) —

  【暂未使用】日期签署控件的字号，默认为 12

• DocumentId: (p) —

  【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可

• ComponentDescription: (p) —

  【暂未使用】控件描述，用户自定义，不影响合同发起流程

• OffsetX: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
  注意： 向左调整设置为负数， 向右调整设置成正数

• OffsetY: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
  注意： 向上调整设置为负数， 向下调整设置成正数

• ChannelComponentId: (p) —

  【暂未使用】第三方应用集成平台模板控件 ID 标识

• KeywordOrder: (p) —

  如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。

  • Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列
  • Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列

  在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。

• KeywordPage: (p) —

  如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。

• RelativeLocation: (p) —

  如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值

  • Middle :居中
  • Below :正下方
  • Right :正右方
  • LowerRight :右下角
  • UpperRight :右上角。

  示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方

• KeywordIndexes: (p) —

  如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

  注意：关键字索引是从0开始计数的

• Placeholder: (p) —

  填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
  注：签署控件设置此字段无效

• LockComponentValue: (p) —

  web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑

  • false（默认）：不锁定控件值，允许在页面编辑控件值
  • true：锁定控件值，在页面无法编辑控件值

• ForbidMoveAndDelete: (p) —

  web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件

  • false（默认） :可以移动和删除控件
  • true : 禁止移动和删除控件

# File 'lib/v20210526/models.rb', line 5329

def ForbidMoveAndDelete
  @ForbidMoveAndDelete
end

#GenerateMode ⇒ Object

Parameters:

• ComponentId: (p) —

  控件唯一ID。

  在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

  例：

  • 如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。
  • 如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。

  注：控件ID可以在一个PDF中不可重复
  点击查看ComponentId在模板页面的位置

• ComponentType: (p) —

  如果是Component填写控件类型，则可选的字段为：

  • TEXT : 普通文本控件，输入文本字符串；
  • MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；
  • CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
  • FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；
  • DYNAMIC_TABLE : 动态表格控件；
  • ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
  • SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；
  • DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；
  • DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
  • VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容

  如果是SignComponent签署控件类型，
  需要根据签署人的类型可选的字段为

  • 企业方
    • SIGN_SEAL : 签署印章控件；
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
    • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。

  • 个人方
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择

  注：表单域的控件不能作为印章和签名控件

• ComponentName: (p) —

  在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。

  注：控件名可以在一个PDF中可以重复

  点击查看ComponentName在模板页面的位置

• ComponentRequired: (p) —

  如果是填写控件，ComponentRequired表示在填写页面此控件是否必填

  • false（默认）：可以不填写
  • true ：必须填写此填写控件

  如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响

• ComponentRecipientId: (p) —

  在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可

• FileIndex: (p) —

  【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0

• GenerateMode: (p) —

  控件生成的方式：

  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）

• ComponentWidth: (p) —

  在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。

• ComponentHeight: (p) —

  在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。

• ComponentPage: (p) —

  在绝对定位方式方式下，指定控件所在PDF文件上的页码
  在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。

  注：

  1. 页码编号是从1开始编号的。
  2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。

• ComponentPosX: (p) —

  在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。

• ComponentPosY: (p) —

  在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。

• ComponentExtra: (p) —

  在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。

  ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • FontAlign： Left/Right/Center，左对齐/居中/右对齐
  • FontColor：字符串类型，格式为RGB颜色数字
  • Bold是否加粗：true/false

  参数样例：{"FontColor":"255,0,0","FontSize":12,"Bold":false}

  ComponentType为DATE时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72

  参数样例：{"FontColor":"255,0,0","FontSize":12}

  ComponentType为WATERMARK时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • Opacity： 透明度，范围0 :1
  • Rotate： 水印旋转角度，范围0 :359
  • Density： 水印样式，1-宽松，2-标准（默认值），3-密集，
  • Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中
  • SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息

  参数样例："{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"

  ComponentType为FILL_IMAGE时，支持以下参数：

  • NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中
  • FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放

  ComponentType为SELECTOR时，支持以下参数：

  • WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成

  ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以ComponentTypeLimit参数控制签署方式

  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

  参考样例：{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}印章的对应关系参考下图
  
  ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型，支持指定以下印章类型

  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章
  • OTHER : 其他

  参考样例：{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。
  
  

  ComponentType为SIGN_DATE时，支持以下参数：

  • Font :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"
  • FontSize : 数字类型，范围6-72，默认值为12
  • FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
  • Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
  • Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数

  如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"

  ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：

  • PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）

  参数样例："{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"

  签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时，可以通过以下参数设置签署图片的旋转角度：

  • Rotate：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。
  • RotateRelation：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。

  参数样例：{"Rotate":-30,"RotateRelation":"Component_Id1"}

  签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：

  • Opacity：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度

  参数样例：{"Opacity":0.7}

  签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：

  • UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false

  参数样例：{"UseSealSize":true}

  签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：

  • Values：签署意见预设的需要用户填写的文本
  • ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）

  参数样例：{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}

  关键字模式下支持关键字找不到的情况下不进行报错的设置

  • IgnoreKeywordError :1-关键字查找不到时不进行报错

  场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例："{"IgnoreKeywordError":1}"

  ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：

  • Children: 绝对定位模式下，用来指定此签批控件的组合子控件
  参数样例：
  {"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}
  • ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件
  ChildrenComponent结构体定义:

  字段名称	类型	描述
  ComponentType	string	子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT
  ComponentName	string	子控件名称
  Placeholder	string	子控件提示语
  ComponentValue	string	子控件值（签署方不可设置）
  ComponentOffsetX	float	控件偏移位置X（相对于父控件（签批控件的ComponentX））
  ComponentOffsetY	float	控件偏移位置Y 相对于父控件（签批控件的ComponentY））
  ComponentWidth	float	控件宽
  ComponentHeight	float	控件高
  ComponentExtra	string	控件的附属信息，根据ComponentType设置

  参数样例：

  {    "ChildrenComponents": [        {            "ComponentType": "SIGN_SIGNATURE",            "ComponentName": "个人签名",            "Placeholder": "请签名",            "ComponentOffsetX": 10,            "ComponentOffsetY": 30,            "ComponentWidth": 119,            "ComponentHeight": 43,            "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"        },        {            "ComponentType": "SIGN_SELECTOR",            "ComponentName": "是否同意此协议",            "Placeholder": "",            "ComponentOffsetX": 50,            "ComponentOffsetY": 130,            "ComponentWidth": 120,            "ComponentHeight": 43,            "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"        },        {            "ComponentType": "SIGN_MULTI_LINE_TEXT",            "ComponentName": "批注附言",            "Placeholder": "",            "ComponentOffsetX": 150,            "ComponentOffsetY": 300,            "ComponentWidth": 200,            "ComponentHeight": 86,            "ComponentExtra": ""        }    ]}

• ComponentValue: (p) —

  控件填充vaule，ComponentType和传入值类型对应关系：

  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
  • DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
  • SIGN_SEAL : 印章ID，于控制台查询获取，点击查看在控制上的位置
  • SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取，点击查看在控制上的位置

  控件值约束说明：

  特殊控件	填写约束
  企业全称控件	企业名称中文字符中文括号
  统一社会信用代码控件	企业注册的统一社会信用代码
  法人名称控件	最大50个字符，2到25个汉字或者1到50个字母
  签署意见控件	签署意见最大长度为50字符
  签署人手机号控件	国内手机号 13,14,15,16,17,18,19号段长度11位
  签署人身份证控件	合法的身份证号码检查
  控件名称	控件名称最大长度为20字符，不支持表情
  单行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  多行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  勾选框控件	选择填字符串true，不选填字符串false
  选择器控件	同单行文本控件约束，填写选择值中的字符串
  数字控件	请输入有效的数字(可带小数点)
  日期控件	格式：yyyy年mm月dd日
  附件控件	JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID
  图片控件	JPG或PNG图片，填写上传的图片资源ID
  邮箱控件	有效的邮箱地址, w3c标准
  地址控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  省市区控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  性别控件	选择值中的字符串
  学历控件	选择值中的字符串
  水印控件	水印控件设置为CUSTOM_WATERMARK类型时的水印内容

  注： 部分特殊控件需要在控制台配置模板形式创建

• ComponentDateFontSize: (p) —

  【暂未使用】日期签署控件的字号，默认为 12

• DocumentId: (p) —

  【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可

• ComponentDescription: (p) —

  【暂未使用】控件描述，用户自定义，不影响合同发起流程

• OffsetX: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
  注意： 向左调整设置为负数， 向右调整设置成正数

• OffsetY: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
  注意： 向上调整设置为负数， 向下调整设置成正数

• ChannelComponentId: (p) —

  【暂未使用】第三方应用集成平台模板控件 ID 标识

• KeywordOrder: (p) —

  如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。

  • Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列
  • Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列

  在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。

• KeywordPage: (p) —

  如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。

• RelativeLocation: (p) —

  如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值

  • Middle :居中
  • Below :正下方
  • Right :正右方
  • LowerRight :右下角
  • UpperRight :右上角。

  示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方

• KeywordIndexes: (p) —

  如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

  注意：关键字索引是从0开始计数的

• Placeholder: (p) —

  填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
  注：签署控件设置此字段无效

• LockComponentValue: (p) —

  web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑

  • false（默认）：不锁定控件值，允许在页面编辑控件值
  • true：锁定控件值，在页面无法编辑控件值

• ForbidMoveAndDelete: (p) —

  web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件

  • false（默认） :可以移动和删除控件
  • true : 禁止移动和删除控件

# File 'lib/v20210526/models.rb', line 5329

def GenerateMode
  @GenerateMode
end

#KeywordIndexes ⇒ Object

Parameters:

• ComponentId: (p) —

  控件唯一ID。

  在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

  例：

  • 如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。
  • 如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。

  注：控件ID可以在一个PDF中不可重复
  点击查看ComponentId在模板页面的位置

• ComponentType: (p) —

  如果是Component填写控件类型，则可选的字段为：

  • TEXT : 普通文本控件，输入文本字符串；
  • MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；
  • CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
  • FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；
  • DYNAMIC_TABLE : 动态表格控件；
  • ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
  • SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；
  • DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；
  • DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
  • VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容

  如果是SignComponent签署控件类型，
  需要根据签署人的类型可选的字段为

  • 企业方
    • SIGN_SEAL : 签署印章控件；
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
    • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。

  • 个人方
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择

  注：表单域的控件不能作为印章和签名控件

• ComponentName: (p) —

  在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。

  注：控件名可以在一个PDF中可以重复

  点击查看ComponentName在模板页面的位置

• ComponentRequired: (p) —

  如果是填写控件，ComponentRequired表示在填写页面此控件是否必填

  • false（默认）：可以不填写
  • true ：必须填写此填写控件

  如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响

• ComponentRecipientId: (p) —

  在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可

• FileIndex: (p) —

  【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0

• GenerateMode: (p) —

  控件生成的方式：

  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）

• ComponentWidth: (p) —

  在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。

• ComponentHeight: (p) —

  在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。

• ComponentPage: (p) —

  在绝对定位方式方式下，指定控件所在PDF文件上的页码
  在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。

  注：

  1. 页码编号是从1开始编号的。
  2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。

• ComponentPosX: (p) —

  在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。

• ComponentPosY: (p) —

  在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。

• ComponentExtra: (p) —

  在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。

  ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • FontAlign： Left/Right/Center，左对齐/居中/右对齐
  • FontColor：字符串类型，格式为RGB颜色数字
  • Bold是否加粗：true/false

  参数样例：{"FontColor":"255,0,0","FontSize":12,"Bold":false}

  ComponentType为DATE时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72

  参数样例：{"FontColor":"255,0,0","FontSize":12}

  ComponentType为WATERMARK时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • Opacity： 透明度，范围0 :1
  • Rotate： 水印旋转角度，范围0 :359
  • Density： 水印样式，1-宽松，2-标准（默认值），3-密集，
  • Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中
  • SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息

  参数样例："{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"

  ComponentType为FILL_IMAGE时，支持以下参数：

  • NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中
  • FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放

  ComponentType为SELECTOR时，支持以下参数：

  • WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成

  ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以ComponentTypeLimit参数控制签署方式

  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

  参考样例：{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}印章的对应关系参考下图
  
  ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型，支持指定以下印章类型

  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章
  • OTHER : 其他

  参考样例：{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。
  
  

  ComponentType为SIGN_DATE时，支持以下参数：

  • Font :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"
  • FontSize : 数字类型，范围6-72，默认值为12
  • FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
  • Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
  • Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数

  如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"

  ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：

  • PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）

  参数样例："{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"

  签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时，可以通过以下参数设置签署图片的旋转角度：

  • Rotate：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。
  • RotateRelation：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。

  参数样例：{"Rotate":-30,"RotateRelation":"Component_Id1"}

  签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：

  • Opacity：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度

  参数样例：{"Opacity":0.7}

  签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：

  • UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false

  参数样例：{"UseSealSize":true}

  签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：

  • Values：签署意见预设的需要用户填写的文本
  • ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）

  参数样例：{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}

  关键字模式下支持关键字找不到的情况下不进行报错的设置

  • IgnoreKeywordError :1-关键字查找不到时不进行报错

  场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例："{"IgnoreKeywordError":1}"

  ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：

  • Children: 绝对定位模式下，用来指定此签批控件的组合子控件
  参数样例：
  {"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}
  • ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件
  ChildrenComponent结构体定义:

  字段名称	类型	描述
  ComponentType	string	子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT
  ComponentName	string	子控件名称
  Placeholder	string	子控件提示语
  ComponentValue	string	子控件值（签署方不可设置）
  ComponentOffsetX	float	控件偏移位置X（相对于父控件（签批控件的ComponentX））
  ComponentOffsetY	float	控件偏移位置Y 相对于父控件（签批控件的ComponentY））
  ComponentWidth	float	控件宽
  ComponentHeight	float	控件高
  ComponentExtra	string	控件的附属信息，根据ComponentType设置

  参数样例：

  {    "ChildrenComponents": [        {            "ComponentType": "SIGN_SIGNATURE",            "ComponentName": "个人签名",            "Placeholder": "请签名",            "ComponentOffsetX": 10,            "ComponentOffsetY": 30,            "ComponentWidth": 119,            "ComponentHeight": 43,            "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"        },        {            "ComponentType": "SIGN_SELECTOR",            "ComponentName": "是否同意此协议",            "Placeholder": "",            "ComponentOffsetX": 50,            "ComponentOffsetY": 130,            "ComponentWidth": 120,            "ComponentHeight": 43,            "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"        },        {            "ComponentType": "SIGN_MULTI_LINE_TEXT",            "ComponentName": "批注附言",            "Placeholder": "",            "ComponentOffsetX": 150,            "ComponentOffsetY": 300,            "ComponentWidth": 200,            "ComponentHeight": 86,            "ComponentExtra": ""        }    ]}

• ComponentValue: (p) —

  控件填充vaule，ComponentType和传入值类型对应关系：

  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
  • DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
  • SIGN_SEAL : 印章ID，于控制台查询获取，点击查看在控制上的位置
  • SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取，点击查看在控制上的位置

  控件值约束说明：

  特殊控件	填写约束
  企业全称控件	企业名称中文字符中文括号
  统一社会信用代码控件	企业注册的统一社会信用代码
  法人名称控件	最大50个字符，2到25个汉字或者1到50个字母
  签署意见控件	签署意见最大长度为50字符
  签署人手机号控件	国内手机号 13,14,15,16,17,18,19号段长度11位
  签署人身份证控件	合法的身份证号码检查
  控件名称	控件名称最大长度为20字符，不支持表情
  单行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  多行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  勾选框控件	选择填字符串true，不选填字符串false
  选择器控件	同单行文本控件约束，填写选择值中的字符串
  数字控件	请输入有效的数字(可带小数点)
  日期控件	格式：yyyy年mm月dd日
  附件控件	JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID
  图片控件	JPG或PNG图片，填写上传的图片资源ID
  邮箱控件	有效的邮箱地址, w3c标准
  地址控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  省市区控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  性别控件	选择值中的字符串
  学历控件	选择值中的字符串
  水印控件	水印控件设置为CUSTOM_WATERMARK类型时的水印内容

  注： 部分特殊控件需要在控制台配置模板形式创建

• ComponentDateFontSize: (p) —

  【暂未使用】日期签署控件的字号，默认为 12

• DocumentId: (p) —

  【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可

• ComponentDescription: (p) —

  【暂未使用】控件描述，用户自定义，不影响合同发起流程

• OffsetX: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
  注意： 向左调整设置为负数， 向右调整设置成正数

• OffsetY: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
  注意： 向上调整设置为负数， 向下调整设置成正数

• ChannelComponentId: (p) —

  【暂未使用】第三方应用集成平台模板控件 ID 标识

• KeywordOrder: (p) —

  如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。

  • Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列
  • Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列

  在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。

• KeywordPage: (p) —

  如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。

• RelativeLocation: (p) —

  如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值

  • Middle :居中
  • Below :正下方
  • Right :正右方
  • LowerRight :右下角
  • UpperRight :右上角。

  示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方

• KeywordIndexes: (p) —

  如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

  注意：关键字索引是从0开始计数的

• Placeholder: (p) —

  填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
  注：签署控件设置此字段无效

• LockComponentValue: (p) —

  web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑

  • false（默认）：不锁定控件值，允许在页面编辑控件值
  • true：锁定控件值，在页面无法编辑控件值

• ForbidMoveAndDelete: (p) —

  web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件

  • false（默认） :可以移动和删除控件
  • true : 禁止移动和删除控件

# File 'lib/v20210526/models.rb', line 5329

def KeywordIndexes
  @KeywordIndexes
end

#KeywordOrder ⇒ Object

Parameters:

• ComponentId: (p) —

  控件唯一ID。

  在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

  例：

  • 如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。
  • 如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。

  注：控件ID可以在一个PDF中不可重复
  点击查看ComponentId在模板页面的位置

• ComponentType: (p) —

  如果是Component填写控件类型，则可选的字段为：

  • TEXT : 普通文本控件，输入文本字符串；
  • MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；
  • CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
  • FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；
  • DYNAMIC_TABLE : 动态表格控件；
  • ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
  • SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；
  • DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；
  • DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
  • VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容

  如果是SignComponent签署控件类型，
  需要根据签署人的类型可选的字段为

  • 企业方
    • SIGN_SEAL : 签署印章控件；
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
    • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。

  • 个人方
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择

  注：表单域的控件不能作为印章和签名控件

• ComponentName: (p) —

  在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。

  注：控件名可以在一个PDF中可以重复

  点击查看ComponentName在模板页面的位置

• ComponentRequired: (p) —

  如果是填写控件，ComponentRequired表示在填写页面此控件是否必填

  • false（默认）：可以不填写
  • true ：必须填写此填写控件

  如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响

• ComponentRecipientId: (p) —

  在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可

• FileIndex: (p) —

  【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0

• GenerateMode: (p) —

  控件生成的方式：

  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）

• ComponentWidth: (p) —

  在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。

• ComponentHeight: (p) —

  在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。

• ComponentPage: (p) —

  在绝对定位方式方式下，指定控件所在PDF文件上的页码
  在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。

  注：

  1. 页码编号是从1开始编号的。
  2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。

• ComponentPosX: (p) —

  在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。

• ComponentPosY: (p) —

  在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。

• ComponentExtra: (p) —

  在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。

  ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • FontAlign： Left/Right/Center，左对齐/居中/右对齐
  • FontColor：字符串类型，格式为RGB颜色数字
  • Bold是否加粗：true/false

  参数样例：{"FontColor":"255,0,0","FontSize":12,"Bold":false}

  ComponentType为DATE时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72

  参数样例：{"FontColor":"255,0,0","FontSize":12}

  ComponentType为WATERMARK时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • Opacity： 透明度，范围0 :1
  • Rotate： 水印旋转角度，范围0 :359
  • Density： 水印样式，1-宽松，2-标准（默认值），3-密集，
  • Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中
  • SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息

  参数样例："{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"

  ComponentType为FILL_IMAGE时，支持以下参数：

  • NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中
  • FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放

  ComponentType为SELECTOR时，支持以下参数：

  • WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成

  ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以ComponentTypeLimit参数控制签署方式

  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

  参考样例：{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}印章的对应关系参考下图
  
  ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型，支持指定以下印章类型

  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章
  • OTHER : 其他

  参考样例：{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。
  
  

  ComponentType为SIGN_DATE时，支持以下参数：

  • Font :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"
  • FontSize : 数字类型，范围6-72，默认值为12
  • FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
  • Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
  • Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数

  如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"

  ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：

  • PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）

  参数样例："{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"

  签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时，可以通过以下参数设置签署图片的旋转角度：

  • Rotate：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。
  • RotateRelation：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。

  参数样例：{"Rotate":-30,"RotateRelation":"Component_Id1"}

  签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：

  • Opacity：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度

  参数样例：{"Opacity":0.7}

  签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：

  • UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false

  参数样例：{"UseSealSize":true}

  签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：

  • Values：签署意见预设的需要用户填写的文本
  • ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）

  参数样例：{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}

  关键字模式下支持关键字找不到的情况下不进行报错的设置

  • IgnoreKeywordError :1-关键字查找不到时不进行报错

  场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例："{"IgnoreKeywordError":1}"

  ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：

  • Children: 绝对定位模式下，用来指定此签批控件的组合子控件
  参数样例：
  {"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}
  • ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件
  ChildrenComponent结构体定义:

  字段名称	类型	描述
  ComponentType	string	子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT
  ComponentName	string	子控件名称
  Placeholder	string	子控件提示语
  ComponentValue	string	子控件值（签署方不可设置）
  ComponentOffsetX	float	控件偏移位置X（相对于父控件（签批控件的ComponentX））
  ComponentOffsetY	float	控件偏移位置Y 相对于父控件（签批控件的ComponentY））
  ComponentWidth	float	控件宽
  ComponentHeight	float	控件高
  ComponentExtra	string	控件的附属信息，根据ComponentType设置

  参数样例：

  {    "ChildrenComponents": [        {            "ComponentType": "SIGN_SIGNATURE",            "ComponentName": "个人签名",            "Placeholder": "请签名",            "ComponentOffsetX": 10,            "ComponentOffsetY": 30,            "ComponentWidth": 119,            "ComponentHeight": 43,            "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"        },        {            "ComponentType": "SIGN_SELECTOR",            "ComponentName": "是否同意此协议",            "Placeholder": "",            "ComponentOffsetX": 50,            "ComponentOffsetY": 130,            "ComponentWidth": 120,            "ComponentHeight": 43,            "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"        },        {            "ComponentType": "SIGN_MULTI_LINE_TEXT",            "ComponentName": "批注附言",            "Placeholder": "",            "ComponentOffsetX": 150,            "ComponentOffsetY": 300,            "ComponentWidth": 200,            "ComponentHeight": 86,            "ComponentExtra": ""        }    ]}

• ComponentValue: (p) —

  控件填充vaule，ComponentType和传入值类型对应关系：

  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
  • DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
  • SIGN_SEAL : 印章ID，于控制台查询获取，点击查看在控制上的位置
  • SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取，点击查看在控制上的位置

  控件值约束说明：

  特殊控件	填写约束
  企业全称控件	企业名称中文字符中文括号
  统一社会信用代码控件	企业注册的统一社会信用代码
  法人名称控件	最大50个字符，2到25个汉字或者1到50个字母
  签署意见控件	签署意见最大长度为50字符
  签署人手机号控件	国内手机号 13,14,15,16,17,18,19号段长度11位
  签署人身份证控件	合法的身份证号码检查
  控件名称	控件名称最大长度为20字符，不支持表情
  单行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  多行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  勾选框控件	选择填字符串true，不选填字符串false
  选择器控件	同单行文本控件约束，填写选择值中的字符串
  数字控件	请输入有效的数字(可带小数点)
  日期控件	格式：yyyy年mm月dd日
  附件控件	JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID
  图片控件	JPG或PNG图片，填写上传的图片资源ID
  邮箱控件	有效的邮箱地址, w3c标准
  地址控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  省市区控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  性别控件	选择值中的字符串
  学历控件	选择值中的字符串
  水印控件	水印控件设置为CUSTOM_WATERMARK类型时的水印内容

  注： 部分特殊控件需要在控制台配置模板形式创建

• ComponentDateFontSize: (p) —

  【暂未使用】日期签署控件的字号，默认为 12

• DocumentId: (p) —

  【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可

• ComponentDescription: (p) —

  【暂未使用】控件描述，用户自定义，不影响合同发起流程

• OffsetX: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
  注意： 向左调整设置为负数， 向右调整设置成正数

• OffsetY: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
  注意： 向上调整设置为负数， 向下调整设置成正数

• ChannelComponentId: (p) —

  【暂未使用】第三方应用集成平台模板控件 ID 标识

• KeywordOrder: (p) —

  如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。

  • Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列
  • Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列

  在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。

• KeywordPage: (p) —

  如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。

• RelativeLocation: (p) —

  如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值

  • Middle :居中
  • Below :正下方
  • Right :正右方
  • LowerRight :右下角
  • UpperRight :右上角。

  示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方

• KeywordIndexes: (p) —

  如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

  注意：关键字索引是从0开始计数的

• Placeholder: (p) —

  填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
  注：签署控件设置此字段无效

• LockComponentValue: (p) —

  web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑

  • false（默认）：不锁定控件值，允许在页面编辑控件值
  • true：锁定控件值，在页面无法编辑控件值

• ForbidMoveAndDelete: (p) —

  web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件

  • false（默认） :可以移动和删除控件
  • true : 禁止移动和删除控件

# File 'lib/v20210526/models.rb', line 5329

def KeywordOrder
  @KeywordOrder
end

#KeywordPage ⇒ Object

Parameters:

• ComponentId: (p) —

  控件唯一ID。

  在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

  例：

  • 如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。
  • 如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。

  注：控件ID可以在一个PDF中不可重复
  点击查看ComponentId在模板页面的位置

• ComponentType: (p) —

  如果是Component填写控件类型，则可选的字段为：

  • TEXT : 普通文本控件，输入文本字符串；
  • MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；
  • CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
  • FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；
  • DYNAMIC_TABLE : 动态表格控件；
  • ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
  • SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；
  • DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；
  • DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
  • VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容

  如果是SignComponent签署控件类型，
  需要根据签署人的类型可选的字段为

  • 企业方
    • SIGN_SEAL : 签署印章控件；
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
    • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。

  • 个人方
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择

  注：表单域的控件不能作为印章和签名控件

• ComponentName: (p) —

  在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。

  注：控件名可以在一个PDF中可以重复

  点击查看ComponentName在模板页面的位置

• ComponentRequired: (p) —

  如果是填写控件，ComponentRequired表示在填写页面此控件是否必填

  • false（默认）：可以不填写
  • true ：必须填写此填写控件

  如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响

• ComponentRecipientId: (p) —

  在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可

• FileIndex: (p) —

  【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0

• GenerateMode: (p) —

  控件生成的方式：

  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）

• ComponentWidth: (p) —

  在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。

• ComponentHeight: (p) —

  在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。

• ComponentPage: (p) —

  在绝对定位方式方式下，指定控件所在PDF文件上的页码
  在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。

  注：

  1. 页码编号是从1开始编号的。
  2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。

• ComponentPosX: (p) —

  在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。

• ComponentPosY: (p) —

  在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。

• ComponentExtra: (p) —

  在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。

  ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • FontAlign： Left/Right/Center，左对齐/居中/右对齐
  • FontColor：字符串类型，格式为RGB颜色数字
  • Bold是否加粗：true/false

  参数样例：{"FontColor":"255,0,0","FontSize":12,"Bold":false}

  ComponentType为DATE时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72

  参数样例：{"FontColor":"255,0,0","FontSize":12}

  ComponentType为WATERMARK时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • Opacity： 透明度，范围0 :1
  • Rotate： 水印旋转角度，范围0 :359
  • Density： 水印样式，1-宽松，2-标准（默认值），3-密集，
  • Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中
  • SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息

  参数样例："{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"

  ComponentType为FILL_IMAGE时，支持以下参数：

  • NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中
  • FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放

  ComponentType为SELECTOR时，支持以下参数：

  • WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成

  ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以ComponentTypeLimit参数控制签署方式

  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

  参考样例：{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}印章的对应关系参考下图
  
  ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型，支持指定以下印章类型

  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章
  • OTHER : 其他

  参考样例：{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。
  
  

  ComponentType为SIGN_DATE时，支持以下参数：

  • Font :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"
  • FontSize : 数字类型，范围6-72，默认值为12
  • FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
  • Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
  • Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数

  如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"

  ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：

  • PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）

  参数样例："{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"

  签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时，可以通过以下参数设置签署图片的旋转角度：

  • Rotate：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。
  • RotateRelation：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。

  参数样例：{"Rotate":-30,"RotateRelation":"Component_Id1"}

  签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：

  • Opacity：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度

  参数样例：{"Opacity":0.7}

  签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：

  • UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false

  参数样例：{"UseSealSize":true}

  签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：

  • Values：签署意见预设的需要用户填写的文本
  • ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）

  参数样例：{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}

  关键字模式下支持关键字找不到的情况下不进行报错的设置

  • IgnoreKeywordError :1-关键字查找不到时不进行报错

  场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例："{"IgnoreKeywordError":1}"

  ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：

  • Children: 绝对定位模式下，用来指定此签批控件的组合子控件
  参数样例：
  {"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}
  • ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件
  ChildrenComponent结构体定义:

  字段名称	类型	描述
  ComponentType	string	子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT
  ComponentName	string	子控件名称
  Placeholder	string	子控件提示语
  ComponentValue	string	子控件值（签署方不可设置）
  ComponentOffsetX	float	控件偏移位置X（相对于父控件（签批控件的ComponentX））
  ComponentOffsetY	float	控件偏移位置Y 相对于父控件（签批控件的ComponentY））
  ComponentWidth	float	控件宽
  ComponentHeight	float	控件高
  ComponentExtra	string	控件的附属信息，根据ComponentType设置

  参数样例：

  {    "ChildrenComponents": [        {            "ComponentType": "SIGN_SIGNATURE",            "ComponentName": "个人签名",            "Placeholder": "请签名",            "ComponentOffsetX": 10,            "ComponentOffsetY": 30,            "ComponentWidth": 119,            "ComponentHeight": 43,            "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"        },        {            "ComponentType": "SIGN_SELECTOR",            "ComponentName": "是否同意此协议",            "Placeholder": "",            "ComponentOffsetX": 50,            "ComponentOffsetY": 130,            "ComponentWidth": 120,            "ComponentHeight": 43,            "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"        },        {            "ComponentType": "SIGN_MULTI_LINE_TEXT",            "ComponentName": "批注附言",            "Placeholder": "",            "ComponentOffsetX": 150,            "ComponentOffsetY": 300,            "ComponentWidth": 200,            "ComponentHeight": 86,            "ComponentExtra": ""        }    ]}

• ComponentValue: (p) —

  控件填充vaule，ComponentType和传入值类型对应关系：

  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
  • DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
  • SIGN_SEAL : 印章ID，于控制台查询获取，点击查看在控制上的位置
  • SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取，点击查看在控制上的位置

  控件值约束说明：

  特殊控件	填写约束
  企业全称控件	企业名称中文字符中文括号
  统一社会信用代码控件	企业注册的统一社会信用代码
  法人名称控件	最大50个字符，2到25个汉字或者1到50个字母
  签署意见控件	签署意见最大长度为50字符
  签署人手机号控件	国内手机号 13,14,15,16,17,18,19号段长度11位
  签署人身份证控件	合法的身份证号码检查
  控件名称	控件名称最大长度为20字符，不支持表情
  单行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  多行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  勾选框控件	选择填字符串true，不选填字符串false
  选择器控件	同单行文本控件约束，填写选择值中的字符串
  数字控件	请输入有效的数字(可带小数点)
  日期控件	格式：yyyy年mm月dd日
  附件控件	JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID
  图片控件	JPG或PNG图片，填写上传的图片资源ID
  邮箱控件	有效的邮箱地址, w3c标准
  地址控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  省市区控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  性别控件	选择值中的字符串
  学历控件	选择值中的字符串
  水印控件	水印控件设置为CUSTOM_WATERMARK类型时的水印内容

  注： 部分特殊控件需要在控制台配置模板形式创建

• ComponentDateFontSize: (p) —

  【暂未使用】日期签署控件的字号，默认为 12

• DocumentId: (p) —

  【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可

• ComponentDescription: (p) —

  【暂未使用】控件描述，用户自定义，不影响合同发起流程

• OffsetX: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
  注意： 向左调整设置为负数， 向右调整设置成正数

• OffsetY: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
  注意： 向上调整设置为负数， 向下调整设置成正数

• ChannelComponentId: (p) —

  【暂未使用】第三方应用集成平台模板控件 ID 标识

• KeywordOrder: (p) —

  如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。

  • Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列
  • Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列

  在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。

• KeywordPage: (p) —

  如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。

• RelativeLocation: (p) —

  如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值

  • Middle :居中
  • Below :正下方
  • Right :正右方
  • LowerRight :右下角
  • UpperRight :右上角。

  示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方

• KeywordIndexes: (p) —

  如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

  注意：关键字索引是从0开始计数的

• Placeholder: (p) —

  填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
  注：签署控件设置此字段无效

• LockComponentValue: (p) —

  web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑

  • false（默认）：不锁定控件值，允许在页面编辑控件值
  • true：锁定控件值，在页面无法编辑控件值

• ForbidMoveAndDelete: (p) —

  web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件

  • false（默认） :可以移动和删除控件
  • true : 禁止移动和删除控件

# File 'lib/v20210526/models.rb', line 5329

def KeywordPage
  @KeywordPage
end

#LockComponentValue ⇒ Object

Parameters:

• ComponentId: (p) —

  控件唯一ID。

  在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

  例：

  • 如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。
  • 如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。

  注：控件ID可以在一个PDF中不可重复
  点击查看ComponentId在模板页面的位置

• ComponentType: (p) —

  如果是Component填写控件类型，则可选的字段为：

  • TEXT : 普通文本控件，输入文本字符串；
  • MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；
  • CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
  • FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；
  • DYNAMIC_TABLE : 动态表格控件；
  • ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
  • SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；
  • DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；
  • DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
  • VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容

  如果是SignComponent签署控件类型，
  需要根据签署人的类型可选的字段为

  • 企业方
    • SIGN_SEAL : 签署印章控件；
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
    • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。

  • 个人方
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择

  注：表单域的控件不能作为印章和签名控件

• ComponentName: (p) —

  在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。

  注：控件名可以在一个PDF中可以重复

  点击查看ComponentName在模板页面的位置

• ComponentRequired: (p) —

  如果是填写控件，ComponentRequired表示在填写页面此控件是否必填

  • false（默认）：可以不填写
  • true ：必须填写此填写控件

  如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响

• ComponentRecipientId: (p) —

  在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可

• FileIndex: (p) —

  【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0

• GenerateMode: (p) —

  控件生成的方式：

  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）

• ComponentWidth: (p) —

  在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。

• ComponentHeight: (p) —

  在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。

• ComponentPage: (p) —

  在绝对定位方式方式下，指定控件所在PDF文件上的页码
  在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。

  注：

  1. 页码编号是从1开始编号的。
  2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。

• ComponentPosX: (p) —

  在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。

• ComponentPosY: (p) —

  在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。

• ComponentExtra: (p) —

  在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。

  ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • FontAlign： Left/Right/Center，左对齐/居中/右对齐
  • FontColor：字符串类型，格式为RGB颜色数字
  • Bold是否加粗：true/false

  参数样例：{"FontColor":"255,0,0","FontSize":12,"Bold":false}

  ComponentType为DATE时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72

  参数样例：{"FontColor":"255,0,0","FontSize":12}

  ComponentType为WATERMARK时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • Opacity： 透明度，范围0 :1
  • Rotate： 水印旋转角度，范围0 :359
  • Density： 水印样式，1-宽松，2-标准（默认值），3-密集，
  • Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中
  • SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息

  参数样例："{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"

  ComponentType为FILL_IMAGE时，支持以下参数：

  • NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中
  • FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放

  ComponentType为SELECTOR时，支持以下参数：

  • WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成

  ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以ComponentTypeLimit参数控制签署方式

  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

  参考样例：{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}印章的对应关系参考下图
  
  ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型，支持指定以下印章类型

  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章
  • OTHER : 其他

  参考样例：{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。
  
  

  ComponentType为SIGN_DATE时，支持以下参数：

  • Font :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"
  • FontSize : 数字类型，范围6-72，默认值为12
  • FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
  • Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
  • Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数

  如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"

  ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：

  • PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）

  参数样例："{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"

  签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时，可以通过以下参数设置签署图片的旋转角度：

  • Rotate：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。
  • RotateRelation：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。

  参数样例：{"Rotate":-30,"RotateRelation":"Component_Id1"}

  签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：

  • Opacity：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度

  参数样例：{"Opacity":0.7}

  签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：

  • UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false

  参数样例：{"UseSealSize":true}

  签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：

  • Values：签署意见预设的需要用户填写的文本
  • ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）

  参数样例：{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}

  关键字模式下支持关键字找不到的情况下不进行报错的设置

  • IgnoreKeywordError :1-关键字查找不到时不进行报错

  场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例："{"IgnoreKeywordError":1}"

  ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：

  • Children: 绝对定位模式下，用来指定此签批控件的组合子控件
  参数样例：
  {"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}
  • ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件
  ChildrenComponent结构体定义:

  字段名称	类型	描述
  ComponentType	string	子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT
  ComponentName	string	子控件名称
  Placeholder	string	子控件提示语
  ComponentValue	string	子控件值（签署方不可设置）
  ComponentOffsetX	float	控件偏移位置X（相对于父控件（签批控件的ComponentX））
  ComponentOffsetY	float	控件偏移位置Y 相对于父控件（签批控件的ComponentY））
  ComponentWidth	float	控件宽
  ComponentHeight	float	控件高
  ComponentExtra	string	控件的附属信息，根据ComponentType设置

  参数样例：

  {    "ChildrenComponents": [        {            "ComponentType": "SIGN_SIGNATURE",            "ComponentName": "个人签名",            "Placeholder": "请签名",            "ComponentOffsetX": 10,            "ComponentOffsetY": 30,            "ComponentWidth": 119,            "ComponentHeight": 43,            "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"        },        {            "ComponentType": "SIGN_SELECTOR",            "ComponentName": "是否同意此协议",            "Placeholder": "",            "ComponentOffsetX": 50,            "ComponentOffsetY": 130,            "ComponentWidth": 120,            "ComponentHeight": 43,            "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"        },        {            "ComponentType": "SIGN_MULTI_LINE_TEXT",            "ComponentName": "批注附言",            "Placeholder": "",            "ComponentOffsetX": 150,            "ComponentOffsetY": 300,            "ComponentWidth": 200,            "ComponentHeight": 86,            "ComponentExtra": ""        }    ]}

• ComponentValue: (p) —

  控件填充vaule，ComponentType和传入值类型对应关系：

  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
  • DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
  • SIGN_SEAL : 印章ID，于控制台查询获取，点击查看在控制上的位置
  • SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取，点击查看在控制上的位置

  控件值约束说明：

  特殊控件	填写约束
  企业全称控件	企业名称中文字符中文括号
  统一社会信用代码控件	企业注册的统一社会信用代码
  法人名称控件	最大50个字符，2到25个汉字或者1到50个字母
  签署意见控件	签署意见最大长度为50字符
  签署人手机号控件	国内手机号 13,14,15,16,17,18,19号段长度11位
  签署人身份证控件	合法的身份证号码检查
  控件名称	控件名称最大长度为20字符，不支持表情
  单行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  多行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  勾选框控件	选择填字符串true，不选填字符串false
  选择器控件	同单行文本控件约束，填写选择值中的字符串
  数字控件	请输入有效的数字(可带小数点)
  日期控件	格式：yyyy年mm月dd日
  附件控件	JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID
  图片控件	JPG或PNG图片，填写上传的图片资源ID
  邮箱控件	有效的邮箱地址, w3c标准
  地址控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  省市区控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  性别控件	选择值中的字符串
  学历控件	选择值中的字符串
  水印控件	水印控件设置为CUSTOM_WATERMARK类型时的水印内容

  注： 部分特殊控件需要在控制台配置模板形式创建

• ComponentDateFontSize: (p) —

  【暂未使用】日期签署控件的字号，默认为 12

• DocumentId: (p) —

  【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可

• ComponentDescription: (p) —

  【暂未使用】控件描述，用户自定义，不影响合同发起流程

• OffsetX: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
  注意： 向左调整设置为负数， 向右调整设置成正数

• OffsetY: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
  注意： 向上调整设置为负数， 向下调整设置成正数

• ChannelComponentId: (p) —

  【暂未使用】第三方应用集成平台模板控件 ID 标识

• KeywordOrder: (p) —

  如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。

  • Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列
  • Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列

  在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。

• KeywordPage: (p) —

  如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。

• RelativeLocation: (p) —

  如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值

  • Middle :居中
  • Below :正下方
  • Right :正右方
  • LowerRight :右下角
  • UpperRight :右上角。

  示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方

• KeywordIndexes: (p) —

  如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

  注意：关键字索引是从0开始计数的

• Placeholder: (p) —

  填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
  注：签署控件设置此字段无效

• LockComponentValue: (p) —

  web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑

  • false（默认）：不锁定控件值，允许在页面编辑控件值
  • true：锁定控件值，在页面无法编辑控件值

• ForbidMoveAndDelete: (p) —

  web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件

  • false（默认） :可以移动和删除控件
  • true : 禁止移动和删除控件

# File 'lib/v20210526/models.rb', line 5329

def LockComponentValue
  @LockComponentValue
end

#OffsetX ⇒ Object

Parameters:

• ComponentId: (p) —

  控件唯一ID。

  在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

  例：

  • 如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。
  • 如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。

  注：控件ID可以在一个PDF中不可重复
  点击查看ComponentId在模板页面的位置

• ComponentType: (p) —

  如果是Component填写控件类型，则可选的字段为：

  • TEXT : 普通文本控件，输入文本字符串；
  • MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；
  • CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
  • FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；
  • DYNAMIC_TABLE : 动态表格控件；
  • ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
  • SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；
  • DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；
  • DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
  • VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容

  如果是SignComponent签署控件类型，
  需要根据签署人的类型可选的字段为

  • 企业方
    • SIGN_SEAL : 签署印章控件；
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
    • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。

  • 个人方
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择

  注：表单域的控件不能作为印章和签名控件

• ComponentName: (p) —

  在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。

  注：控件名可以在一个PDF中可以重复

  点击查看ComponentName在模板页面的位置

• ComponentRequired: (p) —

  如果是填写控件，ComponentRequired表示在填写页面此控件是否必填

  • false（默认）：可以不填写
  • true ：必须填写此填写控件

  如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响

• ComponentRecipientId: (p) —

  在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可

• FileIndex: (p) —

  【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0

• GenerateMode: (p) —

  控件生成的方式：

  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）

• ComponentWidth: (p) —

  在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。

• ComponentHeight: (p) —

  在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。

• ComponentPage: (p) —

  在绝对定位方式方式下，指定控件所在PDF文件上的页码
  在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。

  注：

  1. 页码编号是从1开始编号的。
  2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。

• ComponentPosX: (p) —

  在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。

• ComponentPosY: (p) —

  在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。

• ComponentExtra: (p) —

  在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。

  ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • FontAlign： Left/Right/Center，左对齐/居中/右对齐
  • FontColor：字符串类型，格式为RGB颜色数字
  • Bold是否加粗：true/false

  参数样例：{"FontColor":"255,0,0","FontSize":12,"Bold":false}

  ComponentType为DATE时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72

  参数样例：{"FontColor":"255,0,0","FontSize":12}

  ComponentType为WATERMARK时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • Opacity： 透明度，范围0 :1
  • Rotate： 水印旋转角度，范围0 :359
  • Density： 水印样式，1-宽松，2-标准（默认值），3-密集，
  • Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中
  • SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息

  参数样例："{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"

  ComponentType为FILL_IMAGE时，支持以下参数：

  • NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中
  • FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放

  ComponentType为SELECTOR时，支持以下参数：

  • WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成

  ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以ComponentTypeLimit参数控制签署方式

  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

  参考样例：{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}印章的对应关系参考下图
  
  ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型，支持指定以下印章类型

  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章
  • OTHER : 其他

  参考样例：{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。
  
  

  ComponentType为SIGN_DATE时，支持以下参数：

  • Font :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"
  • FontSize : 数字类型，范围6-72，默认值为12
  • FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
  • Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
  • Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数

  如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"

  ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：

  • PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）

  参数样例："{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"

  签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时，可以通过以下参数设置签署图片的旋转角度：

  • Rotate：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。
  • RotateRelation：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。

  参数样例：{"Rotate":-30,"RotateRelation":"Component_Id1"}

  签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：

  • Opacity：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度

  参数样例：{"Opacity":0.7}

  签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：

  • UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false

  参数样例：{"UseSealSize":true}

  签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：

  • Values：签署意见预设的需要用户填写的文本
  • ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）

  参数样例：{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}

  关键字模式下支持关键字找不到的情况下不进行报错的设置

  • IgnoreKeywordError :1-关键字查找不到时不进行报错

  场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例："{"IgnoreKeywordError":1}"

  ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：

  • Children: 绝对定位模式下，用来指定此签批控件的组合子控件
  参数样例：
  {"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}
  • ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件
  ChildrenComponent结构体定义:

  字段名称	类型	描述
  ComponentType	string	子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT
  ComponentName	string	子控件名称
  Placeholder	string	子控件提示语
  ComponentValue	string	子控件值（签署方不可设置）
  ComponentOffsetX	float	控件偏移位置X（相对于父控件（签批控件的ComponentX））
  ComponentOffsetY	float	控件偏移位置Y 相对于父控件（签批控件的ComponentY））
  ComponentWidth	float	控件宽
  ComponentHeight	float	控件高
  ComponentExtra	string	控件的附属信息，根据ComponentType设置

  参数样例：

  {    "ChildrenComponents": [        {            "ComponentType": "SIGN_SIGNATURE",            "ComponentName": "个人签名",            "Placeholder": "请签名",            "ComponentOffsetX": 10,            "ComponentOffsetY": 30,            "ComponentWidth": 119,            "ComponentHeight": 43,            "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"        },        {            "ComponentType": "SIGN_SELECTOR",            "ComponentName": "是否同意此协议",            "Placeholder": "",            "ComponentOffsetX": 50,            "ComponentOffsetY": 130,            "ComponentWidth": 120,            "ComponentHeight": 43,            "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"        },        {            "ComponentType": "SIGN_MULTI_LINE_TEXT",            "ComponentName": "批注附言",            "Placeholder": "",            "ComponentOffsetX": 150,            "ComponentOffsetY": 300,            "ComponentWidth": 200,            "ComponentHeight": 86,            "ComponentExtra": ""        }    ]}

• ComponentValue: (p) —

  控件填充vaule，ComponentType和传入值类型对应关系：

  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
  • DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
  • SIGN_SEAL : 印章ID，于控制台查询获取，点击查看在控制上的位置
  • SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取，点击查看在控制上的位置

  控件值约束说明：

  特殊控件	填写约束
  企业全称控件	企业名称中文字符中文括号
  统一社会信用代码控件	企业注册的统一社会信用代码
  法人名称控件	最大50个字符，2到25个汉字或者1到50个字母
  签署意见控件	签署意见最大长度为50字符
  签署人手机号控件	国内手机号 13,14,15,16,17,18,19号段长度11位
  签署人身份证控件	合法的身份证号码检查
  控件名称	控件名称最大长度为20字符，不支持表情
  单行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  多行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  勾选框控件	选择填字符串true，不选填字符串false
  选择器控件	同单行文本控件约束，填写选择值中的字符串
  数字控件	请输入有效的数字(可带小数点)
  日期控件	格式：yyyy年mm月dd日
  附件控件	JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID
  图片控件	JPG或PNG图片，填写上传的图片资源ID
  邮箱控件	有效的邮箱地址, w3c标准
  地址控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  省市区控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  性别控件	选择值中的字符串
  学历控件	选择值中的字符串
  水印控件	水印控件设置为CUSTOM_WATERMARK类型时的水印内容

  注： 部分特殊控件需要在控制台配置模板形式创建

• ComponentDateFontSize: (p) —

  【暂未使用】日期签署控件的字号，默认为 12

• DocumentId: (p) —

  【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可

• ComponentDescription: (p) —

  【暂未使用】控件描述，用户自定义，不影响合同发起流程

• OffsetX: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
  注意： 向左调整设置为负数， 向右调整设置成正数

• OffsetY: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
  注意： 向上调整设置为负数， 向下调整设置成正数

• ChannelComponentId: (p) —

  【暂未使用】第三方应用集成平台模板控件 ID 标识

• KeywordOrder: (p) —

  如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。

  • Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列
  • Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列

  在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。

• KeywordPage: (p) —

  如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。

• RelativeLocation: (p) —

  如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值

  • Middle :居中
  • Below :正下方
  • Right :正右方
  • LowerRight :右下角
  • UpperRight :右上角。

  示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方

• KeywordIndexes: (p) —

  如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

  注意：关键字索引是从0开始计数的

• Placeholder: (p) —

  填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
  注：签署控件设置此字段无效

• LockComponentValue: (p) —

  web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑

  • false（默认）：不锁定控件值，允许在页面编辑控件值
  • true：锁定控件值，在页面无法编辑控件值

• ForbidMoveAndDelete: (p) —

  web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件

  • false（默认） :可以移动和删除控件
  • true : 禁止移动和删除控件

# File 'lib/v20210526/models.rb', line 5329

def OffsetX
  @OffsetX
end

#OffsetY ⇒ Object

Parameters:

• ComponentId: (p) —

  控件唯一ID。

  在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

  例：

  • 如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。
  • 如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。

  注：控件ID可以在一个PDF中不可重复
  点击查看ComponentId在模板页面的位置

• ComponentType: (p) —

  如果是Component填写控件类型，则可选的字段为：

  • TEXT : 普通文本控件，输入文本字符串；
  • MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；
  • CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
  • FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；
  • DYNAMIC_TABLE : 动态表格控件；
  • ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
  • SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；
  • DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；
  • DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
  • VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容

  如果是SignComponent签署控件类型，
  需要根据签署人的类型可选的字段为

  • 企业方
    • SIGN_SEAL : 签署印章控件；
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
    • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。

  • 个人方
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择

  注：表单域的控件不能作为印章和签名控件

• ComponentName: (p) —

  在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。

  注：控件名可以在一个PDF中可以重复

  点击查看ComponentName在模板页面的位置

• ComponentRequired: (p) —

  如果是填写控件，ComponentRequired表示在填写页面此控件是否必填

  • false（默认）：可以不填写
  • true ：必须填写此填写控件

  如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响

• ComponentRecipientId: (p) —

  在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可

• FileIndex: (p) —

  【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0

• GenerateMode: (p) —

  控件生成的方式：

  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）

• ComponentWidth: (p) —

  在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。

• ComponentHeight: (p) —

  在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。

• ComponentPage: (p) —

  在绝对定位方式方式下，指定控件所在PDF文件上的页码
  在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。

  注：

  1. 页码编号是从1开始编号的。
  2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。

• ComponentPosX: (p) —

  在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。

• ComponentPosY: (p) —

  在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。

• ComponentExtra: (p) —

  在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。

  ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • FontAlign： Left/Right/Center，左对齐/居中/右对齐
  • FontColor：字符串类型，格式为RGB颜色数字
  • Bold是否加粗：true/false

  参数样例：{"FontColor":"255,0,0","FontSize":12,"Bold":false}

  ComponentType为DATE时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72

  参数样例：{"FontColor":"255,0,0","FontSize":12}

  ComponentType为WATERMARK时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • Opacity： 透明度，范围0 :1
  • Rotate： 水印旋转角度，范围0 :359
  • Density： 水印样式，1-宽松，2-标准（默认值），3-密集，
  • Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中
  • SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息

  参数样例："{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"

  ComponentType为FILL_IMAGE时，支持以下参数：

  • NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中
  • FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放

  ComponentType为SELECTOR时，支持以下参数：

  • WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成

  ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以ComponentTypeLimit参数控制签署方式

  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

  参考样例：{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}印章的对应关系参考下图
  
  ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型，支持指定以下印章类型

  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章
  • OTHER : 其他

  参考样例：{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。
  
  

  ComponentType为SIGN_DATE时，支持以下参数：

  • Font :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"
  • FontSize : 数字类型，范围6-72，默认值为12
  • FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
  • Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
  • Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数

  如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"

  ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：

  • PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）

  参数样例："{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"

  签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时，可以通过以下参数设置签署图片的旋转角度：

  • Rotate：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。
  • RotateRelation：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。

  参数样例：{"Rotate":-30,"RotateRelation":"Component_Id1"}

  签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：

  • Opacity：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度

  参数样例：{"Opacity":0.7}

  签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：

  • UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false

  参数样例：{"UseSealSize":true}

  签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：

  • Values：签署意见预设的需要用户填写的文本
  • ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）

  参数样例：{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}

  关键字模式下支持关键字找不到的情况下不进行报错的设置

  • IgnoreKeywordError :1-关键字查找不到时不进行报错

  场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例："{"IgnoreKeywordError":1}"

  ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：

  • Children: 绝对定位模式下，用来指定此签批控件的组合子控件
  参数样例：
  {"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}
  • ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件
  ChildrenComponent结构体定义:

  字段名称	类型	描述
  ComponentType	string	子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT
  ComponentName	string	子控件名称
  Placeholder	string	子控件提示语
  ComponentValue	string	子控件值（签署方不可设置）
  ComponentOffsetX	float	控件偏移位置X（相对于父控件（签批控件的ComponentX））
  ComponentOffsetY	float	控件偏移位置Y 相对于父控件（签批控件的ComponentY））
  ComponentWidth	float	控件宽
  ComponentHeight	float	控件高
  ComponentExtra	string	控件的附属信息，根据ComponentType设置

  参数样例：

  {    "ChildrenComponents": [        {            "ComponentType": "SIGN_SIGNATURE",            "ComponentName": "个人签名",            "Placeholder": "请签名",            "ComponentOffsetX": 10,            "ComponentOffsetY": 30,            "ComponentWidth": 119,            "ComponentHeight": 43,            "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"        },        {            "ComponentType": "SIGN_SELECTOR",            "ComponentName": "是否同意此协议",            "Placeholder": "",            "ComponentOffsetX": 50,            "ComponentOffsetY": 130,            "ComponentWidth": 120,            "ComponentHeight": 43,            "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"        },        {            "ComponentType": "SIGN_MULTI_LINE_TEXT",            "ComponentName": "批注附言",            "Placeholder": "",            "ComponentOffsetX": 150,            "ComponentOffsetY": 300,            "ComponentWidth": 200,            "ComponentHeight": 86,            "ComponentExtra": ""        }    ]}

• ComponentValue: (p) —

  控件填充vaule，ComponentType和传入值类型对应关系：

  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
  • DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
  • SIGN_SEAL : 印章ID，于控制台查询获取，点击查看在控制上的位置
  • SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取，点击查看在控制上的位置

  控件值约束说明：

  特殊控件	填写约束
  企业全称控件	企业名称中文字符中文括号
  统一社会信用代码控件	企业注册的统一社会信用代码
  法人名称控件	最大50个字符，2到25个汉字或者1到50个字母
  签署意见控件	签署意见最大长度为50字符
  签署人手机号控件	国内手机号 13,14,15,16,17,18,19号段长度11位
  签署人身份证控件	合法的身份证号码检查
  控件名称	控件名称最大长度为20字符，不支持表情
  单行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  多行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  勾选框控件	选择填字符串true，不选填字符串false
  选择器控件	同单行文本控件约束，填写选择值中的字符串
  数字控件	请输入有效的数字(可带小数点)
  日期控件	格式：yyyy年mm月dd日
  附件控件	JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID
  图片控件	JPG或PNG图片，填写上传的图片资源ID
  邮箱控件	有效的邮箱地址, w3c标准
  地址控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  省市区控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  性别控件	选择值中的字符串
  学历控件	选择值中的字符串
  水印控件	水印控件设置为CUSTOM_WATERMARK类型时的水印内容

  注： 部分特殊控件需要在控制台配置模板形式创建

• ComponentDateFontSize: (p) —

  【暂未使用】日期签署控件的字号，默认为 12

• DocumentId: (p) —

  【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可

• ComponentDescription: (p) —

  【暂未使用】控件描述，用户自定义，不影响合同发起流程

• OffsetX: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
  注意： 向左调整设置为负数， 向右调整设置成正数

• OffsetY: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
  注意： 向上调整设置为负数， 向下调整设置成正数

• ChannelComponentId: (p) —

  【暂未使用】第三方应用集成平台模板控件 ID 标识

• KeywordOrder: (p) —

  如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。

  • Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列
  • Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列

  在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。

• KeywordPage: (p) —

  如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。

• RelativeLocation: (p) —

  如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值

  • Middle :居中
  • Below :正下方
  • Right :正右方
  • LowerRight :右下角
  • UpperRight :右上角。

  示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方

• KeywordIndexes: (p) —

  如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

  注意：关键字索引是从0开始计数的

• Placeholder: (p) —

  填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
  注：签署控件设置此字段无效

• LockComponentValue: (p) —

  web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑

  • false（默认）：不锁定控件值，允许在页面编辑控件值
  • true：锁定控件值，在页面无法编辑控件值

• ForbidMoveAndDelete: (p) —

  web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件

  • false（默认） :可以移动和删除控件
  • true : 禁止移动和删除控件

# File 'lib/v20210526/models.rb', line 5329

def OffsetY
  @OffsetY
end

#Placeholder ⇒ Object

Parameters:

• ComponentId: (p) —

  控件唯一ID。

  在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

  例：

  • 如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。
  • 如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。

  注：控件ID可以在一个PDF中不可重复
  点击查看ComponentId在模板页面的位置

• ComponentType: (p) —

  如果是Component填写控件类型，则可选的字段为：

  • TEXT : 普通文本控件，输入文本字符串；
  • MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；
  • CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
  • FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；
  • DYNAMIC_TABLE : 动态表格控件；
  • ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
  • SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；
  • DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；
  • DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
  • VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容

  如果是SignComponent签署控件类型，
  需要根据签署人的类型可选的字段为

  • 企业方
    • SIGN_SEAL : 签署印章控件；
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
    • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。

  • 个人方
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择

  注：表单域的控件不能作为印章和签名控件

• ComponentName: (p) —

  在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。

  注：控件名可以在一个PDF中可以重复

  点击查看ComponentName在模板页面的位置

• ComponentRequired: (p) —

  如果是填写控件，ComponentRequired表示在填写页面此控件是否必填

  • false（默认）：可以不填写
  • true ：必须填写此填写控件

  如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响

• ComponentRecipientId: (p) —

  在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可

• FileIndex: (p) —

  【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0

• GenerateMode: (p) —

  控件生成的方式：

  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）

• ComponentWidth: (p) —

  在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。

• ComponentHeight: (p) —

  在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。

• ComponentPage: (p) —

  在绝对定位方式方式下，指定控件所在PDF文件上的页码
  在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。

  注：

  1. 页码编号是从1开始编号的。
  2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。

• ComponentPosX: (p) —

  在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。

• ComponentPosY: (p) —

  在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。

• ComponentExtra: (p) —

  在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。

  ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • FontAlign： Left/Right/Center，左对齐/居中/右对齐
  • FontColor：字符串类型，格式为RGB颜色数字
  • Bold是否加粗：true/false

  参数样例：{"FontColor":"255,0,0","FontSize":12,"Bold":false}

  ComponentType为DATE时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72

  参数样例：{"FontColor":"255,0,0","FontSize":12}

  ComponentType为WATERMARK时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • Opacity： 透明度，范围0 :1
  • Rotate： 水印旋转角度，范围0 :359
  • Density： 水印样式，1-宽松，2-标准（默认值），3-密集，
  • Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中
  • SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息

  参数样例："{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"

  ComponentType为FILL_IMAGE时，支持以下参数：

  • NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中
  • FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放

  ComponentType为SELECTOR时，支持以下参数：

  • WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成

  ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以ComponentTypeLimit参数控制签署方式

  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

  参考样例：{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}印章的对应关系参考下图
  
  ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型，支持指定以下印章类型

  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章
  • OTHER : 其他

  参考样例：{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。
  
  

  ComponentType为SIGN_DATE时，支持以下参数：

  • Font :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"
  • FontSize : 数字类型，范围6-72，默认值为12
  • FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
  • Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
  • Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数

  如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"

  ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：

  • PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）

  参数样例："{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"

  签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时，可以通过以下参数设置签署图片的旋转角度：

  • Rotate：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。
  • RotateRelation：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。

  参数样例：{"Rotate":-30,"RotateRelation":"Component_Id1"}

  签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：

  • Opacity：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度

  参数样例：{"Opacity":0.7}

  签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：

  • UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false

  参数样例：{"UseSealSize":true}

  签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：

  • Values：签署意见预设的需要用户填写的文本
  • ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）

  参数样例：{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}

  关键字模式下支持关键字找不到的情况下不进行报错的设置

  • IgnoreKeywordError :1-关键字查找不到时不进行报错

  场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例："{"IgnoreKeywordError":1}"

  ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：

  • Children: 绝对定位模式下，用来指定此签批控件的组合子控件
  参数样例：
  {"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}
  • ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件
  ChildrenComponent结构体定义:

  字段名称	类型	描述
  ComponentType	string	子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT
  ComponentName	string	子控件名称
  Placeholder	string	子控件提示语
  ComponentValue	string	子控件值（签署方不可设置）
  ComponentOffsetX	float	控件偏移位置X（相对于父控件（签批控件的ComponentX））
  ComponentOffsetY	float	控件偏移位置Y 相对于父控件（签批控件的ComponentY））
  ComponentWidth	float	控件宽
  ComponentHeight	float	控件高
  ComponentExtra	string	控件的附属信息，根据ComponentType设置

  参数样例：

  {    "ChildrenComponents": [        {            "ComponentType": "SIGN_SIGNATURE",            "ComponentName": "个人签名",            "Placeholder": "请签名",            "ComponentOffsetX": 10,            "ComponentOffsetY": 30,            "ComponentWidth": 119,            "ComponentHeight": 43,            "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"        },        {            "ComponentType": "SIGN_SELECTOR",            "ComponentName": "是否同意此协议",            "Placeholder": "",            "ComponentOffsetX": 50,            "ComponentOffsetY": 130,            "ComponentWidth": 120,            "ComponentHeight": 43,            "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"        },        {            "ComponentType": "SIGN_MULTI_LINE_TEXT",            "ComponentName": "批注附言",            "Placeholder": "",            "ComponentOffsetX": 150,            "ComponentOffsetY": 300,            "ComponentWidth": 200,            "ComponentHeight": 86,            "ComponentExtra": ""        }    ]}

• ComponentValue: (p) —

  控件填充vaule，ComponentType和传入值类型对应关系：

  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
  • DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
  • SIGN_SEAL : 印章ID，于控制台查询获取，点击查看在控制上的位置
  • SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取，点击查看在控制上的位置

  控件值约束说明：

  特殊控件	填写约束
  企业全称控件	企业名称中文字符中文括号
  统一社会信用代码控件	企业注册的统一社会信用代码
  法人名称控件	最大50个字符，2到25个汉字或者1到50个字母
  签署意见控件	签署意见最大长度为50字符
  签署人手机号控件	国内手机号 13,14,15,16,17,18,19号段长度11位
  签署人身份证控件	合法的身份证号码检查
  控件名称	控件名称最大长度为20字符，不支持表情
  单行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  多行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  勾选框控件	选择填字符串true，不选填字符串false
  选择器控件	同单行文本控件约束，填写选择值中的字符串
  数字控件	请输入有效的数字(可带小数点)
  日期控件	格式：yyyy年mm月dd日
  附件控件	JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID
  图片控件	JPG或PNG图片，填写上传的图片资源ID
  邮箱控件	有效的邮箱地址, w3c标准
  地址控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  省市区控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  性别控件	选择值中的字符串
  学历控件	选择值中的字符串
  水印控件	水印控件设置为CUSTOM_WATERMARK类型时的水印内容

  注： 部分特殊控件需要在控制台配置模板形式创建

• ComponentDateFontSize: (p) —

  【暂未使用】日期签署控件的字号，默认为 12

• DocumentId: (p) —

  【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可

• ComponentDescription: (p) —

  【暂未使用】控件描述，用户自定义，不影响合同发起流程

• OffsetX: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
  注意： 向左调整设置为负数， 向右调整设置成正数

• OffsetY: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
  注意： 向上调整设置为负数， 向下调整设置成正数

• ChannelComponentId: (p) —

  【暂未使用】第三方应用集成平台模板控件 ID 标识

• KeywordOrder: (p) —

  如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。

  • Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列
  • Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列

  在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。

• KeywordPage: (p) —

  如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。

• RelativeLocation: (p) —

  如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值

  • Middle :居中
  • Below :正下方
  • Right :正右方
  • LowerRight :右下角
  • UpperRight :右上角。

  示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方

• KeywordIndexes: (p) —

  如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

  注意：关键字索引是从0开始计数的

• Placeholder: (p) —

  填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
  注：签署控件设置此字段无效

• LockComponentValue: (p) —

  web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑

  • false（默认）：不锁定控件值，允许在页面编辑控件值
  • true：锁定控件值，在页面无法编辑控件值

• ForbidMoveAndDelete: (p) —

  web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件

  • false（默认） :可以移动和删除控件
  • true : 禁止移动和删除控件

# File 'lib/v20210526/models.rb', line 5329

def Placeholder
  @Placeholder
end

#RelativeLocation ⇒ Object

Parameters:

• ComponentId: (p) —

  控件唯一ID。

  在绝对定位方式方式下，ComponentId为控件的ID，长度不能超过30，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在关键字定位方式下，ComponentId不仅为控件的ID，也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。

  例：

  • 如传入的关键字<font color="red">"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方（<font color="red">前后不能有其他字符）进行对应操作。
  • 如传入的关键字为<font color="red">"甲方签署"，则PDF文件中每个出现关键字的位置（<font color="red">前后可以有其他字符）都会执行相应操作。

  注：控件ID可以在一个PDF中不可重复
  点击查看ComponentId在模板页面的位置

• ComponentType: (p) —

  如果是Component填写控件类型，则可选的字段为：

  • TEXT : 普通文本控件，输入文本字符串；
  • MULTI_LINE_TEXT : 多行文本控件，输入文本字符串；
  • CHECK_BOX : 勾选框控件，若选中填写ComponentValue 填写 true或者 false 字符串；
  • FILL_IMAGE : 图片控件，ComponentValue 填写图片的资源 ID；
  • DYNAMIC_TABLE : 动态表格控件；
  • ATTACHMENT : 附件控件,ComponentValue 填写附件图片的资源 ID列表，以逗号分隔；
  • SELECTOR : 选择器控件，ComponentValue填写选择的字符串内容；
  • DATE : 日期控件；默认是格式化为xxxx年xx月xx日字符串；
  • DISTRICT : 省市区行政区控件，ComponentValue填写省市区行政区字符串内容；
  • VIRTUAL_COMBINATION : 虚拟控件，内部特定控件（CHECK_BOX），本身不填充任何文字内容

  如果是SignComponent签署控件类型，
  需要根据签署人的类型可选的字段为

  • 企业方
    • SIGN_SEAL : 签署印章控件；
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_PAGING_SEAL : 骑缝章；若文件发起，需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部最多组合4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择
    • SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件。

  • 个人方
    • SIGN_DATE : 签署日期控件；
    • SIGN_SIGNATURE : 用户签名控件；
    • SIGN_PAGING_SIGNATURE : 用户签名骑缝章控件；
    • SIGN_OPINION : 签署意见控件，用户需要根据配置的签署意见内容，完成对意见内容的确认；
    • SIGN_VIRTUAL_COMBINATION : 签批控件。内部包含最多4个特定控件（SIGN_SIGNATURE，SIGN_DATA,SIGN_MULTI_LINE_TEXT,SIGN_SELECTOR），本身不填充任何文字内容
    • SIGN_MULTI_LINE_TEXT : 多行文本，仅可用在签批控件内部作为组合控件，单独无法使用，常用作批注附言
    • SIGN_SELECTOR : 选择器，仅可用在签批控件内部作为组合控件，单独无法使用，常用作审批意见的选择

  注：表单域的控件不能作为印章和签名控件

• ComponentName: (p) —

  在绝对定位方式方式下，ComponentName为控件名，长度不能超过20，只能由中文、字母、数字和下划线组成，可以在后续的操作中使用该名称来引用控件。

  在表单域定位方式下，ComponentName不仅为控件名，也是表单域名称。

  注：控件名可以在一个PDF中可以重复

  点击查看ComponentName在模板页面的位置

• ComponentRequired: (p) —

  如果是填写控件，ComponentRequired表示在填写页面此控件是否必填

  • false（默认）：可以不填写
  • true ：必须填写此填写控件

  如果是签署控件，签批控件中签署意见等可以不填写， 其他签署控件不受此字段影响

• ComponentRecipientId: (p) —

  在通过接口拉取控件信息场景下，为出参参数，此控件归属的参与方的角色ID角色（即RecipientId），发起合同时候不要填写此字段留空即可

• FileIndex: (p) —

  【暂未使用】控件所属文件的序号（取值为：0-N）。 目前单文件的情况下，值一直为0

• GenerateMode: (p) —

  控件生成的方式：

  • NORMAL : 绝对定位控件
  • FIELD : 表单域
  • KEYWORD : 关键字（设置关键字时，请确保PDF原始文件内是关键字以文字形式保存在PDF文件中，不支持对图片内文字进行关键字查找）

• ComponentWidth: (p) —

  在绝对定位方式和关键字定位方式下，指定控件宽度，控件宽度是指控件在PDF文件中的宽度，单位为pt（点）。

• ComponentHeight: (p) —

  在绝对定位方式和关键字定位方式下，指定控件的高度， 控件高度是指控件在PDF文件中的高度，单位为pt（点）。

• ComponentPage: (p) —

  在绝对定位方式方式下，指定控件所在PDF文件上的页码
  在使用文件发起的情况下，绝对定位方式的填写控件和签署控件支持使用负数来指定控件在PDF文件上的页码，使用负数时，页码从最后一页开始。例如：ComponentPage设置为-1，即代表在PDF文件的最后一页，以此类推。

  注：

  1. 页码编号是从1开始编号的。
  2. 页面编号不能超过PDF文件的页码总数。如果指定的页码超过了PDF文件的页码总数，在填写和签署时会出现错误，导致无法正常进行操作。

• ComponentPosX: (p) —

  在绝对定位方式下，可以指定控件横向位置的位置，单位为pt（点）。

• ComponentPosY: (p) —

  在绝对定位方式下，可以指定控件纵向位置的位置，单位为pt（点）。

• ComponentExtra: (p) —

  在所有的定位方式下，控件的扩展参数，为JSON格式，不同类型的控件会有部分非通用参数。

  ComponentType为TEXT、MULTI_LINE_TEXT时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • FontAlign： Left/Right/Center，左对齐/居中/右对齐
  • FontColor：字符串类型，格式为RGB颜色数字
  • Bold是否加粗：true/false

  参数样例：{"FontColor":"255,0,0","FontSize":12,"Bold":false}

  ComponentType为DATE时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72

  参数样例：{"FontColor":"255,0,0","FontSize":12}

  ComponentType为WATERMARK时，支持以下参数：

  • Font：目前只支持黑体、宋体、仿宋
  • FontSize： 范围6 :72
  • Opacity： 透明度，范围0 :1
  • Rotate： 水印旋转角度，范围0 :359
  • Density： 水印样式，1-宽松，2-标准（默认值），3-密集，
  • Position： 水印位置，None-平铺（默认值），LeftTop-左上，LeftBottom-左下，RightTop-右上，RightBottom-右下，Center-居中
  • SubType： 水印类型：CUSTOM_WATERMARK-自定义内容，PERSON_INFO_WATERMARK-访问者信息

  参数样例："{\"Font\":\"黑体\",\"FontSize\":20,\"Opacity\":0.1,\"Density\":2,\"SubType\":\"PERSON_INFO_WATERMARK\"}"

  ComponentType为FILL_IMAGE时，支持以下参数：

  • NotMakeImageCenter：bool。是否设置图片居中。false：居中（默认）。 true : 不居中
  • FillMethod : int. 填充方式。0-铺满（默认）；1-等比例缩放

  ComponentType为SELECTOR时，支持以下参数：

  • WordWrap：bool。是否支持选择控件内容自动折行合成。false：不支持（默认）。 true : 支持自动折行合成

  ComponentType为SIGN_SIGNATURE、SIGN_PAGING_SIGNATURE类型时，可以ComponentTypeLimit参数控制签署方式

  • HANDWRITE : 需要实时手写的手写签名
  • HANDWRITTEN_ESIGN : 长效手写签名， 是使用保存到个人中心的印章列表的手写签名(并且包含HANDWRITE)
  • OCR_ESIGN : AI智能识别手写签名
  • ESIGN : 个人印章类型
  • SYSTEM_ESIGN : 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
  • IMG_ESIGN : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)

  参考样例：{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}印章的对应关系参考下图
  
  ComponentType为SIGN_SEAL 或者 SIGN_PAGING_SEAL类型时，可以通过ComponentTypeLimit参数控制签署方签署时要使用的印章类型，支持指定以下印章类型

  • OFFICIAL : 企业公章
  • CONTRACT : 合同专用章
  • FINANCE : 财务专用章
  • PERSONNEL : 人事专用章
  • OTHER : 其他

  参考样例：{\"ComponentTypeLimit\":[\"PERSONNEL\",\"FINANCE\"]} 表示改印章签署区,客户需使用人事专用章或财务专用章盖章签署。
  
  

  ComponentType为SIGN_DATE时，支持以下参数：

  • Font :字符串类型目前只支持"黑体"、"宋体"、仿宋，如果不填默认为"黑体"
  • FontSize : 数字类型，范围6-72，默认值为12
  • FontAlign : 字符串类型，可取Left/Right/Center，对应左对齐/居中/右对齐
  • Format : 字符串类型，日期格式，必须是以下五种之一 “yyyy m d”，”yyyy年m月d日”，”yyyy/m/d”，”yyyy-m-d”，”yyyy.m.d”。
  • Gaps : 字符串类型，仅在Format为“yyyy m d”时起作用，格式为用逗号分开的两个整数，例如”2,2”，两个数字分别是日期格式的前后两个空隙中的空格个数

  如果extra参数为空，默认为”yyyy年m月d日”格式的居中日期特别地，如果extra中Format字段为空或无法被识别，则extra参数会被当作默认值处理（Font，FontSize，Gaps和FontAlign都不会起效）参数样例： "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"

  ComponentType为SIGN_SEAL、SIGN_SIGNATURE类型时，支持以下参数：

  • PageRanges :PageRange的数组，通过PageRanges属性设置该印章在PDF所有页面上盖章（适用于标书在所有页面盖章的情况）

  参数样例："{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"

  签署印章旋转功能，当ComponentType为SIGN_SIGNATURE、SIGN_DATE、SIGN_SEAL时，可以通过以下参数设置签署图片的旋转角度：

  • Rotate：旋转角度，支持范围：-360：360，为正整数时，为顺时针旋转；为负整数时，为逆时针旋转。
  • RotateRelation：旋转关联控件，用于指定关联旋转的控件。例如：让印章控件和签署日期控件按照印章控件为中心旋转（此时，设置印章控件的RotateRelation为日期控件的ComponentId，设置日期签署控件的RotateRelation为印章控件的ComponentId）。

  参数样例：{"Rotate":-30,"RotateRelation":"Component_Id1"}

  签署印章透明度功能设置，当ComponentType为SIGN_SIGNATURE、SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署印章的透明度：

  • Opacity：印章透明度，支持范围：0-1，0.7表示70%的透明度，1表示无透明度

  参数样例：{"Opacity":0.7}

  签署印章大小功能设置，当ComponentType为SIGN_SEAL、SIGN_PAGING_SEAL、SIGN_LEGAL_PERSON_SEAL时，可以通过以下参数设置签署时按照实际印章的大小进行签署，如果印章没有设置大小，那么默认会是4.2cm的印章大小：

  • UseSealSize：使用印章设置的大小盖章，true表示使用印章设置的大小盖章，false表示使用签署控件的大小进行盖章；不传则为false

  参数样例：{"UseSealSize":true}

  签署意见功能设置，当ComponentType为SIGN_OPINION时，可以通过以下参数设置签署意见的相关内容：

  • Values：签署意见预设的需要用户填写的文本
  • ValuesArray：签署意见需要用户按顺序点击的分词（组合后应和Values内容一致）

  参数样例：{"Values":"我已知晓内容并同意签署","ValuesArray":["我","已知晓","内容","并","同意","签署"]}

  关键字模式下支持关键字找不到的情况下不进行报错的设置

  • IgnoreKeywordError :1-关键字查找不到时不进行报错

  场景说明：如果使用关键字进行定位，但是指定的PDF文件中又没有设置的关键字时，发起合同会进行关键字是否存在的校验，如果关键字不存在，会进行报错返回。如果不希望进行报错，可以设置"IgnoreKeywordError"来忽略错误。请注意，如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有，还是会触发报错逻辑。参数样例："{"IgnoreKeywordError":1}"

  ComponentType为SIGN_VIRTUAL_COMBINATION或者VIRTUAL_COMBINATION时，支持以下参数：

  • Children: 绝对定位模式下，用来指定此签批控件的组合子控件
  参数样例：
  {"Children":["ComponentId_29","ComponentId_27","ComponentId_28","ComponentId_30"]}
  • ChildrenComponents: 关键字定位模式下，用来指定此签批控件的组合子控件
  ChildrenComponent结构体定义:

  字段名称	类型	描述
  ComponentType	string	子控件类型-可选值:SIGN_SIGNATURE,SIGN_DATE,SIGN_SELECTOR,SIGN_MULTI_LINE_TEXT
  ComponentName	string	子控件名称
  Placeholder	string	子控件提示语
  ComponentValue	string	子控件值（签署方不可设置）
  ComponentOffsetX	float	控件偏移位置X（相对于父控件（签批控件的ComponentX））
  ComponentOffsetY	float	控件偏移位置Y 相对于父控件（签批控件的ComponentY））
  ComponentWidth	float	控件宽
  ComponentHeight	float	控件高
  ComponentExtra	string	控件的附属信息，根据ComponentType设置

  参数样例：

  {    "ChildrenComponents": [        {            "ComponentType": "SIGN_SIGNATURE",            "ComponentName": "个人签名",            "Placeholder": "请签名",            "ComponentOffsetX": 10,            "ComponentOffsetY": 30,            "ComponentWidth": 119,            "ComponentHeight": 43,            "ComponentExtra": "{\"ComponentTypeLimit\":[\"SYSTEM_ESIGN\"]}"        },        {            "ComponentType": "SIGN_SELECTOR",            "ComponentName": "是否同意此协议",            "Placeholder": "",            "ComponentOffsetX": 50,            "ComponentOffsetY": 130,            "ComponentWidth": 120,            "ComponentHeight": 43,            "ComponentExtra": "{\"Values\":[\"同意\",\"不同意\",\"再想想\"],\"FontSize\":12,\"FontAlign\":\"Left\",\"Font\":\"黑体\",\"MultiSelect\":false}"        },        {            "ComponentType": "SIGN_MULTI_LINE_TEXT",            "ComponentName": "批注附言",            "Placeholder": "",            "ComponentOffsetX": 150,            "ComponentOffsetY": 300,            "ComponentWidth": 200,            "ComponentHeight": 86,            "ComponentExtra": ""        }    ]}

• ComponentValue: (p) —

  控件填充vaule，ComponentType和传入值类型对应关系：

  • TEXT : 文本内容
  • MULTI_LINE_TEXT : 文本内容， 可以用 \n 来控制换行位置
  • CHECK_BOX : true/false
  • FILL_IMAGE、ATTACHMENT : 附件的FileId，需要通过UploadFiles接口上传获取
  • SELECTOR : 选项值
  • DYNAMIC_TABLE - 传入json格式的表格内容，详见说明：数据表格
  • DATE : 格式化：xxxx年xx月xx日（例如：2024年05月28日）
  • SIGN_SEAL : 印章ID，于控制台查询获取，点击查看在控制上的位置
  • SIGN_PAGING_SEAL : 可以指定印章ID，于控制台查询获取，点击查看在控制上的位置

  控件值约束说明：

  特殊控件	填写约束
  企业全称控件	企业名称中文字符中文括号
  统一社会信用代码控件	企业注册的统一社会信用代码
  法人名称控件	最大50个字符，2到25个汉字或者1到50个字母
  签署意见控件	签署意见最大长度为50字符
  签署人手机号控件	国内手机号 13,14,15,16,17,18,19号段长度11位
  签署人身份证控件	合法的身份证号码检查
  控件名称	控件名称最大长度为20字符，不支持表情
  单行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  多行文本控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  勾选框控件	选择填字符串true，不选填字符串false
  选择器控件	同单行文本控件约束，填写选择值中的字符串
  数字控件	请输入有效的数字(可带小数点)
  日期控件	格式：yyyy年mm月dd日
  附件控件	JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID
  图片控件	JPG或PNG图片，填写上传的图片资源ID
  邮箱控件	有效的邮箱地址, w3c标准
  地址控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  省市区控件	只允许输入中文，英文，数字，中英文标点符号，不支持表情
  性别控件	选择值中的字符串
  学历控件	选择值中的字符串
  水印控件	水印控件设置为CUSTOM_WATERMARK类型时的水印内容

  注： 部分特殊控件需要在控制台配置模板形式创建

• ComponentDateFontSize: (p) —

  【暂未使用】日期签署控件的字号，默认为 12

• DocumentId: (p) —

  【暂未使用】控件归属的文档的ID， 发起合同时候不要填写此字段留空即可

• ComponentDescription: (p) —

  【暂未使用】控件描述，用户自定义，不影响合同发起流程

• OffsetX: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行横坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏左或偏右，可以通过调整横坐标方向的参数来使控件位置更加准确。
  注意： 向左调整设置为负数， 向右调整设置成正数

• OffsetY: (p) —

  如果控件是关键字定位方式，可以对关键字定位出来的区域进行纵坐标方向的调整，单位为pt（点）。例如，如果关键字定位出来的区域偏上或偏下，可以通过调整纵坐标方向的参数来使控件位置更加准确。
  注意： 向上调整设置为负数， 向下调整设置成正数

• ChannelComponentId: (p) —

  【暂未使用】第三方应用集成平台模板控件 ID 标识

• KeywordOrder: (p) —

  如果控件是关键字定位方式，指定关键字排序规则时，可以选择Positive或Reverse两种排序方式。

  • Positive :表示正序，即根据关键字在PDF文件内的顺序进行排列
  • Reverse :表示倒序，即根据关键字在PDF文件内的反序进行排列

  在指定KeywordIndexes时，如果使用Positive排序方式，0代表在PDF内查找内容时，查找到的第一个关键字；如果使用Reverse排序方式，0代表在PDF内查找内容时，查找到的最后一个关键字。

• KeywordPage: (p) —

  如果控件是关键字定位方式，在KeywordPage中指定关键字页码时，将只会在该页码中查找关键字，非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。

• RelativeLocation: (p) —

  如果控件是关键字定位方式，关键字生成的区域的对齐方式， 可以设置下面的值

  • Middle :居中
  • Below :正下方
  • Right :正右方
  • LowerRight :右下角
  • UpperRight :右上角。

  示例：如果设置Middle的关键字盖章，则印章的中心会和关键字的中心重合，如果设置Below，则印章在关键字的正下方

• KeywordIndexes: (p) —

  如果控件是关键字定位方式，关键字索引是指在PDF文件中存在多个相同的关键字时，通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如，[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。

  注意：关键字索引是从0开始计数的

• Placeholder: (p) —

  填写控件在腾讯电子签小程序填写界面展示的提示信息，例如，在身份证号码填写控件中，提示信息可以设置成“请输入18位身份证号码”。
  注：签署控件设置此字段无效

• LockComponentValue: (p) —

  web嵌入发起合同场景下， 是否锁定填写和签署控件值不允许嵌入页面进行编辑

  • false（默认）：不锁定控件值，允许在页面编辑控件值
  • true：锁定控件值，在页面无法编辑控件值

• ForbidMoveAndDelete: (p) —

  web嵌入发起合同场景下，是否禁止移动和删除填写和签署控件

  • false（默认） :可以移动和删除控件
  • true : 禁止移动和删除控件

# File 'lib/v20210526/models.rb', line 5329

def RelativeLocation
  @RelativeLocation
end

Instance Method Details

#deserialize(params) ⇒ Object

# File 'lib/v20210526/models.rb', line 5361

def deserialize(params)
  @ComponentId = params['ComponentId']
  @ComponentType = params['ComponentType']
  @ComponentName = params['ComponentName']
  @ComponentRequired = params['ComponentRequired']
  @ComponentRecipientId = params['ComponentRecipientId']
  @FileIndex = params['FileIndex']
  @GenerateMode = params['GenerateMode']
  @ComponentWidth = params['ComponentWidth']
  @ComponentHeight = params['ComponentHeight']
  @ComponentPage = params['ComponentPage']
  @ComponentPosX = params['ComponentPosX']
  @ComponentPosY = params['ComponentPosY']
  @ComponentExtra = params['ComponentExtra']
  @ComponentValue = params['ComponentValue']
  @ComponentDateFontSize = params['ComponentDateFontSize']
  @DocumentId = params['DocumentId']
  @ComponentDescription = params['ComponentDescription']
  @OffsetX = params['OffsetX']
  @OffsetY = params['OffsetY']
  @ChannelComponentId = params['ChannelComponentId']
  @KeywordOrder = params['KeywordOrder']
  @KeywordPage = params['KeywordPage']
  @RelativeLocation = params['RelativeLocation']
  @KeywordIndexes = params['KeywordIndexes']
  @Placeholder = params['Placeholder']
  @LockComponentValue = params['LockComponentValue']
  @ForbidMoveAndDelete = params['ForbidMoveAndDelete']
end