kyvos.viewer.db.openPropertiesDialog

Configuring the kyvos.viewer.db.openPropertiesDialog event

This JavaScript API requires that a valid dashboard be opened with design mode enabled.
This JS API will open the dashboard properties panel, which has many other options such as “Canvas Width”, “Default Canvas Layout in View Mode”, “Mobile Layout View”, “Theme”, “Margin configurations”, etc.
Each property can be hidden using Integration config properties options in the dashboard.
If the properties object is either not provided or is empty in the dashboard, all properties will be visible.

"dashboard":{
"properties":[{"name":"CANVAS_WIDTH"}, {"name":"DEFAULT_CANVAS_LAYOUT"}, 
{"name":"MOBILE_LAYOUT"}, {"name":"THEME_OPTIONS"}, {"name":"BACKGROUD_COLOR"}, 
{"name":"CHART_COLOR_PALETTE"}, {"name":"WIDGET_LOADER_STYLE"}, {"name":"MARGIN"}, {"name":"WIDGET_GAP"}, {"name":"WIDGET_SHADOW"}, {"name":"SHRINK_WIDGETS_IN_NO_DATA"}, 
{"name":"PAGE_BREAK_OPTIONS"}, {"name":"ADVANCE_CUSTOMIZATION_OPTIONS"}]

Note

Whenever a property is changed in the properties panel, it will trigger a JavaScript Event to the Host App, denoting that something has changed.

{
    "integrationId": "",
    "msgName": "kyvos.viewer.db.onPropertiesChange"
    "payload": {
      "info": {
        "status": "success",
        "desc": "dashboard property has been changed",
        "extDesc": "",
        "code": 0
      },
      "data": {
        "wbId": "",
        "wbName": "",
        "dbId": ""
      }
    }

kyvos.viewer.db.openPropertiesDialog

This event would request Kyvos to open the properties panel.

This API is only functional in Design Mode.

{
  "msgName": "kyvos.viewer.db.openPropertiesDialog",
  "payload": {}
}

Example

{
  "msgName": "kyvos.viewer.db.openPropertiesDialog",
  "payload": {}
}

kyvos.viewer.db.onPropertiesDialogOpen

This event would be emitted when properties dialog is opened.

{
  "integrationId": "",
  "msgName": "kyvos.viewer.db.onPropertiesDialogOpen",
  "payload": {
    "info": {
      "status": "",
      "desc": "",
      "extDesc": "",
      "code": 0
    },
    "data": {
      "wbId": "",
      "wbName": "",
      "dbId": ""
    }
  }
}
}

Example

{
  "integrationId": "",
  "msgId": "Guid_5001301387",
  "msgName": "kyvos.viewer.db.onPropertiesDialogOpen",
  "payload": {
    "info": {
      "status": "success",
      "desc": "Properties dialog opened successfully.",
      "extDesc": "",
      "code": 0
    },
    "data": {
      "wbId": "Workbook16970337840852127042060186172142",
      "wbName": "AmchartRight",
      "dbId": "Dashboard17001268556608127087021145772124"
    }
  }
}

kyvos.viewer.db.onPropertiesDialogClose

This event would be emitted when properties dialog is closed.

{
  "integrationId": "",
  "msgName": "kyvos.viewer.db.onPropertiesDialogClose",
  "payload": {
    "info": {
      "status": "success",
      "desc": "",
      "extDesc": "",
      "code": 0
    },
      "wbId": "",
      "wbName": "",
      "dbId": ""
    }
  }
}

Example

{
  "integrationId": "",
  "msgId": "17121267878378127022096170755154",
  "msgName": "kyvos.viewer.db.onPropertiesDialogClose",
  "payload": {
    "info": {
      "status": "success",
      "desc": "Properties dialog closed successfully.",
      "extDesc": "",
      "code": 0
    },
      "wbId": "Workbook16970337840852127042060186172142",
      "wbName": "AmchartRight",
      "dbId": "Dashboard17001268556608127087021145772124"
    }
  }
}