Component description

The cards property defines what the statistic type and the card’s visual aspect.

You can add up to four cards to the summaries component.

Minimal JSON

{
  "type":"""title":"",
  "api":""
}
{
  "componentId": "summary_total_dashboard_adoption",
  "type": "summaries",
  "cards": [
    {
      "type": "number",
      "title": "dashboard.title.number_of_users",
      "api": "https://help.dawiso.com/api/chart/statistics/core_statistic_chart_number_total_users/single",
      "description": "number_of_users_description",
      "varianceType": "percentage",
      "iconKey": "core_dashboard_adoption_icon_chart_users"
    }
  ]
}

Example taken from the core_dashboard_adoption package.

Nested properties

PropertyDescriptionValuesMandatory
typeCard type. Supported values are: number: Displays a statistic., application: Links to an application. E.g., the most visited one.stringYes
titleTranslation key of the title. Define the key in translations to specify how the text is displayed in the UI. Unlike the name property, if you use a specific string of text for the title, this text will appear with the package key. For example, Comment Section will be displayed as package_key_comment section.stringYes
apiRelative or absolute API path. For number card type: /api/chart/statistics/{enumKey}/singleEnum Key can be e.g., accessed_pagesFor application card type: /api/mr-application/most-visitedstringYes
iconKeyKey of the icon used to visually represent the asset. Use predefined icons from Settings > Configuration > Icons, or define custom ones in the icons asset.stringYes* for number card type
descriptionTranslation key of the component description. Add the key to translations for proper text display.stringNo
varianceTypeNumber type. Supported values are: absolute: Displays an absolute number., percentage: Displays a percentage.stringNo
filterConditions used to limit or refine data selection. For more information, see filter.jsonNo