插件配置文件

config.json 插件配置文件

app/plugins目录下有一个config.json文件，此文件存储了所有指标插件的配置信息，重点描述了路径等内容。

• 配置信息json对象的属性controls存储了指标插件的集合信息（其他属性也很容易通过名称识别出来具体作用）。

• 指标插件支持按不同类型进行分组，其中type描述了分组类型，与type同级的controls存储了此分组下的指标插件集合。

• 集合中指标对象的path属性描述了指标插件的相对存储路径（相对于app/plugins目录而言）。name属性（非必需）描述了插件名称。

controls属性结构：

"controls": [
    {
      "type": "通用控件",
      "controls": [
        {
          "name": "柱图控件",
          "path": "controls/echarts/ebar"
        },
        {
          "name": "饼图控件",
          "path": "controls/echarts/epie"
        }
      ]
    }
]

下面是一个完整的插件清单信息，仅供参考：

{
  "name": "配置文件",
  "version": "0.1.0",
  "description": "指标控件配置",
  "author": "FreezeSoul<freezesoul@gmail.com>",
  "controls": [
    {
      "type": "通用控件",
      "controls": [
        {
          "name": "ebar",
          "path": "controls/echarts/ebar"
        },
        {
          "name": "epie",
          "path": "controls/echarts/epie"
        }
      ]
    },
    {
      "type": "演示控件",
      "controls": [
        {
          "name": "webgl-globe",
          "path": "demo/webgl-globe"
        },
        {
          "name": "echart3-treemap",
          "path": "demo/echart3-treemap"
        },
        {
          "name": "property-demo",
          "path": "project/property-demo"
        }
      ]
    },
    {
      "type": "项目控件",
      "controls": [
        {
          "name": "test",
          "path": "project/test"
        }
      ]
    }
  ]
}

manifest.json 插件清单文件

指标插件目录下的manifest.json文件作为插件的自描述文件，描述了插件运行所需的信息。

• uid：描述了插件的唯一id信息，要求在整个插件集合中唯一，在插件提交后不建议修改，这将影响已配置的插件。
• name：插件的中文显示名称。
• icon：插件的图标文件路径。
• author：插件的开发者。
• version：插件的版本编号。
• description：插件的描述信息。
• bootstrap：插件的启动入口javascript文件。
• editorJs：插件的自定义编辑器javascript文件（自定义特殊属性编辑功能，基本属性可通过配置完成）。---非必需，新版本可移除
• editorTpl：插件的自定义编辑器html模板文件（配合editorJs使用，如无属性可为空）。---非必需，新版本可移除
• editorCss：插件自定义编辑器css样式文件（配合editorJs使用，如无属性可为空）。---非必需，新版本可移除

ebar的插件清单信息：

{
  "uid": "ebar",
  "name": "柱状/折线/面积图",
  "icon": "images/icon.png",
  "author": "FreezeSoul<freezesoul@gmail.com>",
  "version": "0.1.0",
  "description": "柱状、折线、面积、散点图四合一",
  "bootstrap": "ebar.js",
  "editorJs":"editor/editor.js",（非必须）
  "editorTpl":"editor/editor.tpl.html",（非必须）
  "editorCss":"editor/editor.css"（非必须）
}