Cherry API
setMarkdown(content:string, keepCursor = false)
设置内容，setValue(content:string, keepCursor = false)有同样的功能
keepCursor = true 更新内容的时候保持光标位置
insert(content:string, isSelect = false, anchor = false, focus = true)
插入内容
isSelect=true 选中刚插入的内容
anchor=false 在光标处插入内容，anchor=[1,3] 在第2行第4个字符处插入内容
getMarkdown()
获取markdown内容
resetToolbar(type:string, toolbar:array)
重置工具栏
type 修改工具栏的类型 {'toolbar'|'toolbarRight'|'sidebar'|'bubble'|'float'|'toc'}
toolbar 工具栏配置
export(type:string)
导出预览区域的内容，type：{'pdf'|'img'}
switchModel(model:string)
切换模式：{'edit&preview'|'editOnly'|'previewOnly'}
getCodeMirror()
获取左侧编辑器实例
getPreviewer()
获取右侧预览区对象实例
Previewer.scrollToId(id:string, behavior:{'smooth'|'instant'|'auto'})
滚动到对应id的元素位置
id 可以为带#号hash，也可以是id值
behavior: smooth(默认) 平滑滚动；instant 立即滚动；auto 跟随浏览器默认行为
Previewer.scrollToTop(scrollTop:number, behavior:{'auto'|'smooth'|'instant'})
滚动到对应位置
scrollTop 滚动距离
behavior: auto(默认) 跟随浏览器默认行为；smooth 平滑滚动；instant 立即滚动
setLocale(locale:string)
修改语言
系统默认支持：zh_CN | en_US | ru_RU
setTheme(theme:string)
修改主题
setCodeBlockTheme(theme:string)
修改代码块主题
toggleToc(focusModel:{'full'|'pure'|''})
修改右侧悬浮目录的状态
refreshPreviewer()
强制重新渲染预览区域
clearFlowSessionCursor()
清空流程会话中添加的虚拟光标
Cherry.engine API
engine.makeHtml(markdown:string)
将markdown字符串渲染成Html
engine.makeMarkdown(html:string)
将html字符串渲染成markdown
Cherry.toolbar.toolbarHandlers API
注：要调用 toolbarHandlers 的API，需要先在cherry.config.toolbars的“toolbar|toolbarRight|sidebar|bubble|float”中的其中一项里配置上对应的工具栏
toolbar.toolbarHandlers.bold()
向cherry编辑器中插入加粗语法
toolbar.toolbarHandlers.italic()
向cherry编辑器中插入斜体语法
toolbar.toolbarHandlers.strikethrough()
向cherry编辑器中插入删除线语法
toolbar.toolbarHandlers.size(fontSize: int)
向cherry编辑器中插入字体大小语法
toolbar.toolbarHandlers.color(param:string)
向cherry编辑器中插入字体颜色或字体背景色语法
| param |
效果 |
| 'color: #c2255c' |
字体颜色 |
| 'background-color: #c2255c' |
字体背景颜色 |
toolbar.toolbarHandlers.header(level:int)
向cherry编辑器中插入标题语法
toolbar.toolbarHandlers.quote()
向cherry编辑器中插入引用语法
toolbar.toolbarHandlers.panel(param:string)
向cherry编辑器中插入对齐方式或信息面板语法
| param |
效果 |
| 'left' |
左对齐 |
| 'center' |
居中对齐 |
| 'right' |
右对齐 |
| 'primary' |
首选项 |
| 'info' |
一般信息 |
| 'warning' |
警告 |
| 'danger' |
危险 |
| 'success' |
成功 |
toolbar.toolbarHandlers.list(type:string)
向cherry编辑器中插入有序、无序列表或者checklist语法
| level |
效果 |
| '1' |
ol 列表 |
| '2' |
ul 列表 |
| '3' |
checklist |
toolbar.toolbarHandlers.insert(type:string)
向cherry编辑器中插入特定语法：
| type |
效果 |
| 'hr' |
删除线 |
| 'br' |
强制换行 |
| 'code' |
代码块 |
| 'formula' |
行内公式 |
| 'checklist' |
检查项 |
| 'toc' |
目录 |
| 'link' |
超链接 |
| 'normal-table' |
插入3行5列的表格 |
| 'normal-table-row*col' |
如normal-table-2*4插入2行(包含表头是3行)4列的表格 |
toolbar.toolbarHandlers.image()
向cherry编辑器中插入图片文件
toolbar.toolbarHandlers.video()
向cherry编辑器中插入视频文件
toolbar.toolbarHandlers.audio()
向cherry编辑器中插入音频文件
toolbar.toolbarHandlers.pdf()
向cherry编辑器中插入PDF文件
toolbar.toolbarHandlers.word()
向cherry编辑器中插入Word文件
toolbar.toolbarHandlers.graph(type:string)
向cherry编辑器中插入画图语法
| id |
效果 |
| '1' |
流程图 |
| '2' |
时序图 |
| '3' |
状态图 |
| '4' |
类图 |
| '5' |
饼图 |
| '6' |
甘特图 |