讯飞文档开发者中心

# 格式化

大多数的格式化接口，都有格式化参数类型约束（白名单）。具体参见 格式化参数类型。

对于颜色，为了更好地适配暗黑模式，采用了预定义颜色名，而非直接使用 #RGB 的形式。具体参见 颜色对照表。

# 标题 header

  • 功能

设置标题层级或取消设置标题。

  • 定义
format(key: 'header', value: HeaderValue, source: Source = 'api'): Delta

  • 参数

    • $value: 设置为对应层级的标题。
    • false: 设置为正文。

  • 返回

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

# 引用 blockquote

  • 功能

设置或取消段落的样式为引用块。

  • 定义
format(key: 'blockquote', value: boolean, source: Source = 'api'): Delta

  • 参数

    • true: 设置为引用块。
    • false: 设置引用块。

  • 返回

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

# 字体 font

  • 功能

设置字体或恢复默认字体。

  • 定义
format(key: 'font', value: FontValue, source: Source = 'api'): Delta

  • 参数

    • $value: 设置为对应名称的字体。
    • false: 恢复为默认字体。

  • 返回

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

# 字号 size

  • 功能

设置字号或恢复默认字号。

  • 定义
format(key: 'size', value: SizeValue, source: Source = 'api'): Delta

  • 参数

    • $value: 设置为对应的字号。
    • false: 恢复为默认字号。

  • 返回

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

# 加粗 bold

  • 功能

设置或取消文字加粗。

  • 定义
format(key: 'bold', vlaue: boolean, source: Source = 'api'): Delta

  • 参数

    • true: 设置加粗。
    • false: 取消加粗。

  • 返回

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

# 倾斜 italic

  • 功能

设置或取消文字倾斜。

  • 定义
format(key: 'italic', value: boolean, source: Source = 'api'): Delta

  • 参数

    • true: 设置倾斜。
    • false: 取消倾斜。

  • 返回

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

# 删除线 strike

  • 功能

设置或取消文字删除线。

  • 定义
format(key: 'strike', value: boolean, source: Source = 'api'): Delta

  • 参数

    • true: 设置删除线。
    • false: 取消删除线。

  • 返回

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

# 下划线 underline

  • 功能

设置或取消文字下划线。

  • 定义
format(key: 'underline', value: boolean, source: Source = 'api'): Delta

  • 参数

    • true: 设置下划线。
    • false: 取消下划线。

  • 返回

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

# 标注 script

  • 功能

设置或取消文字的上标、下标。

  • 定义
format(key: 'script', value: ScriptValue, source: Source = 'api'): Delta

  • 参数

    • "sup": 设置为上标。
    • "sub": 设置为下标。
    • false: 取消上标或下标。

  • 返回

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

# 行内代码 code

  • 功能

设置或取消文字的行内代码样式。

  • 定义
format(key: 'code', value: boolean, source: Source = 'api'): Delta

  • 参数

    • true: 设置为行内代码。
    • false: 取消行内代码。

  • 返回

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

# 颜色 color

  • 功能

设置或取消文字的颜色。

  • 定义
format(key: 'color', value: string, source: Source = 'api'): Delta

  • 参数

    • $value: 设置为指定的颜色。
    • false: 恢复为默认颜色。

  • 返回

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

# 背景色 background

  • 功能

设置或取消背景色。

  • 定义
format(key: 'background', value: string, source: Source = 'api'): Delta

  • 参数

    • $value: 设置为指定的背景色。
    • false: 恢复为默认背景色。

  • 返回

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

# 列表 list

  • 功能

设置或取消列表样式，支持有序列表、无序列表（项目符号）、待（已）办事项。

  • 定义
format(key: 'list', value: ListValue, source: Source = 'api'): Delta

  • 参数

    • "ordered": 设置为有序列表。
    • "bullet": 设置为无序列表（项目符号）。
    • "unchecked": 设置为待办事项。
    • "checked": 设置为已办事项。
    • false: 取消列表样式。

  • 返回

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

# 缩进 indent

  • 功能

设置或取消段落的缩进层级。

  • 定义
format(key: 'indent', value: IndentValue, source: Source = 'api'): Delta

  • 参数

    • "+1": 增加缩进层级。
    • "-1": 减少缩进层级。
    • false: 取消缩进。

  • 返回

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

# 对齐 align

  • 功能

设置或取消段落的对齐方式。

  • 定义
format(key: 'align', value: AlignValue, source: Source = 'api'): Delta

  • 参数

    • "center": 设置为居中对齐。
    • "right": 设置为右对齐。
    • "justify": 取消为两端对齐。
    • false: 取消对齐，恢复为默认的左对齐。

  • 返回

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

# 行距 line-height

  • 功能

设置或取消行距。

  • 定义
format(
  key: 'line-height',
  value: LineHeightValue,
  source: Source = 'api'
): Delta

  • 参数

    • $value: 设置为指定的行距。
    • false: 取消行距，恢复默认。

  • 返回

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

← 嵌入对象 →