|
1 |
| -# cumulocity-device-chart-widget-plugin |
| 1 | +# Cumulocity Device Chart Widget Plugin [<img width="35" src="https://user-images.githubusercontent.com/67993842/97668428-f360cc80-1aa7-11eb-8801-da578bda4334.png"/>](https://github.com/SoftwareAG/cumulocity-device-chart-widget-plugin/releases/download/1.0.0-beta/cumulocity-device-chart-widget-plugin-1.0.0-beta.zip) |
| 2 | + |
| 3 | +This Device Chart Widget is the Cumulocity module federation plugin created using c8ycli. This plugin can be used in Application Builder or Cockpit. It displays the chart based on the device-specific inventory data. |
| 4 | +By Default the chart displays the count based on the input in the group by field of configuration. But if the input is provided in the value field of the widget configuration it gives the value sum of the provided field from device managed object. |
| 5 | + |
| 6 | +The widget also comes with an inbuilt color picker, which helps one to customize chart/border colors. The charts available include |
| 7 | + |
| 8 | +Vertical Bar Chart |
| 9 | + |
| 10 | +Horizontal Bar Chart |
| 11 | + |
| 12 | +Donut Chart |
| 13 | + |
| 14 | +Pie Chart |
| 15 | + |
| 16 | +Radar Chart |
| 17 | + |
| 18 | +Polar Chart |
| 19 | + |
| 20 | +Scatter Chart (Data set not ideal for this chart) |
| 21 | + |
| 22 | +Bubble Chart (Data set not ideal for this chart) |
| 23 | + |
| 24 | +### Please note that this plugin is in currently under BETA mode. |
| 25 | + |
| 26 | +### Please choose Device Chart Widget release based on Cumulocity/Application builder version: |
| 27 | + |
| 28 | +|APPLICATION BUILDER | CUMULOCITY | DEVICE CHART WIDGET PLUGIN | |
| 29 | +|--------------------|------------|-----------------------------| |
| 30 | +| 1.4.x(coming soon) | >= 1015.x.x| 1.x.x | |
| 31 | + |
| 32 | + |
| 33 | +## Prerequisites: |
| 34 | + Cumulocity c8ycli >=1014.x.x |
| 35 | + |
| 36 | +## Installation |
| 37 | + |
| 38 | + |
| 39 | +### Runtime Deployment? |
| 40 | + |
| 41 | +* This widget support runtime deployment. Download [Runtime Binary](https://github.com/SoftwareAG/cumulocity-device-chart-widget-plugin/releases/download/1.0.0-beta/cumulocity-device-chart-widget-plugin-1.0.0-beta.zip) and install via Administrations(Beta mode) --> Ecosystems --> Applications --> Packages |
| 42 | + |
| 43 | +### Local Development? |
| 44 | + |
| 45 | +**Requirements:** |
| 46 | +* Git |
| 47 | +* NodeJS (release builds are currently built with `v14.18.0`) |
| 48 | +* NPM (Included with NodeJS) |
| 49 | + |
| 50 | +**Instructions** |
| 51 | +1. Clone the repository: |
| 52 | +``` |
| 53 | +git clone https://github.com/SoftwareAG/cumulocity-device-chart-widget-plugin.git |
| 54 | +``` |
| 55 | +2. Change directory: |
| 56 | +``` |
| 57 | +cd cumulocity-device-chart-widget-plugin |
| 58 | +``` |
| 59 | +3. Install the dependencies: |
| 60 | +``` |
| 61 | +npm install |
| 62 | +``` |
| 63 | +4. (Optional) Local development server: |
| 64 | +``` |
| 65 | +npm start -- --shell cockpit |
| 66 | +``` |
| 67 | +5. Build the app: |
| 68 | +``` |
| 69 | +npm run build |
| 70 | +``` |
| 71 | +6. Deploy the app: |
| 72 | +``` |
| 73 | +npm run deploy |
| 74 | +``` |
| 75 | + |
| 76 | + |
| 77 | +------------------------------ |
| 78 | + |
| 79 | +These tools are provided as-is and without warranty or support. They do not constitute part of the Software AG product suite. Users are free to use, fork and modify them, subject to the license agreement. While Software AG welcomes contributions, we cannot guarantee to include every contribution in the master project. |
| 80 | +_____________________ |
| 81 | +For more information you can Ask a Question in the [TECH Community Forums](https://tech.forums.softwareag.com/tag/Cumulocity-IoT). |
0 commit comments