Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ClusterTileLayerOptions

Options for configuring a ClusterTileLayer.

Hierarchy

Index

Properties

Optional aggregateProperties

aggregateProperties: (clusterProperties: ClusterFeatureProperties, featureProperties: {}, operation: "add" | "remove") => void

Use this function to aggregate cluster properties whenever a feature is being added or removed to the cluster.

param

The properties of the cluster.

param

The properties of the feature being added or removed.

param

The operation being performed ('add' or 'remove').

Type declaration

    • Parameters

      Returns void

Optional clusterMaxZoom

clusterMaxZoom: number

Specifies the maximum zoom level at which data should be clustered. If not defined, it defaults to zoom level 13. When the map zoom level exceeds the clusterMaxZoom, raw data features will be displayed instead of clusters.

defaultvalue

13

Optional clusterRadius

clusterRadius: number

Defines the radius, in pixels, within which features should be clustered. The default value is 32 pixels.

defaultvalue

32

Optional createProperties

createProperties: (feature: {}) => ClusterFeatureProperties

This function generates the initial properties of a cluster. Please note that defined Properties in ClusterFeatureProperties are considered as readonly and are not allowed to be set. If the function is not defined, the default implementation returns an empty object.

Type declaration

Optional margin

margin: number

tileMargin that should be applied to all providers of the layer.

Optional max

max: number

The maximum zoom level at which data from the TileLayer will be displayed.

Optional min

min: number

minimum zoom level at which data from the TileLayer will be displayed.

Optional name

name: string

Name of the TileLayer.

Optional pointerEvents

pointerEvents: boolean

Determines whether pointer events are enabled for all features of the layer.

defaultvalue

false

provider

provider: FeatureProvider

The data provider supplying the data to be clustered.

Optional style

style: LayerStyle

Style for rendering features in this layer.

Optional tileSize

tileSize: number

the size of the tile data in pixel.

defaultvalue

512

Optional visible

visible: boolean

Indicates whether the layer should be visible (true) or hidden (false).

defaultvalue

true

Generated using TypeDoc