The folder structure of a generated gadget is explained as follows using an example:
└── RT
├── conf.json
├── gadget-controller.jag
├── gadget.json
├── thumbnail.png
├── gadget.xml
├── css
│ └── line-chart.css
s
├── js
│ ├── line-chart.js
│ ├── core
│ │ ├── gadget-core.js
│ │ ├── line-chart-api.js
│ │ └──
rdbms-provider-api.js
│ │ └── provider-client.js
│ └── provider-libs
│ └── ws-client.js
└── libs
└── vizGrammar-1.0.0
├── d3.min.js
├── test.css
Folder structure | Description |
---|---|
| Name of the chart template |
├── conf.json | This contains the user input for the provider configuration and chart configuration. |
├── gadget-controller.jag | This contains the channel to link the backend and the front-end of the gadget. |
├── gadget.json | This contains gadget meta information. |
├── thumbnail.png | This is the gadget thumbnail file. |
├── gadget.xml | This is the gadget XML file that defines the gadget. |
├── css | |
│ └── line-chart.css | This refers to chart template that the author writes in CSS format. The author may opt to write CSS or JS files based on their requirement. |
├── js | |
│ ├── line-chart.js | This refers to chart template that the author may write in JS format. The author may opt to write CSS or JS files based on their requirement. |
│ ├── core | |
│ │ ├── gadget-core.js | This file handles the front-end rendering of the gadget. |
│ │ ├── line-chart-api.js | This refers to the api.js file that corresponds to the chart template, which is prefixed by the name of the chart (e.g., line-chart ). |
│ │ ├── rdbms-provider-api.js | This refers to the api.js file that corresponds to the provider, which is prefixed by the provider (e.g., rdbms ). |
│ │ └── provider-client.js | In WSO2 Dashboard Server, the client.js file is automatically renamed to provider-client.js . |
│ └── provider-libs | These are libraries for client-side provider functionality. |
│ └── ws-client.js | |
└── libs | |
│ └── vizGrammar-1.0.0 | Chart specific third-party libraries. |
│ ├── d3.min.js | |
│ ├── test.css |