Dashboards APIs
Data Model
Tag Name | Type | Optional | Description |
---|---|---|---|
finDashboard | Marker | Â | Marker tag to appear in list of dashboards |
dashboardOn | Str | Â | Relative |
content | Dict<Widget> | Â | Top level Widget for the dashboard |
Widget
Tag Name | Type | Optional | Description |
---|---|---|---|
type | Str | Â | type of widget which is used in inheritance |
title | Str | ✓ | header to use for widget |
Types
Grid Layout
Tag Name | Type | Optional | Description |
---|---|---|---|
type | Str | Â | finDashboardExt::GridLayout |
children * | List Dict<Widget> | Â | list of children a widget that is laid out by this grid |
layout *
| List Dict
| Â | Must be same length as children layout for equivalent item in children |
rowHeight | Number | ✓ | Will have default if not defined |
cols
| Dict
| ✓ | default cols: {lg: 12, md: 10, sm: 6, xs: 4, xxs: 2}, |
History Chart
Tag Name | Type | Optional | Description |
---|---|---|---|
type | Str | Â | finDashboardExt::HistoryChart |
title | Str | ✓ | header to use for widget |
widget | Str | Â | ex. lineHis, barHis |
chartOptions
| Dict
| Â
| Â |
data
| Dict
| Â
|
|
date
| Dict
| ✓ | default tags to use for the data returned
|
Value Chart
Tag Name | Type | Optional | Description |
---|---|---|---|
type | Str | Â | finDashboardExt::ValueChart |
title | Str | ✓ | header to use for widget |
widget | Str | Â | ex. barVal |
chartOptions
| Dict
| Â
| Â |
data
| Dict
|
| Â |
Value Gauge
Tag Name | Type | Optional | Description |
---|---|---|---|
type | Str | Â | finDashboardExt::ValueGauge |
widget | Str | Â | ex. bar1 |
title | Str | ✓ | header to use for widget |
data
| Dict
|
| Â |
Value
Tag Name | Type | Optional | Description |
---|---|---|---|
type | Str | Â | finDashboardExt::Value |
title | Str | ✓ | header to use for widget |
data
| Dict
|
| Â |
Graphic
Tag Name | Type | Optional | Description |
---|---|---|---|
type | Str | Â | finDashboardExt::Graphic |
title | Str | ✓ | header to use for widget |
data
| Dict
|
| Â |
proto
| Dict
| Â | Â |
Weather
Tag Name | Type | Optional | Description |
---|---|---|---|
type | Str | Â | finDashboardExt::Weather |
title | Str | ✓ | header to use for widget |
widget | Str | Â | ex. weatherSmall |
data
|
|
| Â |
Map
Tag Name | Type | Optional | Description |
---|---|---|---|
type | Str | Â | finDashboardExt::Map |
title | Str | ✓ | header to use for widget |
widget | Str | Â | light, dark, ect |
data
| Dict
| Â | Â |
Table
Tag Name | Type | Optional | Description |
---|---|---|---|
type | Str | Â | finDashboardExt::Table |
title | Str | ✓ | header to use for widget |
data
| Dict
| Â | Â |
Table Data Type Rendering
To adjust the pagination for the table add pageLimit to the meta (ex. .addMeta({pageLimit: 25})
)
Type | render | colMeta | colMeta - kind | default |
---|---|---|---|---|
Str | if length > 50 show rest as popover | maxLength: 50 | Â | Â |
Bool | Â | trueText: "On" | trueText: Str | trueText: True |
Marker | display as tag with checkmark | color: "pink" | Str | #4e94b5 |
DateTime | use moment.js to format | format: "MM-YY HH" | Str | ddd MMM DD YYYY HH:mm:ss |
Date | use moment.js to format | format: "MM Do" | Str | ddd MMM DD YYYY |
Time | use moment.js to format | format: "HH:mm A" | Str | HH:mm:ss |
Uri | render as string if https:// -> link | button: "Click Me" | button: "Click Me" | Â |