Application Framework Reference

Module API

getResultParams()

The getResultParams() method gets modified/refined/extended parameters when called by functions such as getResults() .

Note: This method is intended to be overridden and returns an empty object by default.

Synopsis

param = getResultParams()

Return Value

Object

Results params.

Example

getResultParams: function() {
    var context = this.getContext();
    var params = {
        output_mode: this._params['outputMode'],
        fields: [],
        sort_key: this.sortBy,
        sort_dir: this.sortDir,
        count:  context.get('results.count'),
        offset: context.get('results.offset')
    };  

    if (this._params['labelField']) params['fields'].push({'label': this._params['labelField']});  
    if (this._params['valueField']) params['fields'].push({'label': this._params['valueField']});
    for (var i=0, j=params['fields'].length; i<j; i++) {
        params['fields'][i] = JSON.stringify(params['fields'][i]);
    }  
    return params;
},
 

See Also

getResults()
haveResultsParamsChanged()