Component description

The wordcloud component creates a graphic representation of the most used keywords on pages.

Example

Minimal JSON

{
  "type": "wordcloud",
  "title": "",
  "apiType": "",
  "description": "",
  "filter": {}
}
{
  "key": "wordcloud",
  "template": {
    "componentId": "wordcloud",
    "type": "wordcloud",
    "title": "dashboard.title.keywords",
    "apiType": "searchedTerms",
    "description": "wordcloud_description"
  }
}

Example taken from the core_dashboard_adoption package.

Nested properties

PropertyDescriptionValuesMandatory
typewordcloudstringYes
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
apiTypeUsed API for the wordcloud. Supported values are: searchedTerms: Displays most search keywords for the selected period. No filter is used in combination., visitedObjects: Displays most visited objects for the selected period. Used in combination with filter. Time range for the wordcloud is configured using a global time selector.stringYes
descriptionDescription of the component. Displayed in the component’s tooltip.stringYes
componentIdUnique ID of a component. If left empty, a random string will be generated. Primarily used in patch packages to define the component's position within the layout (template).stringNo
filterConditions used to limit or refine data selection. For more information, see filter.jsonNo