obsidian官方api合集

文档API合集-API说明-功能说明 内置-官方-封装-自带-内部-包装 目录-入口-由此开始-大纲-总览-概括-枢纽-指导-指引-总领

1. 在obsidian可用的第三方api:

child::BOM API

1. 说明:

因为Obsidian是通过Electron应用框架构建的, 所以可以调用大量的Node.js的API, 同时Node.js也实现了大部分Web端的API

会使用的api:

1. 添加命令

child::添加命令

2. editor对象:

child::editor

3. child::替换选中内容

4. child::获得EditorPosition对象

5. html转markdown:

6. 通过EditorPosition对象获得行数和光标位置

3. EditorPosition的line属性为行数
4. EditorPosition的ch属性为光标在该行的位置

7. 获得指定行的字符串

1. editor.getLine(行数)可以得到对应行数的字符串

8. child::覆盖指定行的字符串

9. 获取区域内容

1. getRange(开头EditorPosition,末尾EditorPosition)

10. child::覆盖区域内容

11. 获取当前面板文件的所有文本:

markdownview对象中的getViewData()

12. 获取出链:

13. child::执行命令

14. 获取入链/反链:

1. app.metadataCache.getBacklinksForFile(file)可以获取入链
2. 反链对象.data的键名就是入链文件的路径

15. 根据路径获取文件:

1. app.metadataCache.getFirstLinkpathDest(path, path)可以根据path路径获取文件

16. 获取YAML信息:

1. cache中保存有frontmatter地起始位置
   1. 不过需要YAML中有键值对, 如果没有, 则cache中将不会保存有frontmatter键名

17. child::获取对应文件的cache

18. child::通过cache获取所有该文件所有标签

1. child::获取库中所有的标签
2. child::插入文本
3. child::打开文件

添加插件配置界面

child::添加插件配置界面

网络相关

• child::网络APi

1. obsidian不具备的/没有的方便的api

1. obsidian目前没有获取多行和设置多整行的api

获取markdownView对象

child::获取markdownView

1. 与其他包/库重叠的obsidian可用API:

1. setTimeout():

window.setTimeout()表示调用Web API中的 window这种兼容性更好, 更推荐使用

setTimeout()表示调用Node.js API中的 安卓使用会报错

不会使用的api:

1. getCache()需要传入路径, 但不知道传什么