worldwind-ui API / react-worldwind / ClusterLayerProps

Interface: ClusterLayerProps<T>

Defined in: react/src/ClusterLayer.tsx:8

Extends

• Omit<ClusterLayerOptions<T>, "layer" | "layerName">.LayerOptions

Type Parameters

T

T

Properties

attribution?

optional attribution?: string | LayerAttribution | null

Defined in: kit/src/layers.ts:86

Credit for the layer's data; null suppresses the default of a built-in layer.

Inherited from

LayerOptions.attribution

---

color?

optional color?: string

Defined in: kit/src/cluster.ts:122

Colour of the default cluster marker.

Inherited from

Omit.color

---

displayName?

optional displayName?: string

Defined in: kit/src/layers.ts:78

Inherited from

LayerOptions.displayName

---

enabled?

optional enabled?: boolean

Defined in: kit/src/layers.ts:79

Inherited from

LayerOptions.enabled

---

getPosition?

optional getPosition?: (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

LatLon

Inherited from

Omit.getPosition

---

items

items: readonly T[]

Defined in: react/src/ClusterLayer.tsx:9

---

legend?

optional legend?: string | LayerLegend | null

Defined in: kit/src/layers.ts:88

Legend image URL or descriptor.

Inherited from

LayerOptions.legend

---

maxActiveAltitude?

optional maxActiveAltitude?: number

Defined in: kit/src/layers.ts:84

Inherited from

LayerOptions.maxActiveAltitude

---

minActiveAltitude?

optional minActiveAltitude?: number

Defined in: kit/src/layers.ts:83

Inherited from

LayerOptions.minActiveAltitude

---

minPoints?

optional minPoints?: number

Defined in: kit/src/cluster.ts:22

Fewest items that form a cluster; cells with fewer are drawn individually. Default 2.

Inherited from

ClusterLayerOptions.minPoints

---

name?

optional name?: string

Defined in: react/src/ClusterLayer.tsx:11

Shown in layer switchers. Default Clusters.

---

onClusterClick?

optional onClusterClick?: (cluster, event) => void

Defined in: react/src/ClusterLayer.tsx:12

Parameters

cluster

Cluster<T>

event

PickEvent

Returns

void

---

onItemClick?

optional onItemClick?: (item, event) => void

Defined in: react/src/ClusterLayer.tsx:13

Parameters

item

T

event

PickEvent

Returns

void

---

opacity?

optional opacity?: number

Defined in: kit/src/layers.ts:81

0..1

Inherited from

LayerOptions.opacity

---

pickEnabled?

optional pickEnabled?: boolean

Defined in: kit/src/layers.ts:82

Inherited from

LayerOptions.pickEnabled

---

radius?

optional radius?: number

Defined in: kit/src/cluster.ts:116

Marker radius in CSS pixels: items closer than this merge. Default 60.

Inherited from

Omit.radius

---

renderCluster?

optional renderCluster?: (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

WorldWindStatic

Returns

WWRenderable

Inherited from

Omit.renderCluster

---

renderItem?

optional renderItem?: (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

WorldWindStatic

Returns

WWRenderable

Inherited from

Omit.renderItem

---

textColor?

optional textColor?: string

Defined in: kit/src/cluster.ts:123

Inherited from

Omit.textColor

---

throttle?

optional throttle?: number

Defined in: kit/src/cluster.ts:127

Milliseconds between re-clusterings while the zoom keeps changing. Default 100.

Inherited from

Omit.throttle

---

timeDimension?

optional timeDimension?: TimeDimension | null

Defined in: kit/src/layers.ts:90

The instants the layer can show, for time sliders. Read from capabilities when available.

Inherited from

LayerOptions.timeDimension

---

zoomOnClick?

optional zoomOnClick?: boolean

Defined in: kit/src/cluster.ts:125

Fly closer to a cluster when it is clicked. Default true.

Inherited from

Omit.zoomOnClick