KindEditor-KindEditor API 文档

KindEditorAPI 文档

 

一、变量

1. KE.scriptPath
   kindeditor.js的路径。
   数据类型：String
   
2. KE.browser
   浏览器类型和版本，分别为KE.browser.VERSION、KE.browser.IE、KE.browser.WEBKIT、KE.browser.GECKO、KE.browser.OPERA。
   数据类型：Object
   注：3.4以前版本直接返回字符串，分别为"IE"、"WEBKIT"、"GECKO"、"OPERA"。
   
3. KE.g[id].iframeDoc
   编辑区域的iframe对象。
   数据类型：Element
   
4. KE.g[id].keSel
   当前选中信息的KE.selection对象，id为编辑器ID。
   数据类型：Object
   
5. KE.g[id].keRange
   当前选中信息的KE.range对象，id为编辑器ID。
   数据类型：Object
   
6. KE.g[id].sel
   当前选中信息的浏览器原生selection对象，id为编辑器ID。
   数据类型：Object
   
7. KE.g[id].range
   当前选中信息的浏览器原生range对象，id为编辑器ID。
   数据类型：Object
   

 

二、函数

1. KE.show(config)
   初始化并创建编辑器。执行本函数时先调用KE.init设置初始化参数，然后在DOM加载完成后执行KE.create。
   参数：
   config：Object，编辑器属性集合，具体请参考编辑器配置参数属性
   返回值：无
   
2. KE.init(config)
   设置编辑器的初始化参数，loadStyleMode为true时自动加载CSS文件。
   参数：
   config：Object，编辑器属性集合，具体请参考编辑器配置参数属性
   返回值：无
   
3. KE.create(id, mode)
   创建编辑器。
   参数：
   id：String，编辑器的ID
   mode：Int，可选参数，指定1时在body下面创建编辑器，0或未指定时在TEXTAREA前面创建编辑器。
   返回值：无
   
4. KE.remove(id, mode)
   移除编辑器。
   参数：
   id：String，编辑器的ID
   mode：Int，可选参数，指定1时移除在body下面的编辑器，0或未指定时移除在TEXTAREA前面的编辑器。
   返回值：无
   
5. KE.html(id)
   取得编辑器的HTML内容。
   参数：
   id：String，编辑器的ID
   返回值：
   String，HTML字符串
   注: 3.5版本开始支持，旧版本可以使用KE.util.getData(id)。
   
6. KE.html(id, val)
   设置编辑器的HTML内容。
   参数：
   id：String，编辑器的ID
   val: String，HTML字符串
   返回值：无
   注: 3.5版本开始支持，旧版本可以使用KE.util.setFullHtml(id, val)。
   
7. KE.text(id)
   取得编辑器的纯文本内容。
   参数：
   id：String，编辑器的ID
   返回值：
   String，去除HTML代码后的文本
   注: 3.5版本开始支持。
   
8. KE.text(id, val)
   设置编辑器的内容，直接显示HTML代码。
   参数：
   id：String，编辑器的ID
   val: String，文本
   返回值：无
   注: 3.5版本开始支持。
   
9. KE.selectedHtml(id)
   取得当前被选中的HTML内容。
   参数：
   id：String，编辑器的ID
   返回值：
   String，HTML字符串
   注: 3.5版本开始支持。
   
10. KE.count(id, mode)
    取得编辑器内容的文字数量。
    参数：
    id：String，编辑器的ID
    mode：String，可选参数，默认值也"html"，mode为"html"时取得字数包含HTML代码，mode为"text"时只包含纯文本、IMG、EMBED。
    返回值：
    Int，文字数量
    注: 3.5版本开始支持。
    
11. KE.isEmpty(id)
    判断编辑器是否有可见内容，比如文本、图片、视频。
    参数：
    id：String，编辑器的ID
    返回值：Boolean
    注: 3.5版本开始支持，旧版本可以使用KE.util.isEmpty(id)。
    
12. KE.insertHtml(id, val)
    将指定的HTML内容插入到编辑区域里的光标处。
    参数：
    id：String，编辑器的ID
    val: String，HTML字符串
    返回值：无
    注: 3.5版本开始支持，旧版本可以使用KE.util.insertHtml(id, val)。
    
13. KE.appendHtml(id, val)
    将指定的HTML内容添加到编辑区域最后位置。
    参数：
    id：String，编辑器的ID
    val: String，HTML字符串
    返回值：无
    注: 3.5版本开始支持。
    
14. KE.util.setData(id)
    把编辑器的内容设置到原TEXTAREA控件里。
    参数：
    id：String，编辑器的ID
    返回值：无