Maps API for JavaScript Developer's Guide

H.clustering.Provider.Options

Type Definition Summary

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

[ For full details, see the Type Definition Details ]

Property Summary

Table 1. Properties
Properties

uri

The provider's unique resource identifier which must not contain an underscore "_". If omitted, an auto-generated unique session ID is used. If a consistent ID across sessions is needed (for example for storing provider data), this property must be specified.

min

The minimum supported zoom level, the default is 0

max

The maximum supported zoom level, the default is 22

pixelRatio

The pixel ratio to use for over-sampling in cases of high-resolution displays

getCopyrights

A function to replace the default implementation of H.map.provider.Provider#getCopyrights

clusteringOptions

Configuration options for clustering algorithm

theme

An object that determines the visual representation for clusters and noise points

Type Definition Description

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

Property Details

uri: {string=} [optional]

The provider's unique resource identifier which must not contain an underscore "_". If omitted, an auto-generated unique session ID is used. If a consistent ID across sessions is needed (for example for storing provider data), this property must be specified.

min: {number=} [optional]

The minimum supported zoom level, the default is 0

max: {number=} [optional]

The maximum supported zoom level, the default is 22

pixelRatio: {number=} [optional]

The pixel ratio to use for over-sampling in cases of high-resolution displays

getCopyrights: {(function(H.geo.Rect, number) : ?Array<H.map.ICopyright>)=} [optional]

A function to replace the default implementation of H.map.provider.Provider#getCopyrights

clusteringOptions: {H.clustering.Provider.ClusteringOptions=} [optional]

Configuration options for clustering algorithm

theme: {H.clustering.ITheme=} [optional]

An object that determines the visual representation for clusters and noise points