Powered by Zoomin Software. For more details please contactZoomin

HERE Maps API for JavaScript - API Reference

Filters

Clear All Filters
Product category
Technology
Doc type
Version
Product lifecycle
Clear All Filters
This publication

HERE Maps API for JavaScript - API Reference: Class: Provider

Share
Share to emailCopy article URL
Feedback
Print
Table of Contents
HomeHERE Maps API for JavaScript - API Reference...IndexClass: ProviderCurrent page
Table of Contents

Class: Provider

Share
Share to emailCopy article URL
Feedback
Print

H.clustering.Provider

new H.clustering.Provider (dataPoints, opt_options)

The clustering provider serves clusters and noise point representation for the map based on the provided data set. Levels for clustering as well as custom cluster representation can be set via Options.

Name Type Description
dataPoints Array.<!H.clustering.DataPoint>

An array of objects representing data points
opt_options H.clustering.Provider.Options optional

An object containing configuration options
Throws:

If H.clustering.Provider.Strategy.DYNAMICGRID strategy is used with the projection other than default H.geo.mercator projection.

Type
H.lang.InvalidArgumentError
Example
var dataPoints = [
    new H.clustering.DataPoint(52, 1),
    new H.clustering.DataPoint(52.1, 1)
];
var clusteringProvider = new H.clustering.Provider(dataPoints, {
  clusteringOptions: {
    minWeight: 1,
    eps: 32
  }
});
// clustering should be used with ObjectLayer
var clusteringLayer = new H.map.layer.ObjectLayer(clusteringProvider);
map.addLayer(clusteringLayer);

Extends

Members

H.clustering.Provider.Strategy static

This enumeration represents identifiers for possible clustering strategies.

Properties:

max number inherited

This property holds a value indicating the maximum zoom level at which the given provider can serve data. The value is set at construction time.

min number inherited

This property holds a value indicating the minimum zoom level at which the given provider can serve data. The value is set at construction time.

uid string inherited

This property holds the unique identifier for the provider instance. The value is generated at construction time.

uri string inherited

This property holds the provider's unique resource identifier. If it is not provided at construction time, it defaults to provider's uid.

Methods

addDataPoint (dataPoint)

This method adds a data point to the provider. Note that this method triggers re-clustering of the the data set associated with the provider.

Name Type Description
dataPoint H.clustering.DataPoint

An object representing the data point to add

addDataPoints (dataPoints)

This method adds a list of data points to the provider. Note that this method triggers re-clustering of the data set associated with the provider.

Name Type Description
dataPoints Array.<!H.clustering.DataPoint>

A set of data point objects to add

addEventListener (type, handler, opt_capture, opt_scope) inherited

This method adds a listener for a specific event.

Note that to prevent potential memory leaks, you must either call removeEventListener or dispose on the given object when you no longer need it.

addOnDisposeCallback (callback, opt_scope) inherited

This method adds a callback which is triggered when the EventTarget object is being disposed.

Name Type Description
callback function

The callback function.
opt_scope Object optional

An optional scope for the callback function

dispatchEvent (evt) inherited

This method dispatches an event on the EventTarget object.

Name Type Description
evt H.util.Event | string

An object representing the event or a string with the event name

dispose () inherited

This method removes listeners from the given object. Classes that extend EventTarget may need to override this method in order to remove references to DOM Elements and additional listeners.

getCopyrights (boundingBox, level)Array.<!H.map.ICopyright> inherited

This method retrieves the copyrights for the provided content for a certain geographical area and zoom level.

Note: This function may be overridden by H.map.provider.Provider.Options getCopyrights property. The default implementation returns null.

Name Type Description
boundingBox H.geo.Rect

The rectangular area for which to retrieve the copyright information
level number

The zoom level for which to retrieve the copyright information
Returns:
Type Description
Array.<!H.map.ICopyright> A list of copyright information objects for the provided area and zoom level

getInvalidations (opt_type)H.map.provider.Invalidations inherited

This method retrieves the accumulated invalidations of the given provider's objects.

Name Type Description
opt_type H.map.Object.Type optional

The type of objects to consider for the invalidations. If undefined, all types are taken into account.
Returns:
Type Description
H.map.provider.Invalidations An object specifying invalidations

getObjectsWithin (area, callback, options) inherited

To obtain a list of map objects which intersect the provided area.

getRootGroup ()H.map.Group inherited

This method retrieves the root group for the given provider.

Returns:
Type Description
H.map.Group An object representing the root group for the given provider

getStyleInternal ()H.map.render.Style.<!Object> inherited

This methods returns the style used to render the provider data.

Returns:
Type Description
H.map.render.Style.<!Object>

getTheme ()H.clustering.ITheme

This method retrieves the current theme used for cluster visualizations.

Returns:
Type Description
H.clustering.ITheme An object representing the clustering scheme

invalidateObject (mapObject, changes) inherited

This method signals to the provider that a map object has changed. The method updates the Invalidations of the given provider and the specified map object and triggers dispatchUpdate().

