Skip to main content

system.kanoa.dashboard.addWidget(widgetInfo, userId)

Create a new widget.


Parameters

widgetInfo Dictionary

- enabledbit
- sortOrderIntegerThe sort order
- viewParamsStringview parameters
- viewPathStringThe path to the view
- widgetCategoryNameStringThe category
- widgetDescriptionStringThe description of the widget
- widgetNameStringThe name of the widget

userId Integer: The user who created the widget


Returns

widgetId Integer
message String None if success


Example

userId = 123
widgetInfo = {
"widgetName": "Asset Downtime Bar Chart",
"widgetDescription": "Display Downtime By Asset",
"enabled": True,
"sortOrder": None,
"viewParams": "{"assetPath": None, "downtimeBy": "Interval", "showDowntimeBySelector": True}",
"viewPath": "kanoa/core/dbp/widgets/analytics/assetDowntimeBarChart",
"widgetCategoryName": 'Analysis'
}
widgetId, msg = system.kanoa.dashboard.addWidget(widgetInfo, userId)
if msg: system.perspective.sendMessage('showFailerToast', msg)
else: system.perspective.sendMessage('showSuccessfulToast', 'Widget parameter has been saved')