ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2025-06-11 20:01:41 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

[Search] Documentation

Browse Source
This commit is contained in:
slhale
2015-08-14 16:41:03 -07:00
parent 5e3caf6252
commit 1030eff943
1 changed files with 17 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
platform/search/src/controllers/SearchController.js
View File

@ -40,9 +40,11 @@ define(function () {
// ngModel.input, ngModel.search, ngModel.checked // ngModel.input, ngModel.search, ngModel.checked
$scope.types = []; $scope.types = [];
$scope.ngModel.checked = {}; $scope.ngModel.checked = {};
$scope.filtersString = ""; $scope.filtersString = '';
$scope.loading = false; $scope.loading = false;
// Filters searchResult objects by type. Allows types that are
// checked. (ngModel.checked['typekey'] === true)
function filter(hits) { function filter(hits) {
var newResults = [], var newResults = [],
i = 0; i = 0;
@ -58,6 +60,7 @@ define(function () {
return newResults; return newResults;
} }
// For documentation, see search below
function search(maxResults) { function search(maxResults) {
var inputText = $scope.ngModel.input; var inputText = $scope.ngModel.input;
@ -94,6 +97,7 @@ define(function () {
}); });
} }
// For documentation, see updateOptions below
function updateOptions() { function updateOptions() {
var type, var type,
i; i;
@ -149,8 +153,8 @@ define(function () {
return { return {
/** /**
* Search the filetree. * Search the filetree. Assumes that any search text will
* Assumes that any search text will be in ngModel.input * be in ngModel.input
* *
* @param maxResults (optional) The maximum number of results * @param maxResults (optional) The maximum number of results
* that this function should return. If not provided, search * that this function should return. If not provided, search
@ -159,8 +163,8 @@ define(function () {
search: search, search: search,
/** /**
* Checks to see if there are more search results to display. If the answer * Checks to see if there are more search results to display. If the answer is
* is unclear, this function will err on there being more results. * unclear, this function will err toward saying that there are more results.
*/ */
areMore: function () { areMore: function () {
var i; var i;
@ -179,7 +183,7 @@ define(function () {
/** /**
* Increases the number of search results to display, and then * Increases the number of search results to display, and then
* load them. * loads them, adding to the displayed results.
*/ */
loadMore: function () { loadMore: function () {
numResults += LOAD_INCREMENT; numResults += LOAD_INCREMENT;
@ -188,17 +192,21 @@ define(function () {
// Resend the query if we are out of items to display, but there are more to get // Resend the query if we are out of items to display, but there are more to get
search(numResults); search(numResults);
} else { } else {
$scope.results = filter(fullResults.hits);//fullResults.hits.slice(0, numResults); // Otherwise just take from what we already have
$scope.results = filter(fullResults.hits);
} }
}, },
/** /**
* Re-filters the search restuls. Called when ngModel.checked changes. * Updates the status of the checked options, including 'check-all'.
* Updates the filtersString with which options are checked, if
* check-all is not true. Re-filters the search restuls.
*/ */
updateOptions: updateOptions, updateOptions: updateOptions,
/** /**
* Resets options. * Checks or un-checks all of the filter options depending on the
* value of ngModel.checkAll, then calls updateOptions.
*/ */
checkAll: function () { checkAll: function () {
var type; var type;