0.5.0-rc1 • Published 6 years ago
@argus-dashboard/components v0.5.0-rc1
Argus
Argus is a Grid based Dashboard Framework.
Installation
npm install @argus-dashboard/components
You will also need the express app with Socket.io communication features:
npm install @argus-dashboard/server
Configuration
A file with the Dashboard configuration is needed:
const config = [
{
title: "My Dashboard",
rows: 3,
columns: 3,
widgets: [
{
extension: 'my-extension',
name: 'MyWidget',
title: 'Widget Title',
x: 0,
y: 0,
rows: 1,
columns: 1,
interval: 0
}
]
}
];
export default config;
Config File - Dashboard
Parameter | Description | Type |
---|---|---|
Title | Dashboard title shown in the header | String (must be unique) |
Rows/Columns | Dashboard size | Integer |
Widgets | Shown Widgets | Array |
Config File - Widgets
Parameter | Description | Type |
---|---|---|
Extension | Name of the extension the widget belongs to | String (must be unique) |
Name | Widget name | String |
Title | Title shown in the widget header | String |
X/Y | Widget position | Integer |
Rows/Columns | Widget size | Integer |
Interval | Interval in which the widget will be notified of new data | Integer. Can also be 'once' |