tinymce.EditorOptions

TinyMCE 编辑器 Options API。Options API 提供注册、查找和设置编辑器选项的功能。

所有选项都需先注册才能在编辑器中使用。这是通过使用 register() API 实现的，该 API 需要一个名称和一个选项规范。规范应包含一个 processor 和一个可选的 default 值。processor 用于解析和验证通过初始配置或 set() API 传入的选项值。

processor 可以是一个返回选项值是否有效的自定义函数，或者是以下内置 processor 之一：

• string

• number

• boolean

• array

• function

• object

• string[]

• object[]

• regexp

示例

// 注册一个选项
editor.options.register('custom_option', {
  processor: 'string',
  default: 'myoption'
});

// 查找一个选项
editor.options.get('custom_option');

// 设置一个选项
editor.options.set('custom_option', 'value');

摘要

方法

方法

debug()

debug()

将初始原始编辑器选项记录到控制台。

get()

get(name: String): Object

获取已注册选项的值。

参数

• name (String) - 已注册选项的名称。

返回值

• Object - 选项值，未设置时为注册的默认值，未注册时为 undefined。

isRegistered()

isRegistered(name: String): Boolean

检查选项是否已注册。

参数

• name (String) - 选项的名称。

返回值

• Boolean - 选项已注册则为 true，否则为 false。

isSet()

isSet(name: String): Boolean

检查指定选项是否已设置值。

参数

• name (String) - 选项的名称。

返回值

• Boolean - 选项已设置值则为 true，否则为 false。

register()

register(name: String, spec: OptionSpec)

注册一个可在 TinyMCE 中使用的新选项。

参数

• name (String) - 选项的名称。

• spec (OptionSpec) - 描述如何验证选项及其他可选元数据的选项规范。

set()

set(name: String): Boolean

为已注册选项设置值。

参数

• name (String) - 已注册选项的名称。

返回值

• Boolean - 选项值设置成功则为 true，否则为 false。

unset()

unset(name: String): Boolean

清除指定选项的已设值并恢复为默认值。

参数

• name (String) - 已注册选项的名称。

返回值

• Boolean - 选项值重置成功则为 true，否则为 false。