UI Events

The SmartHub UI triggers regular DOM events.

  • You can attach handlers to these events just as you would with “standard” events.

    • For example: keyboard input, click, etc.

Event Name Description Example
afterInitialization This is triggered right after the UI is fully initialized.

afterInitialization Triggered right after the UI is fully initialized. $(SH.utils.getSearchRoot()).addEventListener("afterInitialization", functionName());

buildingQuery This is triggered when the query being build.

$(SH.utils.getSearchRoot()).addEventListener("buildingQuery", functionName());

clearResults This is triggered when the search results are cleared.

SH.utils.getSearchRoot().addEventListener('clearResults', functionName());

ContentContainerQuerySuccess Triggered after the query success event has finished executing for the specific content container.

$(SH.utils.getSearchRoot()).addEventListener("ContentContainerQuerySuccess", functionName());

ContentContainerDeferredRendering

This event contains the information about the:

  • Container ID

  • Container settings

  • Results

and can be used to handle the result rendering via a custom function.

$(SH.utils.getSearchRoot()).addEventListener("ContentContainerDeferredRendering", functionName());

deferredQuerySuccess This is triggered after the main query success event has finished executing.

SH.utils.getSearchRoot().addEventListener('deferredQuerySuccess', functionName);

doneBuildingQuery This is this is triggered when the query is done being built.

SH.utils.getSearchRoot().addEventListener('doneBuildingQuery', functionName());

duringQuery This is triggered when the query is being executed.

SH.utils.getSearchRoot().addEventListener('duringQuery', functionName());

newQuery This is triggered when a new query is launched.

SH.utils.getSearchRoot().addEventListener('newQuery', functionName());

newResultDisplayed This is triggered each time the result list has just finished rendering a single result.

SH.utils.getSearchRoot().addEventListener('newResultDisplayed', functionName());

newResultsDisplayed This is triggered when the result list has just finished rendering the current page of results.

SH.utils.getSearchRoot().addEventListener('newResultsDisplayed', functionName());

SHPreInit This event is triggered right before each components inside the search interface get initialized.

SH.utils.getSearchRoot().addEventListener('SHPreInit', functionName());

tabularViewResultsDisplayed This is triggered when the result list has just finished rendering the current page of tabular view results.

SH.utils.getSearchRoot().addEventListener('tabularViewResultsDisplayed', functionName());