PMA.UI Documentation by Pathomation

MetadataSearch

PMA.UI.Components MetadataSearch

Represents a component that searches in form meta data for slides. It has a visual representation as a text field and also provides programmatic methods to search.

Constructor

new MetadataSearch(context, optionsopt)

Source:
Tutorials:
  • Tutorial: 08-meta-search
Parameters:
Name Type Attributes Default Description
context Context
options object <optional>
 null Configuration options. If not provided, the component has no visual representation.
Properties
Name Type Description
element string | HTMLElement The container in which an input field will be added to function as a search box. It can be either a valid CSS selector or an HTMLElement instance.
Fires:

Methods

listen(eventName, callback)

Source:
Attaches an event listener
Parameters:
Name Type Description
eventName PMA.UI.Components.Events The name of the event to listen to
callback function The function to call when the event occurs

listen(eventName, callback)

Source:
Attaches an event listener
Parameters:
Name Type Description
eventName Components.Events The name of the event to listen to
callback function The function to call when the event occurs
Source:
Searches for slides in meta data entries
Parameters:
Name Type Description
serverUrl string The url of the PMA.core search to search against
queryString string The query to search with
Returns:
Type
Promise
Source:
Searches for slides in meta data entries
Parameters:
Name Type Description
serverUrl string The url of the PMA.core search to search against
queryString string The query to search with
Returns:
Type
Promise