Settings Methods
All methods below are as if the Smart Search object has a reference variable defined as shown in this code snippet.
This is not a complete list of the globally available function but the ones that we find most helpful.
Overview¶
- getQuickViewSettings ⇒
object | error -
Returns the Quick View settings object or error if data not found.
- getCombinedSearchSettings ⇒
object | error -
Returns the Results Page settings object or error if data not found.
getQuickViewSettings¶
Returns the Quick View settings object or error if data not found.
Kind: global constant\
Returns: Object | error
getCombinedSearchSettings¶
Returns the entire Combined Search data including Results Page settings and Quick View settings object. Error if data not found.
--- title: Settings Methods excerpt: Access Quick View and Combined Search settings programmatically deprecated: false hidden: false metadata: title: '' description: '' robots: index next: description: '' --- All methods below are as if the Smart Search object has a reference variable defined as shown in this code snippet. ```javascript title="Smart Search reference" const SmartSearch = window.Rebuy.SmartSearch; ``` *This is not a complete list of the globally available function but the ones that we find most helpful.* <br /> <br /> ## Overview <dl> <dt><a href="#getQuickViewSettings">getQuickViewSettings</a> ⇒ <code>object | error</code></dt> <dd> <p>Returns the Quick View settings object or error if data not found.</p> </dd> <dt><a href="#getCombinedSearchSettings">getCombinedSearchSettings</a> ⇒ <code>object | error</code></dt> <dd> <p>Returns the Results Page settings object or error if data not found.</p> </dd> </dl> ## getQuickViewSettings Returns the Quick View settings object or error if data not found. **Kind**: global constant\ **Returns**: `Object | error` <a name="getQuickViewSettings"></a> ## getCombinedSearchSettings Returns the entire Combined Search data including Results Page settings and Quick View settings object. Error if data not found. **Kind**: global constant\ **Returns**: `Object | error` <a name="getCombinedSearchSettings"></a>