Grid Search

Grid Search Specification

Contents

1. Overview
2. User Stories
3. API

Objectives

Add an API that would easily let the developer implement search functionality within the grid, which would be able to scroll and focus the first cell containing the specified string and highlight the rest of the cells containing that string.

2. User Stories

As a citizen developer, I want to:

• be able to highlight all occurrences of a given string within the grid.
• be able to scroll to the first occurrence of a given string and enter edit mode for the cell that contains it.
• be able to find the next/previous occurrence of the string and enter edit mode for the cell that contains it.
• be able to specify if the string should be case sensitive or not.
• be able to configure how the highlight looks like. ...

3. API

Methods

Name	Description	Return type	Parameters
findNext	Finds the next occurrence of a given string in the grid and scrolls to the cell if it isn't visible. Returns how many times the grid contains the string	number	The string to search and, optionally, if the search should be case sensitive (defaults to false) and if all occurrences of the string should be highlighted (defaults to true)
findPrev	Finds the previous occurrence of a given string in the grid and scrolls to the cell if it isn't visible. Returns how many times the grid contains the string	number	The string to search and, optionally, if the search should be case sensitive (defaults to false) and if all occurrences of the string should be highlighted (defaults to true)