讯飞文档开发者中心

# 嵌入对象

  • 功能

插入链接。

  • 定义
insertLink(name: string, href: string): Delta

  • 参数

    • name: 练级的名称。
    • href: 链接的地址。

  • 返回

格式化产生的变更 Delta 数据。

# 表格 table

  • 功能

插入表格。

  • 定义
insertTable(rows: number, cols: number): Delta

  • 参数

    • rows: 表格的行数。
    • cols: 表格的列数。

  • 返回

格式化产生的变更 Delta 数据。

# 分割线 divide

  • 功能

插入分割线。

  • 定义
insertDivide(): Delta
  • 返回

格式化产生的变更 Delta 数据。

# 代码块 code-block

  • 功能

插入链接。

  • 定义
insertCodeBlock(value: boolean): Delta

  • 参数

    • value = true: 设置为代码块。
    • value = false: 取消代码块。

  • 返回

格式化产生的变更 Delta 数据。

# 公式 formula

  • 功能

插入公式。

  • 定义
insertLink(name: string, href: string): Delta

  • 参数

    • value: Tex 公式。

  • 返回

格式化产生的变更 Delta 数据。

# 附件 attachment

  • 功能

插入附件。

插入附件是一个异步过程，涉及附件的上传和进度更新。整个过程分为两步：

  1. 插入附件，在编辑器中增加附件占位。
  2. 更新进度，更新附件占位的进度。当进度达到 100% 时，完成附件插入流程。
  • 定义
attachment: {
  insert(
    objectId: string,
    option: {
      name: string
      size: number
    }
  )

  update(
    objectId: string,
    option: {
      status: 'progress' | 'success' | 'failure'
      progress: number
      name: string
      size: number
    }
  )
}

# insert()

  • 参数

    • objectId: 附件对象 ID，生成规则请参考《OSS》。
    • option: 选项：
      • name: 附件名称。
      • size: 附件大小，单位字节。

  • 返回

无。

# update()

  • 参数

    • objectId: 附件对象 ID，生成规则请参考《OSS》。
    • option: 选项：
      • status: 状态：
        • progress: 上传中。
        • success: 成功。
        • failure: 失败。
      • progress: 进度，0~100。
      • name: 附件名称。
      • size: 附件大小，单位字节。

  • 返回

无。

# 图片 image

  • 功能

插入图片。

插入图片和插入附件一样是一个异步过程，涉及图片的上传和进度更新。此外，还涉及上传完成后图片的渲染（展示）。

因此，整个过程分为三步：

  1. 插入图片，在编辑器中增加图片占位。
  2. 更新进度，更新图片占位的进度。当进度达到 100% 时，完成图片插入流程。
  3. 渲染图片，占位图片可能与最终图片不一致。调用渲染过程可以正确展示最终图片。
  • 定义
image: {
  insert(
    objectId: string,
    option: {
      placeholder: string
      name?: string
      size?: number
      index?: number
    }
  )

  update(
    objectId: string,
    option: {
      status: 'progress' | 'success' | 'failure'
      progress: number
      oriWidth: number
      oriHeight: number
      width: number
      height: number
      name?: string
      size?: number
    }
  )

  render(objectId: string, src: string)
}

# insert()

  • 参数

    • objectId: 图片对象 ID，生成规则请参考《OSS》。
    • option: 选项：
      • placeholder: 占位图地址，需要保证可访问。
      • name: 可选。图片名称。
      • size: 可选。图片大小，单位字节。
      • index: 可选。图片的索引位置。

  • 返回

无。

# update()

  • 参数

    • objectId: 图片对象 ID，生成规则请参考《OSS》。
    • option: 选项：
      • status: 状态：
        • progress: 上传中。
        • success: 成功。
        • failure: 失败。
      • progress: 进度，0~100。
      • oriWidth: 图片原始宽度。
      • oriHeight: 图片原始高度。
      • width: 图片实际显示宽度。
      • height: 图片实际显示高度。
      • name: 可选。图片名称。
      • size: 可选。图片大小，单位字节。

  • 返回

无。

# render()

  • 参数

    • objectId: 图片对象 ID，请参考《OSS》。
    • src: 图片地址。可通过 objectId 生成，请参考 获取下载链接。

  • 返回

无。

# 音频 audio

  • 功能

插入音频，音频支持在编辑器中直接播放。

插入音频和插入附件一样是一个异步过程，涉及音频的上传和进度更新。此外，还涉及上传完成后音频的渲染（可播放）。

因此，整个过程分为三步：

  1. 插入音频，在编辑器中增加音频占位。
  2. 更新进度，更新音频占位的进度。当进度达到 100% 时，完成音频插入流程。
  3. 渲染音频，渲染之后音频可正常播放。
  • 定义
audio: {
  insert(
    objectId: string,
    option: {
      name: string
      size: number
    }
  ): Delta

  update(
    objectId: string,
    option: {
      status: 'progress' | 'success' | 'failure'
      progress: number
      name: string
      size: number
    }
  )

  render(objectId: string, src: string)
}

# insert()

  • 参数

    • objectId: 音频对象 ID，生成规则请参考《OSS》。
    • option: 选项：
      • name: 音频名称。
      • size: 音频大小，单位字节。

  • 返回

无。

# update()

  • 参数

    • objectId: 音频对象 ID，生成规则请参考《OSS》。
    • option: 选项：
      • status: 状态：
        • progress: 上传中。
        • success: 成功。
        • failure: 失败。
      • progress: 进度，0~100。
      • name: 音频名称。
      • size: 音频大小，单位字节。

  • 返回

无。

# render()

  • 参数

    • objectId: 音频对象 ID，请参考《OSS》。
    • src: 音频地址。可通过 objectId 生成，请参考 获取下载链接。

  • 返回

无。

← 附加模块 →