Skip to main content

system.kanoa.dashboard.getDashboardInfo

This function is part of the kanoaCore module

Description

Gets dashboard info including breakpoints and widgets for a given dashboardId

Syntax

getDashboardInfo(dashboardId)
  • Parameters
      dashboardId (int)
  • Returns
      dashboardInfo (dict)
  • Code Examples

    # Example usage
    dashboardId = 4
    dashboardInfo = system.kanoa.dashboard.getDashBoardInfo(dashboardId)
    print dasboardInfo
    > {u'Mobile': {
    'rowGap': 5,
    'columnCount': 5,
    'widgets': [],
    'enabled': True,
    'breakpointId': 3,
    'changedDate': None,
    'breakpointName': u'Mobile',
    'createdDate': Mon Jul 08 18:33:35 UTC 2024,
    'size': 590,
    'columnGap': 5,
    'createdBy': 39,
    'changedBy': None,
    'columnWidth': None,
    'rowCount': 30,
    'breakpointDescription': None,
    'rowHeight': 50},
    u'Desktop': {
    'rowGap': 5,
    'columnCount': 20,
    'widgets': [{
    'widgetName': u'Assets Overview',
    'widgetId': 38,
    'enabled': True,
    'dashboardName': u'Asset Overview',
    'viewPath': u'kanoa/mes/asset/overview/mainView',
    'breakpointId': 2,
    'columnEnd': 21,
    'changedDate': None,
    'breakpointName': u'Desktop',
    'widgetDescription': u'Provides a hierarchical view of all assets providing drill down capability',
    'createdDate': Sun Jul 21 14:50:50 UTC 2024,
    'size': None,
    'dashboardId': 4,
    'createdBy': 5,
    'dashboardWidgetId': 26,
    'changedBy': None,
    'columnStart': 1,
    'rowStart': 1,
    'rowEnd': 21,
    'viewParams': u'{}'
    }],
    'enabled': True,
    'breakpointId': 2,
    'changedDate': None,
    'breakpointName': u'Desktop',
    'createdDate': Mon Jul 08 18:33:35 UTC 2024,
    'size': None,
    'columnGap': 5,
    'createdBy': 39,
    'changedBy': None,
    'columnWidth': None,
    'rowCount': 20,
    'breakpointDescription': None,
    'rowHeight': None
    },
    u'Tablet': {
    'rowGap': 5,
    'columnCount': 10,
    'widgets': [],
    'enabled': True,
    'breakpointId': 1,
    'changedDate': None,
    'breakpointName': u'Tablet',
    'createdDate': Mon Jul 08 18:33:35 UTC 2024,
    'size': 960,
    'columnGap': 5,
    'createdBy': 39,
    'changedBy': None,
    'columnWidth': None,
    'rowCount': 25,
    'breakpointDescription': None,
    'rowHeight': 50
    },
    'dashboard': {
    'private': False,
    'roles': None,
    'showOnMobile': False,
    'folderId': 8,
    'enabled': True,
    'dashboardName': u'Asset Overview',
    'folderPath': u'System Dashboards',
    'path': u'System Dashboards\\Asset Overview',
    'changedDate': Sun Jul 21 14:51:06 UTC 2024,
    'createdDate': Sun Jul 21 14:50:39 UTC 2024,
    'dashboardId': 4,
    'createdBy': 5,
    'changedBy': 5,
    'sortOrder': None,
    'iconColor': u'#00D9D9',
    'dashboardDescription': u'Provides an enterprise overview of assets for a user with drill down capability. Primarily used for landing page.',
    'iconPath': u'kanoa/enterprise'
    }
    }
    >>