Class ClusteredVectorLayer

public shape of the accessors this class declares itself

Hierarchy (View Summary)

BaseVectorLayer<any, ClusteredVectorLayerLayerOptions>
Omit<
    Accessors,
    "animatedClusters"
    | "maximumClusterZoom"
    | "minimumClusterDistance",
>
Omit<Methods, "expandCluster">
Accessors
Methods
Accessors
Omit<Methods, "isUpdateInProgress" | "refresh">
- ClusteredVectorLayer

Index

Constructors

Properties

animatedClusters? duringInit maximumClusterZoom? maxVisibleZoom? metaData minimumClusterDistance? minVisibleZoom? native opacity options postProcessed updatePriority vectorElementEventListener visible visibleZoomRange zBuffering

Constructors

constructor

new ClusteredVectorLayer(
options: ClusteredVectorLayerLayerOptions,
): ClusteredVectorLayer
Parameters
- options: ClusteredVectorLayerLayerOptions
Returns ClusteredVectorLayer
Inherited from BaseVectorLayer.constructor
- Defined in packages/ui-massifmaps/layers/index.d.ts:17

Properties

`Optional`animatedClusters

animatedClusters?: boolean

duringInit

duringInit: boolean

`Optional`maximumClusterZoom

maximumClusterZoom?: number

`Optional`maxVisibleZoom

maxVisibleZoom?: number

metaData

metaData: any

`Optional`minimumClusterDistance

minimumClusterDistance?: number

`Optional`minVisibleZoom

minVisibleZoom?: number

native

native: any

opacity

opacity: number

options

options: ClusteredVectorLayerLayerOptions

postProcessed

postProcessed: boolean

updatePriority

updatePriority: number

vectorElementEventListener

vectorElementEventListener: any

visible

visible: boolean

visibleZoomRange

visibleZoomRange: [number, number]

zBuffering

zBuffering: boolean

Methods

containsMetaDataKey

containsMetaDataKey(arg0: string): boolean
Parameters
- arg0: string
Returns boolean
Inherited from Methods.containsMetaDataKey
- Defined in packages/ui-massifmaps/bindings/layers/Layer.d.ts:6

dispose

dispose(): any
Returns any
Inherited from BaseVectorLayer.dispose
- Defined in packages/ui-massifmaps/index.d.ts:21

expandCluster

expandCluster(element: VectorElement<any, any>, px: number): any
Parameters
- element: VectorElement<any, any>
- px: number
Returns any
- Defined in packages/ui-massifmaps/layers/vector.d.ts:205

getClusterElementBuilder

getClusterElementBuilder(): any
Returns any
- Defined in packages/ui-massifmaps/bindings/layers/ClusteredVectorLayer.d.ts:6

getDataSource

getDataSource(): any
Returns any
Inherited from Methods.getDataSource
- Defined in packages/ui-massifmaps/bindings/layers/VectorLayer.d.ts:5

getMaximumClusterZoom

