CollectionTemplateManager

用于管理 CollectionTemplate,其被 DataSourceManager 管理。

实例方法

addCollectionTemplates(templates)

用于添加 collection template。

  • 类型
1class CollectionTemplateManager {
2  addCollectionTemplates(templates: CollectionTemplate[]): void;
3}
  • 示例
1class SqlCollectionTemplate extends CollectionTemplate {
2  name = 'sql';
3  type = 'object';
4  title = '{{t("SQL collection")}}';
5  configurableProperties = {
6    // ...
7  }
8}
9
10class TreeCollectionTemplate extends CollectionTemplate {
11  name = 'tree';
12  type = 'object';
13  title = '{{t("Tree collection")}}';
14  configurableProperties = {
15    // ...
16  }
17}
18
19class MyPlugin extends Plugin {
20  async load() {
21    this.dataSourceManager.collectionTemplateManager.addCollectionTemplates([ SqlCollectionTemplate, TreeCollectionTemplate ]);
22
23    // or
24    this.dataSourceManager.addCollectionTemplates([ SqlCollectionTemplate, TreeCollectionTemplate ]);
25  }
26}

getCollectionTemplate(name)

用于获取 collection template。

  • 类型
1class CollectionTemplateManager {
2  getCollectionTemplate(name: string): CollectionTemplate;
3}
  • 示例
1collectionManager.getCollectionTemplate(); // generalCollectionTemplate
2
3collectionManager.getCollectionTemplate('tree'); // treeCollectionTemplate

getCollectionTemplates()

用于获取所有 collection templates。

  • 类型
1class CollectionTemplateManager {
2  getCollectionTemplates(): CollectionTemplate[];
3}
  • 示例
1collectionManager.getCollectionTemplates(); // [ generalCollectionTemplate, treeCollectionTemplate, sqlCollectionTemplate ]