Interface: QueryResultAPI

QueryResultAPI

API class that is used to access a query result object.

Example

queryResults.getResult()

Methods

getPointDecoration(rowIndex) → {Object}

Get decorations for a datapoint

Parameters:
Name Type Description
rowIndex Number

Numeric row index of the datapoint
Returns:

Object map containing decorations in name/value pairs. Values are either a primitive value or an object representing the decoration.

Type
Object
Example
{
		"tooltip": [
			["Confidence Upper Bound", "73.08"],
			["Audience Score % (Average) Forecast", "60.82"],
			["Confidence Lower Bound", "48.56"]
		],
		"forecastHighConfidence": 73.07758990139354,
		"forecast": true,
		"forecastValue": 60.8200277621683,
		"forecastLowConfidence": 48.56246562294306
	}

getResultItemList() → {Array.<ResultItemAPI>}

Gets array of ResultItemAPI.

Returns:

Array of ResultItemAPI

Type
Array.<ResultItemAPI>

getRowCount() → {Number}

Gets data row count.

Returns:

Number of rows of data in a query result object.

Type
Number

getValue(rowIndex, resultDataItemIndex) → {Array.<ResultDataValue>|ResultDataValue}

Gets result data value based on row and column indexes.

Parameters:
Name Type Description
rowIndex Number

Row index of the result data points
resultDataItemIndex Number

Data item index to get value in ResultItemAPI
Returns:

Array of ResultDataValue

Type
Array.<ResultDataValue> | ResultDataValue
Examples
// Category value
[{
	value: 'dataset_csv.Product_line->[Camping Equipment]',
	label: 'Camping Equipment'
}]
// Measure value
{
	value: 200
}