For the complete documentation index, see llms.txt. This page is also available as Markdown.

Tag Cloud

Display frequent search terms from Logfile Analysis.

Documentation

Availability

The Tag Cloud is discontinued and unavailable in FactFinder NG.

Display the most searched words in a tag cloud

Use ff-tag-cloud to display the most searched words in your shop. Logfile Analysis supplies the terms using Tracking API data. By default, this module updates daily. Integrate the Tracking API to use the Tag Cloud.

Omikron can configure the maximum number of returned terms. It defaults to 70. Fewer terms are returned when fewer search terms exist.

Tag Cloud commonly appears on a not-found page. Combine it with Campaign Manager pushed products to provide useful alternatives.

Basic usage:

<ff-tag-cloud min-font-size="10" max-font-size="40" word-count="50" unit="px"></ff-tag-cloud>

Changing word-count triggers a FactFinder request and DOM update when disable-auto is not set. It is the only property whose changes trigger a request.

Selecting a tag triggers a FactFinder search by default. Handle entry-clicked and set ffPreventDefault to override this behavior.

<ff-tag-cloud id="tc" min-font-size="10" max-font-size="40" word-count="60" unit="px"></ff-tag-cloud>

<script>
    document.querySelector('#tc').addEventListener('entry-clicked', function (e) {
        event.detail.element.ffPreventDefault = true;
        window.open("index.html?" + factfinder.common.getParameterString(event.detail.entry.params), "_blank");
    });
</script>

Demo

API code

Properties

Properties
Name
Description

min-font-size (Number) (default: 10)

Specifies the font-size for the least searched word.

max-font-size (Number) (default: 20)

Specifies the font-size for the most searched word.

unit (String)(default: "px")

Specifies the unit of the font-size.

gradient-color-start (String) (default: "#294884")

Specifies the start color for the gradient of the searched words.

gradient-color-end (String) (default: "#20b6e8")

Specifies the end color for the gradient of the searched words.

word-count (Number) (default: 30)

Specifies the number of searched words to display.

disable-auto (Boolean) (default: false)

Specifies whether the tag cloud entries should be automatically fetched on connectedCallback or not.

Events

Events
Name
Description

entry-clicked

Fired when a tag cloud entry is clicked and before the search for that entry is triggered. The event contains a reference to this element where you can set the property ffPreventDefault to skip its default action: Search for the clicked word. The event also contains an object with all the tag cloud entry information: 1. query: The searched word. 2. count: The number of searches for that word. 3. params: The search parameters to execute a FactFinder search for that word.

before-search

Fired directly before the search for the tag cloud entry is executed.

dom-updated

Fired every time the tag cloud element is re rendered.

Methods

Methods
Name
Description

getTagCloud()

Manually obtains the tag cloud entries from FactFinder. Useful when disable-auto is set and one wants to display the entries on a certain action.

Last updated

Was this helpful?