Document toolboxDocument toolbox

Event: kyvos.viewer.db.onCardAdd

Applies to: Kyvos Enterprise  Kyvos Cloud (SaaS on AWS) Kyvos AWS Marketplace

Kyvos Azure Marketplace   Kyvos GCP Marketplace Kyvos Single Node Installation (Kyvos SNI)


This event is triggered when any card is added.

Interface

{ "msgId": "", "msgName": "kyvos.viewer.db.onCardAdd", "integrationId": "", "payload": { "info": { "status": "success", "desc": "" }, "data": { "wbId": "", "wbName": "", "dbId": "", "dbName": "", "cardsInfo": [ { "cardId": "", "cardTitle": "", "cardType:" "" } ]}}}

Here:

  • wbId = workbook identifier

  • wbName = workbook name

  • dbId = dashboard identifier

  • dbName = dashboard name

  • cardId = card identifier

  • cardTitle = card name

  • cardType = card type. Possible values are DATA_CARD, HTML_CARD, URL_CARD, GROUP_CARD, and FILTER_CARD.

Points to consider

  1. User can select multiple cards from addDataCard dialog, but this event will be triggered only when the dialog is closed and all selected data cards will be added.

  2. This event will be triggered immediately when card has been added in the dashboard (even though its content has not been loaded yet especially in case of data card).

  3. This event will be triggered when any card gets duplicated.

  4. This event will be triggered on copyTo option as well in group card.

Copyright Kyvos, Inc. All rights reserved.