Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • minLength: int (default: 1) The minimum number of characters required to trigger a search, this is ignored if 'doSearchWhenEmpty' is set to true
  • searchLabel: string (default: omsgs.searchLabel) The text to be used as the label for the search textbox
  • includeVoidedLabel: string (default: omsgs.includeVoided) The text to be used as the label for the 'includeVoided' checkbox
  • showIncludeVoided: bool (default: false) - Specifies whether the 'includeVoided' checkbox and label should be displayed
  • includeVerboseLabel: string (default: omsgs.includeVerbose) The text to be used as the label for the 'includeVerbose' checkbox
  • showIncludeVerbose: bool (default: false) Specifies whether the 'includeVerbose' checkbox and label should be displayed
  • searchHandler: function(text, resultHandler, options) (default:null) The function to be called to fetch search results from the server
  • resultsHandler: function(results) (default:null) The function to be called
  • selectionHandler: function(index, rowData)
  • fieldsAndHeaders: Array of fieldNames and column header maps
  • displayLength: int (default: 10)
  • columnWidths: an array of column widths, the length of the array should be equal to the number of columns, should be of the same length as the number of columns
  • columnRenderers: array of fnRender(s) for each column, should be of the same length as the number of columns, set a value of null for columns with no renderers
  • columnVisibility: array of bVisible values for each column, true/false are the only possible values in the array and should be of the same length as the number of columns
  • initialData: (default: null) The initial data to be displayed e.g if it is an encounter search, it should be an encounter list
  • searchPhrase: string The phrase to be set in the search box so that a search is triggered on page load to display initial items
  • doSearchWhenEmpty: string (default:false): If it is set to true, it lists all items initially and filters them with the given search phrase.
  • verboseHandler: function to be called to return the text to display as verbose output
  • attributes: Array of  name and column headers for attributes columns to display in the list of results. For this to work,  the returned items should have an 'attributes' property which should be a map of attribute names and their values. See PersonListItem.java and the patient index page for an example