gradereport_grader/search

Description:

  • Allow the user to search for learners within the grader report. Have to basically search twice on the dataset to avoid passing around massive csv params whilst allowing debouncing.

Source:
Copyright:
  • 2023 Mathew May
License:
  • http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Allow the user to search for learners within the grader report. Have to basically search twice on the dataset to avoid passing around massive csv params whilst allowing debouncing.

Methods

clickHandler(e)

Description:

  • The handler for when a user interacts with the component.

Source:
Parameters:
Name Type Description
e MouseEvent

The triggering event that we are working with.

fetchDataset() → {Promise.<*>}

Description:

  • Get the data we will be searching against in this component.

Source:
Returns:
Type
Promise.<*>

(async) filterDataset(filterableData) → {Array}

Description:

  • Dictate to the search component how and what we want to match upon.

Source:
Parameters:
Name Type Description
filterableData Array
Returns:

The users that match the given criteria.

Type
Array

(async) filterMatchDataset() → {Array}

Description:

  • Given we have a subset of the dataset, set the field that we matched upon to inform the end user.

Source:
Returns:

The results with the matched fields inserted.

Type
Array

getStringMap() → {Promise.<void>}

Description:

  • Given the set of profile fields we can possibly search, fetch their strings, so we can report to screen readers the field that matched.

Source:
Returns:
Type
Promise.<void>

keyHandler(e)

Description:

  • The handler for when a user presses a key within the component.

Source:
Parameters:
Name Type Description
e KeyboardEvent

The triggering event that we are working with.

(async) renderDropdown()

Description:

  • Build the content then replace the node.

Source:
Description:

  • Build up the view all link.

Source:
Returns:
Type
string | *
Description:

  • Build up the view all link that is dedicated to a particular result.

Source:
Parameters:
Name Type Description
userID Number

The ID of the user selected.
Returns:
Type
string | *

setComponentSelector() → {string}

Description:

  • The overall div that contains the searching widget.

Source:
Returns:
Type
string

setDropdownSelector() → {string}

Description:

  • The dropdown div that contains the searching widget result space.

Source:
Returns:
Type
string

setTriggerSelector() → {string}

Description:

  • The triggering div that contains the searching widget.

Source:
Returns:
Type
string