Home Page Metadata Section cueInterface Properties

A cueInterface object is passed to both the main metadata section component and to the icon component. In addition to the basic properties described in Creating a Web Component, this cueInterface object has the following properties in each case:

For the home page metadata section component

homePanel

An object representing the current home screen panel. The properties and functions exposed by this object vary according to the type of panel as follows:

Search panel

The following functions are exposed:

addFocusedResultWatcher(watcher: Function)

Adds a watcher that will be notified whenever the focus moves to a new search result. The watcher will be invoked with the currently selected result.

Latest opened

The following functions are exposed:

addFocusedResultWatcher(watcher: Function)

Adds a watcher that will be notified whenever the focus moves to a new item.

Section editor

The following functions are exposed:

addFocusedSectionWatcher(watcher: Function)

Adds a watcher that will be notified whenever the focus moves to a section.

For the icon component

active

A boolean property that indicates whether or not the metadata section is currently active.

addActiveWatcher(watcher: Function)

A function that adds a watcher that will be notified when the active state of the home page metadata section changes. The watcher will be invoked with the new state.

removeActiveWatcher(watcher: Function)

A function that removes a previously added watcher.