* `String this.value()` --
A function returning the value of the widget's HTML element.
+* `VOID autosearch()` --
+ Registers that this kind of widget is one that requires an
+ automatic search to be run for it if an `autosearch` attribute
+ is provided on the HTML element. This is appropriate for
+ widgets such as `Records` and `Facet` that display some part
+ of a search result.
+
+* `VOID hideWhenNarrow()` --
+ Registers that this widget should hide itself when the page
+ becomes "narrow" -- that is, fewer pixels in width that the
+ threshhold value specified by the top-level configuration item
+ `responsive_design_width`. Should be used for "unimportant"
+ widgets that can be omitted from the mobile version of a site.
+
+* `expandValue()` --
+ TODO: either document this or remove it from the API.
+
+* `subwidget(type, overrides, defaults)` --
+ Returns the HTML of a subwidget of the specified type, which
+ can then be inserted into the widget using the
+ `this.node.html` function. The subwidget is given the same
+ attributes at the parent widget that invokes this function,
+ except where overrides are passed in. If defaults are also
+ provided, then these are used when the parent widget provides
+ no values. Both the `overrides` and `defaults` arguments are
+ hashes: the latter is optional.
+
+ See for example the `Credo` widget defined in the example
+ area's `mkws-widget-credo.js` file. This uses several
+ invocations of `subwidget` to create a complex compound widget
+ with numerous text, facet and image panes. TODO: rename this
+ widget and everything related to it.
+
+In addition to these properties and methods of the bare widget object,
+some kinds of specific widget add other properties of their own. For
+example, the `Builder` widget uses a `callback` property as the
+function that it use to publish the widget definition that it
+constructs. This defaults to the builtin function `alert`, but can be
+overridden by derived widgets such as `ConsoleBuilder`.
+
Team methods
------------
is via the following API methods rather than direct access to
properties.
-String team.name()
-Bool team.submitted()
-Num team.perpage()
-Num team.totalRecordCount()
-Num team.currentPage();
-String team.currentRecordId()
-String team.currentRecordData()
- Simple accessor functions that provide the ability to read
- properties of the team.
-
-Array team.filters()
+* `String team.name()`
+* `Bool team.submitted()`
+* `Num team.perpage()`
+* `Num team.totalRecordCount()`
+* `Num team.currentPage();`
+* `String team.currentRecordId()`
+* `String team.currentRecordData()`
+
+These are all simple accessor functions that provide the ability to
+read properties of the team.
+
+* `Array team.filters()` --
Another accessor function, providing access to the array of
prevailing filters (which narrow the search results by means
of Pazpar2 filters and limits). This is really too complicated
an object for the widgets to be given access to, but it's
- convenient to do it this way. See the "Navi" widget, which is
- the only place it's used.
+ convenient to do it this way. If you must insist on using
+ this, see the `Navi` widget, which is the only place it's used.
-Hash team.config()
+* `Bool team.targetFiltered(targetId)` --
+ Indicates whether the specified target has been filtered by
+ selection as a facet. This is used only by the `Facet` widget,
+ and there is probably no reason for you to use it.
+
+* `Hash team.config()` --
Access to the team's configuration settings. There is almost
certainly no reason to use this: the settings that haven't
- been overridden are accessible via this.config.
+ been overridden are accessible via `this.config`.
-Void team.set_sortOrder(string)
-Void team.set_perpage(number)
+* `Void team.set_sortOrder(string)`, `Void team.set_perpage(number)` --
"Setter" functions for the team's sortOrder and perpage
- functions. Unlikely to be needed outside of the "Sort" and
- "Perpage" widgets.
+ functions. Unlikely to be needed outside of the `Sort` and
+ `Perpage` widgets.
-Queue team.queue(eventName)
+* `Queue team.queue(eventName)` --
Returns the queue associated with the named event: this can be
used to subscribe to the event (or more rarely to publish it).
-Bool team.targetFiltered(targetId)
- Indicates whether the specified target has been filtered by
- selection as a facet.
-
-Void team.newSearch(query, sortOrder, maxrecs, perpage, limit, targets, targetfilter)
+* `Void team.newSearch(query, sortOrder, maxrecs, perpage, limit, targets, targetfilter)` --
Starts a new search with the specified parameters. All but the
query may be omitted, in which case the prevailing defaults
are used.
-Void team.reShow()
+* `Void team.reShow()` --
Using the existing search, re-shows the result records after a
change in sort-order, per-page count, etc.
-String team.recordElementId(recordId)
+* `String team.recordElementId(recordId)` --
Utility function for converting a record identifer (returned
from Pazpar2) into a version suitable for use as an HTML
element ID.
-String team.renderDetails(recordData)
+* `String team.renderDetails(recordData)` --
Utility function returns an HTML rendering of the record
represented by the specified data.
-Template team.loadTemplate(templateName)
+* `Template team.loadTemplate(templateName)` --
Loads (or retrieves from cache) the named Handlebars template,
and returns it in a form that can be invoked as a function,
passed a data-set.
widgets is still in the team. When we finish migrating it, the widget
API should get simpler.
+
+Events
+------
+
+TODO: list of events that can be usefully subscribed to.
+
+
- - -
Copyright (C) 2013-2014 by IndexData ApS, <http://www.indexdata.com>
projects / mkws-moved-to-github.git / blobdiff