search_pane.js

Summary
search_pane.js
bbop.widget.search_paneBBOP object to produce a self-constructing/self-destructing term general filtering search tool for an index.
Functions
search_paneContructor for the bbop.widget.search_pane object.
establish_displayCompletely redraw the display.

bbop.widget.search_pane

BBOP object to produce a self-constructing/self-destructing term general filtering search tool for an index.  This is a completely self-contained UI and manager.

The function “.establish_display()” must be run after an initial personality is set.  Also, in many use cases, you’ll want to have an line like the following befire running “.establish_display()”.

sp_widget.add_query_filter('document_category', 'annotation', ['*']);

The search pane will display one less filter row than is set with .set_facet_limit(), it will use this runover to decide whether or not to display the “more” option for the filters.

Summary
Functions
search_paneContructor for the bbop.widget.search_pane object.
establish_displayCompletely redraw the display.

Functions

search_pane

bbop.widget.search_pane = function(golr_loc,
golr_conf_obj,
interface_id,
in_argument_hash)

Contructor for the bbop.widget.search_pane object.

This is a specialized (and widgetized) subclass of bbop.golr.manager.jquery.

Sticky filters (see manager documentation) are “hidden” from the user in all displays.

The optional hash arguments look like

base_icon_urlbase path to icons, see above (default null, use text)
image_typeicon image type (default ‘gif’)
layout_typechoose the layout type to use (default ‘two-column’)
show_global_reset_pshow the global reset button (default true)
show_searchbox_pshow the search query box (default true)
show_filterbox_pshow currents filters and accordion (default true)
show_pager_pshow the results pager (default true)

Arguments

golr_locstring url to GOlr server; not needed if local
golr_conf_obja bbop.golr.conf object
interface_idstring id of the element to build on
in_argument_hash[optional] optional hash of optional arguments

Returns

self

establish_display

this.establish_display = function()

Completely redraw the display.

Required to display after setting up the manager.

Also may be useful after a major change to the manager.

Parameters

n/a

Returns n/a

bbop.widget.search_pane = function(golr_loc,
golr_conf_obj,
interface_id,
in_argument_hash)
Contructor for the bbop.widget.search_pane object.
this.establish_display = function()
Completely redraw the display.
jQuery BBOP manager for dealing with actual ajax calls.
Close