HTML5 Viewer SDK API Documentation 

Namespaces


Class Index

Classes in s7sdk.search

Class s7sdk.search.SearchResultsDesc

This class represents a complete response of the search server for a particular search query. It contains the original search text and the list of catalog frames where search hits were found.

Class Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
 
specifies the list of SearchResultsFrameDesc instances which represent each catalog frame where search hits were found.
 
specifies the search string.
Method Summary
Method Attributes Method Name and Description
 
Returns total number of search hits in these search resuls
Class Detail
s7sdk.search.SearchResultsDesc(searchText)
Parameters:
{String} searchText
The search string
Field Detail
{Array} frameList
specifies the list of SearchResultsFrameDesc instances which represent each catalog frame where search hits were found.
See:
s7sdk.search.SearchResultsFrameDesc

{String} searchText
specifies the search string. Required.
Method Detail
{Number} getHitCount()
Returns total number of search hits in these search resuls
Returns:
{Number} number of search hits.

Documentation generated by JsDoc Toolkit 2.4.0 on Thu Oct 15 2020 11:59:13 GMT-0000 (UTC)