Name Type Description
mapObject H.map.Object

The map object to be invalidated
changes H.math.BitMask.<!H.map.provider.Invalidations.Flag>

The flags indicating the types of changes that have occurred

providesDomMarkers ()boolean inherited overrides

This method checks whether this provider will provide DomMarker map objects. A concrete implementation of Provider must override it if it will provide DomMarkers.

Returns:
Type Description
boolean A value indicating if the given provider provides DomMarkers (true) or not (false)

providesGeoJSON ()boolean inherited

This method checks whether this provider will provide data in GeoJSON format. A concrete implementation of Provider must override it if it will provide GeoJSON data.

Returns:
Type Description
boolean A value indicating if the given provider provides GeoJSON data (true) or not (false)

providesMarkers ()boolean inherited overrides

This method checks whether this provider will provide Marker map objects. A concrete implementation of Provider must override it if it will provide Markers.

Returns:
Type Description
boolean A value indicating if the given provider provides Markers (true) or not (false)

providesOMV ()boolean inherited

This method checks whether this provider will provide data in OMV format. A concrete implementation of Provider must override it if it will provide OMV data.

Returns:
Type Description
boolean A value indicating if the given provider provides OMV data (true) or not (false)

providesOverlays ()boolean inherited

This method checks whether this provider will provide overlay map objects. A concrete implementation of Provider must override it if it will provide overlays.

Returns:
Type Description
boolean true if the provider provides overlays, otherwise false

providesRasters ()boolean inherited

This method checks whether this provider will provide bitmap images as tiles. A concrete implementation of Provider must override it if it will provide raster tiles.

Returns:
Type Description
boolean A value indicating if the given provider provides raster tiles (true) or not (false)

providesSpatials ()boolean inherited overrides

This method checks whether this provider will provide spatial map objects. A concrete implementation of Provider must override it if it will provide Spatials.

Returns:
Type Description
boolean A value indicating whether the provider provides map objects (true) or not (false)

removeDataPoint (dataPoint)

This method removes a data point from the provider's data set. Note that this method triggers re-clustering of the data set associated with the provider.

Name Type Description
dataPoint H.clustering.DataPoint

An object representing the data point to remove

removeEventListener (type, handler, opt_capture, opt_scope) inherited

This method removes a previously added listener from the EventTarget instance.

removeObject (object) Deprecated : since version 3.1.11.1 inherited

This method removes an object from the given provider's database. It must not called directly. It is invoked by H.map.Group which checks beforehand that it is an H.map.Object instance and its provider is the given provider.

Name Type Description
object H.map.Object

The object to remove

requestDomMarkers (geoRect, zoomLevel, visiblesOnly, cacheOnly)Array.<!H.map.DomMarker> inherited

This method retrieves all DomMarker map objects which intersect with the provided rectangular area.

Returns:
Type Description
Array.<!H.map.DomMarker> A list of intersecting objects

requestMarkers (geoRect, zoomLevel, visiblesOnly, cacheOnly)Array.<!H.map.Marker> inherited

This method retrieves all Marker map objects which intersect with the provided rectangular area.

Returns:
Type Description
Array.<!H.map.Marker> A list of intersecting objects

requestOverlays (geoRect, zoomLevel, visiblesOnly, cacheOnly)Array.<!H.map.Overlay> inherited

This method retrieves all overlay objects which intersect with the specified area.

Returns:
Type Description
Array.<!H.map.Overlay> A list of intersecting objects

requestSpatials (geoRect, zoomLevel, visiblesOnly, cacheOnly)Array.<!H.map.Spatial> inherited

This method retrieves all polyline, polygon, circle and rectangle objects which intersect with the provided area.

Returns:
Type Description
Array.<!H.map.Spatial> A list of intersecting objects

setDataPoints (dataPoints)

This method sets a new data on the provider class.

Name Type Description
dataPoints Array.<!H.clustering.DataPoint>

A set of data points

setStyleInternal (style, opt_suppressChangeEvent) inherited

This method sets the style to be used to render the provider data.

Name Type Description
style H.map.render.Style.<!Object>

The style to use for rendering the provider data.
opt_suppressChangeEvent boolean optional

Flag to suppress firing of config change event.

setTheme (theme)

This method sets new theme on the provider. Note that this method changes the visual representation of the displayed clusters and noise points.

Name Type Description
theme H.clustering.ITheme

An object representing the theme to set

Type Definitions

H.clustering.Provider.ClusteringOptions Object

This type encapsulates configuration (initialization) options which are used in cluster calculations.

Properties:

H.clustering.Provider.GetObjectsWithinOptions Object

This type defines options that can be used for H.map.provider.LocalObjectProvider#getObjectsWithin calls.

Properties:

H.clustering.Provider.Options Object

This type encapsulates configuration (initialization) options the clustering Provider.

Properties:

Events

update inherited

Event fired when this provider's data updates.

Type:
Was this article helpful?
YesNo
TitleResults for “How to create a CRG?”Also Available inAlert