Maps API for JavaScript Developer's Guide

H.service.extension.platformData.SearchRequest

Class Summary

Extends: H.util.EventTarget

Implements: H.util.ICancelable

This class is responsible for the data search in the Platform Data Extension API
Deprecated:
since 3.0.16.0, use H.service.extension.platformData.Service#searchByBoundingBox instead.

[ For full details, see the Class Details ]

Method Summary

Table 1. Methods
Methods

send ()

This method sends request

cancel ()

This method cancels request

Events Summary

Table 2. Events
Events

data : {H.util.DataEvent<H.service.extension.platformData.Table>}

Fired when a chunk of the data is loaded

error : {H.util.ErrorEvent}

Fired if error occurred during the search

end : {H.util.Event}

Fired if a last chunk of the data has been loaded

Class Description

This class is responsible for the data search in the Platform Data Extension API

Constructor Details

H.service.extension.platformData.SearchRequest(service, bounds, layerConfigs)

Parameters:
 
service:
{H.service.extension.platformData.Service}
 
The service to use for the communication with the REST API.
bounds:
{H.geo.Rect}
 
The area to search within.
layerConfigs:
{Array<H.service.extension.platformData.LayerConfig>}
 
The list of configurations for the layers to search within.
Throws:
 
{H.lang.InvalidArgumentError}
 
if service, bounds or layerConfigs parameter is not specified or has invalid type

Method Details

send ()

This method sends request

cancel ()

This method cancels request

Event Details

data: {H.util.DataEvent<H.service.extension.platformData.Table>}

Fired when a chunk of the data is loaded

error: {H.util.ErrorEvent}

Fired if error occurred during the search

end: {H.util.Event}

Fired if a last chunk of the data has been loaded