跳到主要内容

插入背景

更新时间 2025/02/22 07:19:43

英飞画布服务端支持基于 Restful API 往画布中插入图片作为画布背景。 区别于图片元素，画布背景图片无法被选中及编辑，仅当画布视野与画布背景图片存在交集，且未被画布元素完全遮盖的情况下可见。

前提条件​

请求路径​

https://developer.infi.cn/infi/api/v1/boards/bgImages

请求参数​

基本请求参数如下：

字段
类型
描述
必填
recordId
string
画布 ID
是
userId
string
元素创建者用户 loginName
是
element
Object
对象数据接口参考下方图片信息结构说明
是

图片信息结构说明如下：

字段
类型
描述
必填
picUrl
string
图片公开链接
是
imageType
1/2/3
图片类型，详见下方说明
是
position.x
number
图片左上角x坐标
是
position.y
number
图片左上角y坐标
是
size.width
number
图片宽度
是
size.height
number
图片高度
是
alpha
number
图片透明度，值范围为 [0, 1], 默认为 1
否

说明：

  • imageType 图片类型：1 代表 jpg 格式图片；2 代表 gif 格式图片；3 代表 png 格式图片。 注：
    • 请确保该类型与待插入图片的类型保持一致。
    • 若插入 gif 图片，则只有第一帧会显示在画布中。

请求参数示例​

{
  "recordId": "SAMPLE_RECORD_ID",
  "userId": "SAMPLE_USER_LOGIN_NAME",
  "element": {
    "picUrl": "SAMPLE_PIC_URL",
    "imageType": 3,
    "position": {
      "x": 100,
      "y": 100
    },
    "size": {
      "width": 1280,
      "height": 720
    },
    "alpha": 1
  }
}

请求 curl 示例​

curl --location --request POST \
      --header 'token: YOUR_ACCESS_TOKEN' \
      --header 'Content-Type: application/json' \
      --data '{ PAYLOADS_HERE }' \
      https://developer.infi.cn/infi/api/v1/boards/bgImages

注意：请确保将 PAYLOADS_HERE 替换为请求参数中列举的数据。

请求成功情况​

响应的 Http 状态码为 200 时表示请求成功。

请求失败情况​

响应的 Http 状态码不为 200 时表示请求失败，如需更多信息请参考请求错误说明文档。