IGenericObjectGetHyperCubeBinnedDataAsyncT Method (AsyncHandle, FuncResponse, T, String, IEnumerableNxPage, NxViewPort, IEnumerableNxDataAreaPage, Int32, Int32, Int32) |
This method supports data binning.
When a generic object with two measures and one dimension contains a lot of data, groups of points (i.e cells) can be rendered instead of points.
A zone of interest can be refined (for zooming in) up to a maximum refinement level (set in the qQueryLevel parameter) or coarsened (for zoom out).
The grid of cells is adaptive (not static), meaning that it adapts to different length scales.
The GetHyperCubeBinnedDatamethod gives information about the adaptive grid and the values of the generic object.
The generic object should contain two measures and one dimension.
The number of points in a cell and the coordinates (expressed in the measure range) of each cell are returned.
Dimension values and measure values are rendered at point level (highest detailed level).
Namespace: Qlik.EngineAssembly: Qlik.Engine (in Qlik.Engine.dll) Version: 2.1.0.0+Build:7.origin/release/ms13
Syntax Task<T> GetHyperCubeBinnedDataAsync<T>(
AsyncHandle asyncHandle,
Func<Response, T> onResult,
string path,
IEnumerable<NxPage> pages,
NxViewPort viewport,
IEnumerable<NxDataAreaPage> dataRanges,
int maxNbrCells,
int queryLevel,
int binningMethod
)
Function GetHyperCubeBinnedDataAsync(Of T) (
asyncHandle As AsyncHandle,
onResult As Func(Of Response, T),
path As String,
pages As IEnumerable(Of NxPage),
viewport As NxViewPort,
dataRanges As IEnumerable(Of NxDataAreaPage),
maxNbrCells As Integer,
queryLevel As Integer,
binningMethod As Integer
) As Task(Of T)
Parameters
- asyncHandle
- Type: Qlik.EngineAsyncHandle
Handle to asynchronous method request - onResult
- Type: SystemFuncResponse, T
Continuation function - path
- Type: SystemString
Path to the definition of the object.
For example, /qHyperCubeDef.
This parameter is mandatory. - pages
- Type: System.Collections.GenericIEnumerableNxPage
Array of pages to retrieve.
Since the generic object contains two measures and one dimension, qWidth should be set to 3.
If the value of a measure is Null, the value cannot be rendered. Therefore, the number of elements rendered in a page can be less than the number defined in the property qHeight.
This parameter is mandatory. - viewport
- Type: Qlik.EngineNxViewPort
Defines the canvas and the zoom level.
This parameter is not yet used and is optional. - dataRanges
- Type: System.Collections.GenericIEnumerableNxDataAreaPage
Range of the data to render.
This range applies to the measure values.
The lowest and highest values of a measure can be retrieved by using the GetLayout method ( in /qHyperCube/qMeasureInfo).
This parameter is mandatory. - maxNbrCells
- Type: SystemInt32
Maximum number of cells in the grid.
This parameter is mandatory. - queryLevel
- Type: SystemInt32
Level of details. The higher the level, the more detailed information you get (zoom-in).
When the number of points to render falls below a certain threshold, the values are no longer rendered as cells but a s points.
The query level should be no greater than 20.
This parameter is optional. - binningMethod
- Type: SystemInt32
Selects the algorithm.
The default value is 0.
One of:
0: Adaptive grid
Type Parameters
- T
Return Value
Type:
TaskTSee Also