讯飞文档开发者中心

# 编辑器

# getContents

  • 功能

获取指定区域的文档内容，返回 Delta 数据。

  • 定义
getContents(index: number = 0, length: number = remaining): Delta

  • 参数

    • index: 起始位置，默认 0。
    • length: 长度，默认剩余长度。

  • 返回

文档内容。

# setContents

  • 功能

用给定的内容覆盖原文档内容。内容将会用换行符结尾。返回代表对应变化的 Delta 数据。如果给定的 Delta 没有无效的操作，返回值和传入的值相同。

  • 定义
setContents(delta: Delta, source: Source = 'api'): Delta

  • 参数

    • delta: 新的内容。
    • source: 操作来源，影响是否参与协同处理。

  • 返回

变更后的文档内容。

# getSemanticHTML

  • 功能

获取 HTML 格式的文档内容。

  • 定义
getSemanticHTML(): string
  • 返回

HTML。

# getLength

  • 功能

获取文档内容长度。

  • 定义
getLength(): number
  • 返回

文档内容长度。

# getSelection

  • 功能

获取用户当前的选区。

  • 定义
getSelection(): Range
  • 返回

选区，包括起始位置 index 和选区长度 length。

# setSelection

  • 功能

给定范围设置用户的选区，同时焦点在编辑器上。作为选区传入  null，将会使编辑器失去焦点。

  • 定义
setSelection(index: number, length: number, source: Source = 'api')

setSelection(range: Range | null, source: Source = 'api')
  • 参数
    • index: 选区起始位置。
    • length: 选区长度。
    • source: 操作来源。

# getBounds

  • 功能

返回给定选区相对于编辑器容器的的像素位置和尺寸。

  • 定义
getBounds(index: number, length: number = 0): Bounds

  • 参数

    • index: 选区起始位置。
    • length: 选区长度，默认 0。

  • 返回

包含位置和大小的 Bounds 对象，详情请参考: Bounds。

# insertText

  • 功能

向编辑器中插入文本，可选带有指定的文本格式或多个文本格式，返回代表对应变化的数据。

  • 定义
insertText(index: number, text: string, source: Source = 'api'): Delta

insertText(
  index: number,
  text: string,
  format: string,
  value: any,
  source: Source = 'api'
): Delta

insertText(
  index: number,
  text: string,
  format: { [string]: any },
  source: Source = 'api'
): Delta

  • 参数

    • index: 插入文本的位置。
    • text: 文本内容。
    • format: 文本格式名称。
    • value: 文本格式值。
    • formats: 文本格式键值对象。
    • source: 操作来源。

  • 返回

插入文本带来的 Delta 变更。

  • 示例
editor.insertText(0, 'Hello', 'bold', true)

editor.insertText(5, 'foo', {
  bold: 'true',
  italic: true,
})

# getFormat

  • 功能

获取选区范围内文本的一般格式。

  • 定义
getFormat(range: Range = current): { [string]: any }

getFormat(index: number, length: number = 0): { [string]: any }

  • 参数

    • index: 选区起始位置。
    • length: 选区长度。
    • range: 包含起始位置和长度的选区对象。

  • 返回

格式键值对象。

# enable

  • 功能

设置或禁用文档可编辑状态。

  • 定义
enable(enabled: boolean = true)
  • 参数
    • enabled: 是否可编辑，默认 true。

# blur

  • 功能

让编辑器失去焦点。

  • 定义
blur()

# focus

  • 功能

让编辑器聚焦，并回复最后一次的选区。

  • 定义
focus()

# hasFocus

  • 功能

检查焦点是否在编辑器上。

注意

若焦点在工具栏或提示框上，不算作在编辑器上。

  • 定义
hasFocus(): boolean
  • 返回

编辑器拥有焦点返回 true，否则返回 false。

# scrollIntoView

  • 功能

将光标所在位置滚动至可视区域。

  • 定义
scrollIntoView()

← 格式化 →