H.datalens. QueryTileProvider
Class Summary
Extends: H.map.provider.RemoteTileProvider
Defines the source of the data for layers from a tiled Data Lens query.
[ For full details, see the Class Details ]
Class Description
Providers define interfaces for layers to access data. The input data can be stored locally or loaded from the network. Data can be loaded by tiles or in one chunk. This provider loads tiled query data with the Data Lens REST API. Tiled queries are used to load data only for the current viewport. This optimizes memory and network usage and enables progressive rendering.
var provider = new H.datalens.QueryTileProvider(
service,
{
queryId: TILED_QUERY,
tileParamNames: {x: 'x', y: 'y', z: 'z'}
}
);
var layer = new H.map.layer.TileLayer(provider);Constructor Details
H.datalens.QueryTileProvider (service, options)
- Parameters:
-
service: -
{ H.datalens.Service } - Data Lens REST API service
-
options: -
{ H.datalens.QueryTileProvider.Options } - Configures source query and data accessibility parameters
Method Details
setQueryId (queryId)
Updates the query ID to be used in the next call of the Data Lens REST API. Note that new data will be fetched only after the reload method is called.
- Parameters:
-
queryId: -
{ string }
setQueryParams (queryParams)
Updates the query's dynamic parameters to be used in the next call of the Data Lens REST API. Note that new data will be fetched only after the
reload method is called. This method is normally used when updating your visualization. provider.setQueryParams({min_magnitude: 3});
provider.reload();- Parameters:
-
queryParams: -
{ object | null } - Query dynamic parameters
setTileParamNames (tileParamNames)
Updates the names of the dynamic parameters that defines tiles. This method is only needed when the query ID is updated. Note that new data will be fetched only after the reload method is called.
- Parameters:
-
tileParamNames: -
{ H.datalens.QueryTileProvider.TileParamNames } - Names of the URI parameters that control the x/y/z of a tiled query