X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fmkws-developer.markdown;h=6066e0518a8bf30811d04e892321d9c58720d97f;hb=dad2bae0cce47cda5df497c0eb547edba14758d9;hp=d302027c55d748d328f27b2aabcf861857e0001d;hpb=1d330de3056b4799c7cef1495ba98dd4faaa6154;p=mkws-moved-to-github.git diff --git a/doc/mkws-developer.markdown b/doc/mkws-developer.markdown index d302027..6066e05 100644 --- a/doc/mkws-developer.markdown +++ b/doc/mkws-developer.markdown @@ -148,9 +148,10 @@ properties. * `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. +* `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 @@ -160,13 +161,17 @@ properties. 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. +* `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`. -* `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. @@ -175,10 +180,6 @@ properties. 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)` -- Starts a new search with the specified parameters. All but the query may be omitted, in which case the prevailing defaults