Related pages:
- Custom Visualizations Overview and Prerequisites
- Generating a Custom Visualization
- Generating a Custom Visualization ZIP File
There are five main files in a custom visualization.
|
File |
Description |
`src/config/wizardConfig.ts` |
Configuration wizard for the custom visualization which you can edit to design your own;
This is a Typescript file, which is similar to ECMAScript 6 (Javascript) syntax. If you have never used Typescript before, you can also write pure Javascript without using any Typescript specific syntax. |
`src/widget/widget.ts` |
The main entry for your custom visualization implementation. Our Yeoman template generator has some examples of how you can use different libraries here.
This is a Typescript file, which is similar to ECMAScript 6 (Javascript) syntax. If you have never used Typescript before, you can also write pure Javascript without using any Typescript specific syntax. |
`content/Manifest.json` |
Describes the contents of the extension to the EdgeCore server. Normally you would not edit this file unless you change your mind about some of the answers given during the template generation step or want to keep the creationDate or version updated. |
`content/static-web/[widgetName]/register.js` |
Registers your custom visualization and wizard to the EdgeCore web application. This is generated on your behalf during the template generation. Normally you would not edit this file. The most common reason why you would edit this file is to change the filename for your custom icon. |
`content/static-web/[widgetName]/widgetIcon.png` |
The icon for your visualization. You should replace the icon from the template with your own. The icon should be 96px by 96px in size.
Supported formats: PNG, JPG, SVG, and GIF; |