Class: SearchResult

new SearchResult()

The SearchResult object is created when searching a document. It represents a "search hit", the text in the document that matched a search term in the searchQuery, which was passed to PCCViewer.ViewerControl#search.

This constructor should not be used directly. Instead, only access search results created by PCCViewer.ViewerControl#search, through the PCCViewer.SearchRequest object.

See:

Use PCCViewer.SearchRequest#getResults to get results from a `SearchRequest` object.
Use PCCViewer.SearchRequest#results to get results from a `SearchRequest` object.

Members

(readonly) boundingRectangle :Object

Gets the bounding rectangle of the search result.

This is an ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8.

Type:

Object

See:

PCCViewer.SearchResult#getBoundingRectangle

(readonly) context :string

Gets the search result text and some surrounding text.

The number of character in the context before and after the search result text can be configured using the PCCViewer.ViewerControl~SearchQuery passed to the PCCViewer.ViewerControl#search method.

This is an ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8.

Type:

string

See:

PCCViewer.SearchResult#getContext

(readonly) highlightColor :string

Gets the highlight color of the search result, in hex notation (e.g. "#F1F1F1").

The highlight color can be specified in the PCCViewer.ViewerControl~SearchQuery passed to the PCCViewer.ViewerControl#search method. If a highlight color is not specified on the searchQuery, then a pseudo-random color is chosen.

This is an ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8.

Type:

string

See:

PCCViewer.SearchResult#getHighlightColor

(readonly) id :number

Gets the ID of the search result.

The ID is unique only to results in the current search request, and it may be repeated in later search requests.

This is an ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8.

Type:

number

See:

PCCViewer.SearchResult#getId

(readonly) pageNumber :number

Gets the page number of the document, on which the search result starts.

If the search result text is contained on a single page, this returns the page number of that page. If the search result text spans multiple pages, this returns the page number of the first page.

This is an ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8.

Type:

number

See:

PCCViewer.SearchResult#getPageNumber

(readonly) searchTerm :PCCViewer.ViewerControl~SearchTerm|PCCViewer.ViewerControl~ProximitySearchTerm

Gets the search term object from the searchQuery object that was passed to the PCCViewer.ViewerControl#search method.

If a string was passed to the search method, then this will return a PCCViewer.ViewerControl~SearchTerm object generated from the string.

The returned object will be augmented with all options used for searching.

This is an ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8.

Type:

PCCViewer.ViewerControl~SearchTerm | PCCViewer.ViewerControl~ProximitySearchTerm

See:

PCCViewer.SearchResult#getSearchTerm

(readonly) searchTerm :PCCViewer.ViewerControl~SearchTerm|PCCViewer.ViewerControl~ProximitySearchTerm

Gets the search term object from the searchQuery object that was passed to the PCCViewer.SearchTask constructor.

If a string was passed to the search method, then this will return a PCCViewer.ViewerControl~SearchTerm object generated from the string.

The returned object will be augmented with all options used for searching.

This is an ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8.

Type:

PCCViewer.ViewerControl~SearchTerm | PCCViewer.ViewerControl~ProximitySearchTerm

See:

PCCViewer.SearchResult#getSearchTerm

(readonly) startIndexInContext :number

Gets the start index of the search result text within the context text returned by PCCViewer.SearchTaskResult#getContext.

This is an ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8.

Type:

number

See:

PCCViewer.SearchTaskResult#getStartIndexInContext

(readonly) startIndexInContext :number

Gets the start index of the search result text within the context text returned by PCCViewer.SearchResult#getContext.

This is an ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8.

Type:

number

See:

PCCViewer.SearchResult#getStartIndexInContext

(readonly) text :string

Gets the search result text. This is the text that matched the search query/term.

This is an ECMA 5 accessor property that is defined only in browsers supporting ECMA 5. This property is not available in the older browsers like IE8.

Type:

string

See:

PCCViewer.SearchResult#getText

Methods

getBoundingRectangle() → {Object}

Gets the bounding rectangle for the search result.

See:

PCCViewer.SearchResult#boundingRectangle

Returns:

A rectangle object of the type {x: xValue, y: yValue, width: widthValue, height: heightValue}.

Type: Object

Example

if (searchResult.getBoundingRectangle) {
    var boundingRectangle = searchResult.getBoundingRectangle();
}

getContext() → {string}

Gets the search result text and some surrounding text.

The number of character in the context before and after the search result text can be configured using the PCCViewer.ViewerControl~SearchQuery passed to the PCCViewer.ViewerControl#search method.

See:

Use PCCViewer.SearchResult#getStartIndexInContext to identify the location of the search result text within the context.

Returns:

The context of the search result.

Type: string

Example

var results = searchRequest.getResults()
var result = results[0];

result.getText();                 // e.g. "document"
result.getContext();              // e.g. "... the full spectrum of document, content, & imaging s..."
result.getStartIndexInContext();  // e.g. 25

getHighlightColor() → {string}

Gets the highlight color of the search result, in hex notation (e.g. "#F1F1F1").

Returns:

The color of the search result highlight, in hexadecimal notation.

Type: string

Example

var results = searchRequest.getResults()
var result = results[0];
var highlightColor = result.getHighlightColor();

getId() → {number}

Gets the ID of the search result.

The ID is unique only to results in the current search request, and it may be repeated in later search requests.

See:

PCCViewer.SearchRequest#getResults

Returns:

The ID of the search result.

Type: number

Example

var results = searchRequest.getResults();
var result = results[0];
var id = result.getId();

getPageNumber() → {number}

Gets the page number of the document, on which the search result starts.

If the search result text is contained on a single page, this returns the page number of that page. If the search result text spans multiple pages, this returns the page number of the first page.

Returns:

The page number on which the search result starts.

Type: number

Example

var results = searchRequest.getResults()
var result = results[0];
var pageNumber = result.getPageNumber();
alert("Search result found on page: " + pageNumber);

getSearchTerm() → {PCCViewer.ViewerControl~SearchTerm|PCCViewer.ViewerControl~ProximitySearchTerm}

Gets the search term object from the searchQuery object that was passed to the PCCViewer.ViewerControl#search method.

If a string was passed to the search method, then this will return a PCCViewer.ViewerControl~SearchTerm object generated from the string.

The returned object will be augmented with all options used for searching.

Returns:

The search term of the search result.

Type: PCCViewer.ViewerControl~SearchTerm | PCCViewer.ViewerControl~ProximitySearchTerm

Example

var results = searchRequest.getResults()
var result = results[0];
var searchTerm = result.getSearchTerm();
alert("This search result matched the search term: " + searchTerm.searchTerm);

getStartIndexInContext() → {number}

Gets the start index of the search result text within the context text returned by PCCViewer.SearchResult#getContext.

Returns:

The start index of the search result text within the context text.

Type: number

Example

var results = searchRequest.getResults();
var result = results[0];
var startIndex = result.getStartIndexInContext();

getStartIndexInPage() → {number}

Gets the start index of the search result text, within the entire text of the page that the result is on.

See:

Use PCCViewer.ViewerControl#requestPageText to get the full text of a page.
Use PCCViewer.SearchResult#getText to get the matched text of the search result.

Returns:

The start index of the matched text in the page.

Type: number

Example

var results = searchRequest.getResults()
var result = results[0];
var startIndex = result.getStartIndexInPage();
alert("The search result starts a character " + startIndex + " on the page.");

getText() → {string}

Gets the search result text. This is the text that matched the search query/term.

Returns:

The search result text.

Type: string

Example

var results = searchRequest.getResults()
var result = results[0];
var text = result.getText();
alert("Search matched the text: " + text);