Skip to main content

system.kanoa.dashboard.addWidget

This function is part of the kanoaCore module

Description

Creates a new widget

Syntax

addWidget(widgetInfo, userId)
  • Parameters
      widgetInfo (dict)
      - widgetName (string): The name of the widget
      - widgetDescription (string): Some information about the widget
      - viewPath (string): path to the widget view created in the designer
      - viewParams (string): the view paramters for this widget
      - sortOrder (int)
      - enabled (bool)
      - widgetCategoryName (string) Name of the widget category to store this widget under
      userId (int)
  • Returns
      widgetId (int)
      msg (string): error message, None if successful

    • Code Examples​

    # Example usage
    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')