Class default

This class is a renderer for MapLibre Layer to be able to use the native ol functionalities like map.getFeaturesAtPixel or map.hasFeatureAtPixel.

Hierarchy

LayerRenderer<default>
- default

Index

Constructors

Methods

forEachFeatureAtCoordinate getFeatures getFeaturesAtCoordinate prepareFrame renderFrame

Constructors

constructor

new default(
layer: default,
translateZoom: MapLibreLayerTranslateZoomFunction,
): default
Parameters
- layer: default
- translateZoom: MapLibreLayerTranslateZoomFunction
Returns default
Overrides LayerRenderer<MapLibreLayer>.constructor
- Defined in MapLibreLayerRenderer.ts:34

Methods

`Abstract`forEachFeatureAtCoordinate

forEachFeatureAtCoordinate<Feature>(
    coordinate: Coordinate,
    _frameState: FrameState,
    hitTolerance: number,
    callback: FeatureCallback<Feature>,
): Feature
Type Parameters
- Feature
Parameters
- coordinate: Coordinate
  Coordinate.
- _frameState: FrameState
- hitTolerance: number
  Hit tolerance in pixels.
- callback: FeatureCallback<Feature>
  Feature callback.
Returns Feature
Callback result.
Overrides LayerRenderer.forEachFeatureAtCoordinate
- Defined in MapLibreLayerRenderer.ts:112

getFeatures

getFeatures(pixel: Pixel): Promise<Feature<Geometry>[]>
Asynchronous layer level hit detection.
Parameters
- pixel: Pixel
  Pixel.
Returns Promise<Feature<Geometry>[]>
Promise that resolves with an array of features.
Overrides LayerRenderer.getFeatures
- Defined in MapLibreLayerRenderer.ts:105

getFeaturesAtCoordinate

getFeaturesAtCoordinate(
coordinate: Coordinate,
hitTolerance?: number,
): Feature<Geometry>[]
Parameters
- coordinate: Coordinate
- hitTolerance: number = 5
Returns Feature<Geometry>[]
- Defined in MapLibreLayerRenderer.ts:39

`Abstract`prepareFrame

prepareFrame(): boolean
Determine whether render should be called.

Returns boolean
Layer is ready to be rendered.
Overrides LayerRenderer.prepareFrame
- Defined in MapLibreLayerRenderer.ts:65

`Abstract`renderFrame

renderFrame(frameState: FrameState): HTMLElement
Render the layer.
Parameters
- frameState: FrameState
  Frame state.
Returns HTMLElement
The rendered element.
Overrides LayerRenderer.renderFrame
- Defined in MapLibreLayerRenderer.ts:69