getMaximumClusterZoom(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/layers/ClusteredVectorLayer.d.ts:7

getMetaData

getMetaData(): any
Returns any
Inherited from Methods.getMetaData
- Defined in packages/ui-massifmaps/bindings/layers/Layer.d.ts:7

getMetaDataElement

getMetaDataElement(arg0: string): any
Parameters
- arg0: string
Returns any
Inherited from Methods.getMetaDataElement
- Defined in packages/ui-massifmaps/bindings/layers/Layer.d.ts:8

getMinimumClusterDistance

getMinimumClusterDistance(): number
Returns number
- Defined in packages/ui-massifmaps/bindings/layers/ClusteredVectorLayer.d.ts:8

getNative

getNative(): any
Returns any
Inherited from BaseVectorLayer.getNative
- Defined in packages/ui-massifmaps/index.d.ts:20

getOpacity

getOpacity(): number
Returns number
Inherited from Methods.getOpacity
- Defined in packages/ui-massifmaps/bindings/layers/Layer.d.ts:9

getUpdatePriority

getUpdatePriority(): number
Returns number
Inherited from Methods.getUpdatePriority
- Defined in packages/ui-massifmaps/bindings/layers/Layer.d.ts:10

getVectorElementEventListener

getVectorElementEventListener(): any
Returns any
Inherited from Methods.getVectorElementEventListener
- Defined in packages/ui-massifmaps/bindings/layers/VectorLayer.d.ts:6

getVisibleZoomRange

getVisibleZoomRange(): MapRange
Returns MapRange
Inherited from Methods.getVisibleZoomRange
- Defined in packages/ui-massifmaps/bindings/layers/Layer.d.ts:11

initNativeView

initNativeView(native: any, options: ClusteredVectorLayerLayerOptions): void
Parameters
- native: any
- options: ClusteredVectorLayerLayerOptions
Returns void
Inherited from BaseVectorLayer.initNativeView
- Defined in packages/ui-massifmaps/index.d.ts:19

isAnimatedClusters

isAnimatedClusters(): boolean
Returns boolean
- Defined in packages/ui-massifmaps/bindings/layers/ClusteredVectorLayer.d.ts:9

isPostProcessed

isPostProcessed(): boolean
Returns boolean
Inherited from Methods.isPostProcessed
- Defined in packages/ui-massifmaps/bindings/layers/Layer.d.ts:12

isUpdateInProgress

isUpdateInProgress(): boolean
Returns boolean
Inherited from Methods.isUpdateInProgress
- Defined in packages/ui-massifmaps/bindings/layers/Layer.d.ts:13

isVisible

isVisible(): boolean
Returns boolean
Inherited from Methods.isVisible
- Defined in packages/ui-massifmaps/bindings/layers/Layer.d.ts:14

isZBuffering

isZBuffering(): boolean
Returns boolean
Inherited from Methods.isZBuffering
- Defined in packages/ui-massifmaps/bindings/layers/VectorLayer.d.ts:8

refresh

refresh(): any
Returns any
Inherited from BaseVectorLayer.refresh
- Defined in packages/ui-massifmaps/layers/index.d.ts:18

setAnimatedClusters

setAnimatedClusters(arg0: boolean): void
Parameters
- arg0: boolean
Returns void
- Defined in packages/ui-massifmaps/bindings/layers/ClusteredVectorLayer.d.ts:11

setCullDelay

setCullDelay(arg0: number): void
Parameters
- arg0: number
Returns void
Inherited from Methods.setCullDelay
- Defined in packages/ui-massifmaps/bindings/layers/Layer.d.ts:16

setMaximumClusterZoom

setMaximumClusterZoom(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/layers/ClusteredVectorLayer.d.ts:12

setMetaData

setMetaData(arg0: any): void
Parameters
- arg0: any
Returns void
Inherited from Methods.setMetaData
- Defined in packages/ui-massifmaps/bindings/layers/Layer.d.ts:17

setMetaDataElement

setMetaDataElement(arg0: string, arg1: any): void
Parameters
- arg0: string
- arg1: any
Returns void
Inherited from Methods.setMetaDataElement
- Defined in packages/ui-massifmaps/bindings/layers/Layer.d.ts:18

setMinimumClusterDistance

setMinimumClusterDistance(arg0: number): void
Parameters
- arg0: number
Returns void
- Defined in packages/ui-massifmaps/bindings/layers/ClusteredVectorLayer.d.ts:13

setOpacity

setOpacity(arg0: number): void
Parameters
- arg0: number
Returns void
Inherited from Methods.setOpacity
- Defined in packages/ui-massifmaps/bindings/layers/Layer.d.ts:19

setPostProcessed

setPostProcessed(arg0: boolean): void
Parameters
- arg0: boolean
Returns void
Inherited from Methods.setPostProcessed
- Defined in packages/ui-massifmaps/bindings/layers/Layer.d.ts:20

setUpdatePriority

setUpdatePriority(arg0: number): void
Parameters
- arg0: number
Returns void
Inherited from Methods.setUpdatePriority
- Defined in packages/ui-massifmaps/bindings/layers/Layer.d.ts:21

setVectorElementEventListener

setVectorElementEventListener<T = DefaultLatLonKeys>(
    listener: VectorElementEventListener<T>,
    projection?: Projection,
    nativeClass?: any,
): void
Type Parameters
- T = DefaultLatLonKeys
Parameters
- listener: VectorElementEventListener<T>
- Optionalprojection: Projection
- OptionalnativeClass: any
Returns void
Inherited from BaseVectorLayer.setVectorElementEventListener
- Defined in packages/ui-massifmaps/layers/vector.d.ts:194

setVisible

setVisible(arg0: boolean): void
Parameters
- arg0: boolean
Returns void
Inherited from Methods.setVisible
- Defined in packages/ui-massifmaps/bindings/layers/Layer.d.ts:22

setVisibleZoomRange

setVisibleZoomRange(arg0: MapRange): void
Parameters
- arg0: MapRange
Returns void
Inherited from Methods.setVisibleZoomRange
- Defined in packages/ui-massifmaps/bindings/layers/Layer.d.ts:23

setZBuffering

setZBuffering(arg0: boolean): void
Parameters
- arg0: boolean
Returns void
Inherited from Methods.setZBuffering
- Defined in packages/ui-massifmaps/bindings/layers/VectorLayer.d.ts:10

simulateClick

simulateClick(arg0: ClickType, arg1: any, arg2: any): void
Parameters
- arg0: ClickType
- arg1: any
- arg2: any
Returns void
Inherited from Methods.simulateClick
- Defined in packages/ui-massifmaps/bindings/layers/Layer.d.ts:24

update

update(arg0: any): void
Parameters
- arg0: any
Returns void
Inherited from Methods.update
- Defined in packages/ui-massifmaps/bindings/layers/Layer.d.ts:25

Class ClusteredVectorLayer

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ClusteredVectorLayer

Properties

OptionalanimatedClusters

duringInit

OptionalmaximumClusterZoom

OptionalmaxVisibleZoom

metaData

OptionalminimumClusterDistance

OptionalminVisibleZoom

native

opacity

options

postProcessed

updatePriority

vectorElementEventListener

visible

visibleZoomRange

zBuffering

Methods

containsMetaDataKey

Parameters

Returns boolean

dispose

Returns any

expandCluster

Parameters

Returns any

getClusterElementBuilder

Returns any

getDataSource

Returns any

getMaximumClusterZoom

Returns number

getMetaData

Returns any

getMetaDataElement

Parameters

Returns any

getMinimumClusterDistance

Returns number

getNative

Returns any

getOpacity

Returns number

getUpdatePriority

Returns number

getVectorElementEventListener

Returns any

getVisibleZoomRange

Returns MapRange

initNativeView

Parameters

Returns void

isAnimatedClusters

Returns boolean

isPostProcessed

Returns boolean

isUpdateInProgress

Returns boolean

isVisible

Returns boolean

isZBuffering

Returns boolean

refresh

Returns any

setAnimatedClusters

Parameters

Returns void

setCullDelay

Parameters

Returns void

`Optional`animatedClusters

`Optional`maximumClusterZoom

`Optional`maxVisibleZoom

`Optional`minimumClusterDistance

`Optional`minVisibleZoom