contract_lock_sdk/model/common/SignatoryRect.go

package common


// 【签署位置】签署位置 【作用】 指定签署动作的签署位置 【传参方式】 签署位置有以下两种表现方式：   1、用关键字确定坐标： keyword：关键字。  keywordIndex：第几个关键字,0:全部,-1:最后一个,其他:第keyIndex个,默认为1。  关键字处于实际印章位置y轴中央。  offsetX：横坐标偏移量；默认为0，取值范围是(-1, 1)。  offsetY：纵坐标偏移量；默认为0，取值范围是(-1, 1)。  找到实际印章位置的坐标(x, y)，再加上偏移量(offsetX, offsetY)，最终得到的坐标是(x+offsetX, y+offsetY)，如果实际印章位置超出纸张边缘，会适当偏移位置。  偏移量的坐标原点是实际印章位置的坐标(x, y)的左下角。   2、直接确定坐标： page：印章所在页码；从1开始。  offsetX：横坐标；默认电子签约页的宽为1，所以取值范围是(0, 1)。  offsetY：纵坐标；默认电子签约页的高为1，所以取值范围是(0, 1)。  由page确定页码，由(offsetX, offsetY)确定坐标。  坐标原点是电子签约页的左下角，坐标是指印章图片的左下角的坐标。
type SignatoryRect struct {
	// <ext>core:true</ext> 【签署位置类型】签署位置类型 【传参】 取值范围：SEAL_PERSONAL（个人签名）, SEAL_CORPORATE（组织印章-正文章）,SEAL_PRACTICE（个人执业章签章）,TIMESTAMP（时间戳），ACROSS_PAGE（骑缝章），ACROSS_PAGE_ODD（奇数页骑缝章），ACROSS_PAGE_EVEN（偶数页骑缝章），ANNOTATION（签署批注），PERSONAL_ACROSS_PAGE（骑缝签名），PERSONAL_ACROSS_PAGE_ODD（奇数页骑缝签名），PERSONAL_ACROSS_PAGE_EVEN（偶数页骑缝签名），ACROSS_PAGE_SCOPE（指定页面范围骑缝章）。 【特殊说明】 1、骑缝章类型只需要指定电子签约文档id和Y轴坐标 2、用印流程配置不允许添加日期，则传入的时间戳无效 3、支持的批注类型默认取用印流程配置，若流程未开启则默认为“文字批注”类型
	RectType string `json:"rectType"`
	// <ext>core:true</ext> 【骑缝章位置指定方式】骑缝章位置指定方式 【作用】 指定骑缝章位置时，可以通过此参数控制位置的指定方式 【传参】 取值范围：SINGLE_DOCUMENT（每份文档单独指定骑缝章位置），ALL_DOCUMENT（多份文档合并指定骑缝章位置）；不传值默认为：SINGLE_DOCUMENT（每份文档单独指定骑缝章位置）。
	AcrossType string `json:"acrossType,omitempty"`
	// <ext>core:true</ext> 【文字批注字体大小】文字批注字体大小 【作用】 指定批注位置时，可设置文字批注的字体大小，防止用户添加的文字批注字体过大或过小 【传参】 1、最小值：12（包含），最大值：42（包含）。 2、单位：px。
	AnnotationFontSize *float64 `json:"annotationFontSize,omitempty"`
	// <ext>core:true</ext> 【批注位置是否必签】批注位置是否必签 【作用】 指定批注位置时，可以通过此参数控制批注位置是否为必签 【传参】 取值范围：true（必签），false（非必签）；不传值默认为：false（非必签）。
	MustSignAnnotation *bool `json:"mustSignAnnotation,omitempty"`
	// <ext>core:true</ext> 【X轴坐标/偏移量】X轴坐标/偏移量 【作用】 1、通过坐标指定签署位置时，根据坐标的原点，根据坐标单位（offsetUnit）确认签署位置横向位置（例如，以页面左下角为原点时，根据坐标单位确认签署位置左下角所在横向位置） 2、通过关键字指定签署位置时，以位置块的初始定位为原点，根据偏移量单位（offsetUnit）确认签署位置需横向偏移量 【传参】 不传值默认为：0。
	OffsetX *float64 `json:"offsetX,omitempty"`
	// <ext>core:true</ext> 【Y轴坐标/偏移量】Y轴坐标/偏移量 【作用】 1、通过坐标指定签署位置时，根据坐标的原点，根据坐标单位（offsetUnit）确认签署位置纵向位置（例如，以页面左下角为原点时，根据坐标单位确认签署位置左下角所在纵向位置） 2、通过关键字指定签署位置时，以位置块的初始定位为原点，根据偏移量单位（offsetUnit）确认签署位置需纵向偏移量 【传参】 不传值默认为：0。
	OffsetY *float64 `json:"offsetY,omitempty"`
	// 【坐标原点位置】坐标原点位置 【作用】 通过坐标指定签署位置时，可指定坐标原点。指定签署位置时，按指定的坐标原点为起始点设置位置的横纵坐标 【传参】 取值范围：LEFT_TOP (页面左上角),RIGHT_TOP (页面右上角),LEFT_BOTTOM (页面左下角),RIGHT_BOTTOM (页面右下角);不传值默认为:LEFT_BOTTOM (页面左下角)
	OriginPosition string `json:"originPosition,omitempty"`
	// <ext>core:true</ext> 【签署页码】签署页码 【作用】 指定签署位置所在的文件页码 【传参】 1、使用坐标指定位置时必须传入。 2、0：全部页，-1：最后一页，其他：第page页（例如：第7页，则传入7）。
	Page *int64 `json:"page,omitempty"`
	// <ext>core:true</ext> 【关键字】关键字 【作用】 通过查询签署文件中的关键字来指定签署位置，如指定在甲方这样的关键字后方生成签署位置则传入甲方
	Keyword string `json:"keyword,omitempty"`
	// <ext>core:true</ext> 【关键字索引】关键字索引 【作用】 使用关键字指定签署位置时，指定哪几个关键字需要指定签署位置，比如可以指定第1个关键字、倒数第1个关键字等 【传参】 1、默认为1，即第1个关键字。 2、0：全部，-1：最后一个，其他：第keywordIndex个（例如：第7个，则传入7）。
	KeywordIndex *int64 `json:"keywordIndex,omitempty"`
	// 【坐标/偏移量单位】坐标/偏移量单位 【作用】 1、通过坐标指定签署位置时，用于设置坐标值的单位 2、通过关键字指定签署位置时，用于设置偏移量的单位 3、单位包括3种，具体如下： （1）比例：页面宽度、高度为1，通过比例定位坐标或偏移量，通过坐标定位时传值范围为0-1，通过关键字指定签署位置时偏移量范围为-1~1 （2）毫米：通过相对距离定位坐标或偏移量，单位为毫米，传值范围不限制 （3）磅：通过相对距离定位坐标或偏移量，单位为磅，传值范围不限制 【传参】 取值范围：RATIO（比例），MM（毫米），POINT（磅）；不传值默认为：RATIO（比例）。
	OffsetUnit string `json:"offsetUnit,omitempty"`
	// <ext>core:true</ext> 【签章初始定位位置】签章初始定位位置 【作用】 使用关键字定位时传入，用于确定签署位置在关键字的哪个方向 【传参】 取值范围：RIGHT（关键字右侧），LEFT（关键字左侧），CENTER（签章中心与关键字中心重合），UPPER_LEFT(关键字上方左对齐），UPPER_RIGHT(关键字上方右对齐），UPPER_CENTER(关键字上方居中），LOWER_LEFT(关键字下方左对齐），LOWER_RIGHT(关键字下方右对齐），LOWER_CENTER（关键字下方居中）；不传值默认为：RIGHT（关键字右侧）。
	RelativePosition string `json:"relativePosition,omitempty"`
	// <ext>core:true</ext> 【签署位置宽度】签署位置宽度 【作用】 设置签署位置的宽度，防止用户在文件上添加的签名过大或过小 【传参】 1、支持个人签名、时间戳位置，不支持签章位置；支持文字批注，超出设置的宽度会自动换行。 2、仅传宽度时，高度按比例适配，两者均传参以宽度为准。 3、最小值：10（包含），最大值：120（包含）；不传值默认为：系统默认大小。
	Width *float64 `json:"width,omitempty"`
	// <ext>core:true</ext> 【签署位置高度】签署位置高度 【作用】 设置签署位置的高度，防止用户在文件添加的签名过大或过小 【传参】 1、支持个人签名、时间戳位置，不支持签章位置。 2、仅传宽度时，高度按比例适配，两者均传参以宽度为准。 3、最小值：4（包含），最大值：48（包含）；不传值默认为：系统默认大小。
	Height *float64 `json:"height,omitempty"`
	// <ext>core:true</ext> 【签署位置旋转角度】签署位置旋转角度 【作用】 指定签署位置的旋转角度，当文件为横向或扫描件存在角度偏移时，可以指定签署位置的旋转角度 【传参】 1、支持个人签名、时间戳、签章位置 2、旋转中心为签署左下角，方向为顺时针 3、最小值：0（包含），最大值：360（包含）；不传值默认为：不旋转。单位：度。
	RotationDegrees *float64 `json:"rotationDegrees,omitempty"`
	// <ext>core:true</ext> 【签署位置是否可编辑】签署位置是否可编辑 【作用】 控制此签署位置是否可以进行缩放、旋转、拖动、删除等编辑操作 【传参】 取值范围：true（可以编辑），false（不可编辑）；不传值默认为：true（可以编辑）。
	Modifiable *bool `json:"modifiable,omitempty"`
	// <ext>core:true;format:string</ext> 【签署文档id】签署文档id 【作用】 用于指定签署位置所在的签署文档 【传参】 不传入documentid（签署文档id）、documentids（签署文档id集合）、templates（文件模板id集合）时，签署位置默认对全部签署文档生效
	DocumentId *int64 `json:"documentId,omitempty"`
	// <ext>core:true;format:string</ext> 【签署文档id集合】签署文档id集合 【作用】  用于指定签署位置所在的签署文档 【传参】  1、格式：[123123123213,123213213213] 2、不传入documentId、documentId、templates时，签署位置默认对全部签署文档生效
	DocumentIds []int64 `json:"documentIds,omitempty"`
	// <ext>core:true;format:string</ext> 【文件模板id】文件模板id 【作用】 用印流程绑定文件模板时，支持传入模板id用于指定签署位置 【传参】 1、传入多个模板id时，使用“，”间隔，示例：[123123123213,123213213213] 2、不传入documentid（签署文档id）、documentids（签署文档id集合）、templates（文件模板id集合）时，签署位置默认对全部签署文档生效。
	Templates []int64 `json:"templates,omitempty"`
	// <ext>core:true</ext> 【骑缝章自定义页面加盖】骑缝章自定义页面加盖 【传参】 1、可传入页码或页码范围，多组页码或页码范围之间用英文逗号(,)分隔，例如：2,4~7,8~11。 2、当rectType（签署位置类型）为ACROSS_PAGE_SCOPE（指定页面范围骑缝章）时，此参数必填。
	SealPageConfig string `json:"sealPageConfig,omitempty"`
}