worldwind-ui API / worldwind-kit / ClusterLayerOptions
Interface: ClusterLayerOptions<T> ​
Defined in: kit/src/cluster.ts:112
Extends ​
Type Parameters ​
T ​
T
Properties ​
color? ​
optionalcolor?:string
Defined in: kit/src/cluster.ts:122
Colour of the default cluster marker.
getPosition? ​
optionalgetPosition?: (item) =>LatLon
Defined in: kit/src/cluster.ts:24
Reads an item's location. Defaults to its latitude and longitude fields.
Parameters ​
item ​
T
Returns ​
Inherited from ​
layer? ​
optionallayer?:LayerOptions
Defined in: kit/src/cluster.ts:129
Options for the layer itself (enabled, opacity, attribution, ...).
layerName? ​
optionallayerName?:string
Defined in: kit/src/cluster.ts:114
Shown in layer switchers. Default Clusters.
minPoints? ​
optionalminPoints?:number
Defined in: kit/src/cluster.ts:22
Fewest items that form a cluster; cells with fewer are drawn individually. Default 2.
Inherited from ​
radius? ​
optionalradius?:number
Defined in: kit/src/cluster.ts:116
Marker radius in CSS pixels: items closer than this merge. Default 60.
renderCluster? ​
optionalrenderCluster?: (cluster,worldWind) =>WWRenderable
Defined in: kit/src/cluster.ts:120
Builds the renderable for a cluster. Defaults to a circle with the count.
Parameters ​
cluster ​
Cluster<T>
worldWind ​
Returns ​
renderItem? ​
optionalrenderItem?: (item,worldWind) =>WWRenderable
Defined in: kit/src/cluster.ts:118
Builds the renderable for an item drawn on its own. Defaults to a small red pushpin.
Parameters ​
item ​
T
worldWind ​
Returns ​
textColor? ​
optionaltextColor?:string
Defined in: kit/src/cluster.ts:123
throttle? ​
optionalthrottle?:number
Defined in: kit/src/cluster.ts:127
Milliseconds between re-clusterings while the zoom keeps changing. Default 100.
zoomOnClick? ​
optionalzoomOnClick?:boolean
Defined in: kit/src/cluster.ts:125
Fly closer to a cluster when it is clicked. Default true.