Maplibre GL JS 中文文档Maplibre GL JS 中文文档
介绍
插件
样式规范
API
案例
指南
介绍
插件
样式规范
API
案例
指南
  • 介绍
  • 插件
  • 样式规范
    • 弃用功能
    • 表达式
    • 字形
    • 图层
    • 光照
    • 投影
    • 根属性
    • 天空
    • 数据源
    • 精灵图
    • 状态
    • 地形
    • 过渡
    • 类型
  • API
    • media

      • 为 MapLibre GL JS 做贡献
    • Classes

      • AJAXError
      • Actor
      • AlphaImage
      • AttributionControl
      • BoxZoomHandler
      • CanonicalTileID
      • CanvasSource
      • CircleStyleLayer
      • ClickZoomHandler
      • CooperativeGesturesHandler
      • DEMData
      • Dispatcher
      • DoubleClickZoomHandler
      • DragPanHandler
      • DragRotateHandler
      • EdgeInsets
      • ErrorEvent
      • Event
      • Evented
      • FeatureIndex
      • FullscreenControl
      • GeoJSONFeature
      • GeoJSONSource
      • GlobeControl
      • Hash
      • HeatmapStyleLayer
      • ImageAtlas
      • ImageManager
      • ImageSource
      • KeyboardHandler
      • Layout<Props>
      • LngLat
      • LngLatBounds
      • LogoControl
      • Map
      • MapMouseEvent
      • MapTouchEvent
      • MapWheelEvent
      • Marker
      • MercatorCoordinate
      • NavigationControl
      • OverscaledTileID
      • Popup
      • RGBAImage
      • RasterDEMTileSource
      • RasterTileSource
      • ScaleControl
      • ScrollZoomHandler
      • Style
      • abstract StyleLayer
      • SubdivisionGranularityExpression
      • SubdivisionGranularitySetting
      • TapDragZoomHandler
      • TapZoomHandler
      • TerrainControl
      • ThrottledInvoker
      • Tile
      • TouchPanHandler
      • 抽象 TwoFingersTouchHandler
      • TwoFingersTouchPitchHandler
      • TwoFingersTouchRotateHandler
      • TwoFingersTouchZoomHandler
      • TwoFingersTouchZoomRotateHandler
      • VectorTileSource
      • VideoSource
      • WorkerPool
    • Enumerations

      • MessageType
      • ResourceType
      • TextFit
    • Functions

      • addProtocol()
      • addSourceType()
      • clearPrewarmedResources()
      • createTileMesh()
      • getMaxParallelImageRequests()
      • getRTLTextPluginStatus()
      • getVersion()
      • getWorkerCount()
      • getWorkerUrl()
      • importScriptInWorkers()
      • prewarm()
      • removeProtocol()
      • setMaxParallelImageRequests()
      • setWorkerCount()
      • setWorkerUrl()
    • Interfaces

      • ActorTarget
      • AttributeBinder
      • Bucket
      • CustomLayerInterface
      • Handler
      • IActor
      • IControl
      • MousePanHandler
      • MousePitchHandler
      • MouseRollHandler
      • MouseRotateHandler
      • Projection
      • Source
      • StyleImageInterface
      • Subscription
    • Type aliases

      • ActorMessage<T>
      • AddLayerObject
      • AddProtocolAction
      • Alignment
      • AnimationOptions
      • AroundCenterOptions
      • AttributionControlOptions
      • CalculateTileZoomFunction
      • CameraForBoundsOptions
      • CameraOptions
      • CameraUpdateTransformFunction()
      • CanvasSourceSpecification
      • CenterZoomBearing
      • CircleGranularity
      • ClusterIDAndSource
      • Complete<T>
      • Config
      • ControlPosition
      • Coordinates
      • CreateTileMeshOptions
      • CrossFaded<T>
      • CustomRenderMethod()
      • CustomRenderMethodInput
      • DEMEncoding
      • DashEntry
      • DistributiveKeys<T>
      • DistributiveOmit<T, K>
      • DragPanOptions
      • DragRotateHandlerOptions
      • EaseToOptions
      • ExpiryData
      • FeatureIdentifier
      • FitBoundsOptions
      • FlyToOptions
      • FullscreenControlOptions
      • GeoJSONFeatureDiff
      • GeoJSONFeatureId
      • GeoJSONSourceDiff
      • GeoJSONSourceOptions
      • GeoJSONWorkerOptions
      • GeoJSONWorkerSourceLoadDataResult
      • GeolocateControlOptions
      • GestureOptions
      • GetClusterLeavesParams
      • GetGlyphsParameters
      • GetGlyphsResponse
      • GetImagesParameters
      • GetImagesResponse
      • GetResourceResponse<T>
      • GlyphPosition
      • GlyphMetrics
      • GridKey
      • HandlerResult
      • IndicesType
      • JumpToOptions
      • Listener()
      • LngLatBoundsLike
      • LngLatLike
      • LoadGeoJSONParameters
      • LogoControlOptions
      • MapContextEvent
      • MapDataEvent
      • MapEventType
      • MapGeoJSONFeature
      • MapLayerEventType
      • MapLayerMouseEvent
      • MapLayerTouchEvent
      • MapLibreEvent
      • MapLibreZoomEvent
      • MapOptions
      • MapProjectionEvent
      • MapSourceDataType
      • MapSourceDataEvent
      • MapStyleDataEvent
      • MapStyleImageMissingEvent
      • MapTerrainEvent
      • MarkerOptions
      • MessageData
      • NavigationControlOptions
      • /api/type-aliases/Offset.html
      • OverlapMode
      • PaddingOptions
      • PluginState
      • PointLike
      • PointProjection
      • PopupOptions
      • PositionAnchor
      • PossiblyEvaluatedValue<T>
      • ProjectionData
      • ProjectionDataParams
      • QueryRenderedFeaturesOptions
      • QuerySourceFeatureOptions
      • RTLPluginStatus
      • Rect
      • RemoveSourceParams
      • RequestParameters
      • RequestResponseMessageMap
      • RequestTransformFunction()
      • RequireAtLeastOne<T>
      • ScaleControlOptions
      • Serialized
      • SerializedObject<S>
      • SerializedStructArray
      • SetClusterOptions
      • SourceClass()
      • SpriteOnDemandStyleImage
      • StyleGlyph
      • StyleImage
      • StyleImageData
      • StyleImageMetadata
      • StyleOptions
      • StyleSetterOptions
      • StyleSwapOptions
      • SymbolQuad
      • TileMesh
      • TileParameters
      • TileState
      • TransformStyleFunction()
      • Unit
      • UpdateImageOptions
      • UpdateLayersParamaeters
      • WorkerDEMTileParameters
      • WorkerTileParameters
      • WorkerTileResult
  • 案例
    • 3D建筑显示
    • 3D室内地图多边形挤出
    • 3D地形
    • 使用babylon.js添加3D模型
    • 使用three.js添加带阴影的3D模型
    • 在地形上使用three.js添加3D模型
    • 使用three.js添加3D模型
    • 添加默认标记
    • 添加云优化地理TIFF (COG)
    • 使用REST API添加DeckGL图层
    • 添加动画图像
    • 添加生成的图像
    • 动态生成并添加缺失图标到地图
    • 向地图添加可拉伸图片
    • 向地图添加图标
    • 动画线条
    • 绕点相机动画
    • 图像序列动画
    • 标记动画
    • 点动画
    • 沿路径点动画
    • 符号跟随鼠标动画
    • 更改版权信息位置
    • 自定义相机动画
    • 添加Canvas数据源
    • 使地图在点击符号时居中
    • 设置地面以上的中心点
    • 根据缩放级别更改建筑物颜色
    • 更改标签大小写
    • 检查是否支持WebGL
    • 使用自定义属性显示HTML集群
    • 创建和样式化集群
    • 使用按钮更改图层颜色
    • 添加等高线
    • 合作手势
    • 使用自定义标记图标
    • 添加自定义样式图层
    • 使用数据驱动属性设置线条样式
    • 禁用地图旋转
    • 禁用滚动缩放
    • 显示和样式丰富文本标签
    • 创建可拖动标记
    • 创建可拖动点
    • 绘制一个圆形
    • 使用备用图像
    • 使用addProtocol转换特性属性
    • 向多边形添加图案
    • 通过文本输入过滤符号
    • 通过切换列表过滤符号
    • 在图层内过滤
    • 将地图适配到边界框
    • 缓慢飞行到位置
    • 飞行到位置
    • 查看全屏地图
    • 使用游戏控制导航地图
    • 在标签下方添加新图层
    • 添加GeoJSON线条
    • 添加自定义标记
    • 添加GeoJSON多边形
    • 在地球仪上加载3D模型
    • 地球仪大气层
    • 简单自定义地球仪
    • 自定义瓦片地球仪
    • 在地球仪上显示填充挤出层
    • 使用矢量地图显示地球仪
    • 地球仪上缩放和行星大小的关系
    • 哈希路由
    • 地球仪上带地形高程的热力图
    • 创建热力图图层
    • 添加多方向山体阴影图层
    • 添加山体阴影图层
    • 创建悬停效果
    • 显示带地形高程的混合卫星地图
    • 显示非交互式地图
    • 跳转到一系列位置
    • 切换地图语言
    • 显示跨越180度子午线的线条
    • 使用表达式创建渐变线条
    • 添加实时数据
    • 实时更新地图要素
    • 查看本地GeoJSON文件(实验性)
    • 查看本地GeoJSON文件
    • 使用本地生成的表意文字
    • 定位用户位置
    • 细节层次控制
    • 添加栅格瓦片源
    • 使用Mapbox GL Draw绘制多边形
    • 支持从右到左文本
    • 使用 Terra-Draw 绘制几何图形
    • 测量距离
    • 获取鼠标指针坐标
    • 从单个GeoJSON源添加多个几何图形
    • 显示地图导航控件
    • 使用内边距偏移消失点
    • PMTiles 源和协议
    • 点击多边形显示信息
    • 点击显示弹出窗口
    • 悬停显示弹出窗口
    • 显示弹出窗口
    • 获取鼠标指针下的要素
    • 渲染世界副本
    • 限制地图平移到某个区域
    • 显示卫星地图
    • 基于滚动位置飞行到特定位置
    • 设置俯仰角和方位角
    • 为标记添加弹出窗口
    • 显示一个地图
    • 天空、雾和地形
    • 同步多个地图的移动
    • 创建时间轴滑块
    • 切换deck.gl图层
    • 切换交互功能
    • 可变标签放置
    • 可变偏移标签放置
    • 添加矢量瓦片源
    • 在地图上播放视频
    • 可视化人口密度
    • 添加WMS服务
    • 缩放至线要素
  • 指南
    • 优化MapLibre性能: 大型GeoJSON数据集的技巧
    • Leaflet迁移指南
    • Mapbox迁移指南
    • OpenLayers迁移指南

MapEventType

MapEventType = object

定义于: src/ui/events.ts:149

MapEventType - 事件名称和事件值之间的映射。这些事件与Map#on方法一起使用。当使用layerId与Map#on方法时,请参考MapLayerEventType。以下示例可用于所有事件。

示例

// 初始化地图
let map = new Map({ // 地图选项 });
// 设置事件监听器
map.on('the-event-name', () => {
  console.log('事件已发生!');
});

属性

boxzoomcancel

boxzoomcancel: MapLibreZoomEvent

定义于: src/ui/events.ts:251

当用户取消"框选缩放"交互,或边界框不满足最小尺寸阈值时触发。参见BoxZoomHandler。


boxzoomend

boxzoomend: MapLibreZoomEvent

定义于: src/ui/events.ts:259

当"框选缩放"交互结束时触发。参见BoxZoomHandler。


boxzoomstart

boxzoomstart: MapLibreZoomEvent

定义于: src/ui/events.ts:255

当"框选缩放"交互开始时触发。参见BoxZoomHandler。


click

click: MapMouseEvent

定义于: src/ui/events.ts:285

当指向设备(通常是鼠标)在地图上同一点按下并释放时触发。

参见

  • 测量距离
  • 将地图居中于被点击的符号

contextmenu

contextmenu: MapMouseEvent

定义于: src/ui/events.ts:289

当在地图内单击鼠标右键或按下上下文菜单键时触发。


data

data: MapDataEvent

定义于: src/ui/events.ts:311

当地图数据加载完成或更改时触发(由Map#setStyle、Source#setData、addSource、removeSource、addLayer、removeLayer、addImage、removeImage、addSpriteImage、removeSpriteImage引起);


dataloading

dataloading: MapDataEvent

定义于: src/ui/events.ts:316

当地图开始加载数据时触发(由Map#setStyle、Source#setData、addSource、removeSource、addLayer、removeLayer、addImage、removeImage引起);


dblclick

dblclick: MapMouseEvent

定义于: src/ui/events.ts:231

当用户双击地图时触发;


drag

drag: MapLibreEvent<MouseEvent | TouchEvent | undefined>

定义于: src/ui/events.ts:130

在拖动交互期间重复触发;


dragend

dragend: MapLibreEvent<MouseEvent | TouchEvent | undefined>

定义于: src/ui/events.ts:135

当拖动交互结束时触发;


dragstart

dragstart: MapLibreEvent<MouseEvent | TouchEvent | undefined>

定义于: src/ui/events.ts:125

当拖动交互开始时触发;


error

error: ErrorEvent

定义于: src/ui/events.ts:321

当地图遇到错误时触发;


idle

idle: MapLibreEvent<undefined>

定义于: src/ui/events.ts:326

当地图完全加载初始样式且所有图块已完成加载时触发,或者当地图已完成到新样式的过渡;在"moveend"事件之后触发;


load

load: MapLibreEvent

定义于: src/ui/events.ts:165

在所有必要资源下载完毕并且地图首次视觉完整渲染后立即触发。

参见

  • 绘制GeoJSON点
  • 添加实时数据
  • 动画点

mousedown

mousedown: MapMouseEvent

定义于: src/ui/events.ts:255

当鼠标按钮在地图内按下时触发;


mousemove

mousemove: MapMouseEvent

定义于: src/ui/events.ts:260

当鼠标在地图内移动时触发;


mouseout

mouseout: MapMouseEvent

定义于: src/ui/events.ts:270

当鼠标离开地图画布时触发;


mouseover

mouseover: MapMouseEvent

定义于: src/ui/events.ts:265

当鼠标进入地图画布时触发;


mouseup

mouseup: MapMouseEvent

定义于: src/ui/events.ts:275

当鼠标按钮在地图内释放时触发;


move

move: MapLibreEvent<MouseEvent | TouchEvent | WheelEvent | undefined>

定义于: src/ui/events.ts:343

在从一个视图到另一个视图的动画过渡期间重复触发,可能是由用户交互或Map#flyTo等方法引起的。

参见

显示HTML集群及其自定义属性


moveend

moveend: MapLibreEvent<MouseEvent | TouchEvent | WheelEvent | undefined>

定义于: src/ui/events.ts:185

当地图移动结束时触发,作为用户交互或方法(如Map#flyTo或Map#easeTo)的结果;


movestart

movestart: MapLibreEvent<MouseEvent | TouchEvent | WheelEvent | undefined>

定义于: src/ui/events.ts:175

当地图开始移动时触发,作为用户交互或方法(如Map#flyTo或Map#easeTo)的结果;


pitch

pitch: MapLibreEvent<MouseEvent | TouchEvent | undefined>

定义于: src/ui/events.ts:155

当地图俯仰角度发生变化时重复触发,作为用户交互或方法的结果;


pitchend

pitchend: MapLibreEvent<MouseEvent | TouchEvent | undefined>

定义于: src/ui/events.ts:160

当地图俯仰角度变化完成时触发,作为用户交互或方法的结果;


pitchstart

pitchstart: MapLibreEvent<MouseEvent | TouchEvent | undefined>

定义于: src/ui/events.ts:150

当地图俯仰角度开始变化时触发,作为用户交互或方法的结果;


projectionchange

projectionchange: MapProjectionEvent

定义于: src/ui/events.ts:211

当地图投影更改时触发,通过Map#setProjection方法;

参见

在球体上显示带有向量地图的球体


remove

remove: MapLibreEvent<undefined>

定义于: src/ui/events.ts:331

当地图被销毁时触发;


render

render: MapLibreEvent<undefined>

定义于: src/ui/events.ts:336

在地图渲染新帧后触发;这是经常触发的事件;性能敏感的代码可能需要节流此事件;


resize

resize: MapLibreEvent<undefined>

定义于: src/ui/events.ts:341

当地图大小发生变化时触发,作为resize操作的结果;


rotate

rotate: MapLibreEvent<MouseEvent | TouchEvent | undefined>

定义于: src/ui/events.ts:105

当地图旋转时重复触发,作为用户交互或方法(如Map#flyTo或Map#easeTo)的结果;


rotateend

rotateend: MapLibreEvent<MouseEvent | TouchEvent | undefined>

定义于: src/ui/events.ts:110

当地图旋转完成时触发,作为用户交互或方法(如Map#flyTo或Map#easeTo)的结果;


rotatestart

rotatestart: MapLibreEvent<MouseEvent | TouchEvent | undefined>

定义于: src/ui/events.ts:100

当地图开始旋转时触发,作为用户交互或方法(如Map#flyTo或Map#easeTo)的结果;


sourcedata

sourcedata: MapSourceDataEvent

定义于: src/ui/events.ts:296

当源中的一个图块加载完成或发生错误时触发;此事件的属性"tile"提供了相关图块信息;


sourcedataloading

sourcedataloading: MapSourceDataEvent

定义于: src/ui/events.ts:301

当源中的一个图块开始加载时触发;


styledata

styledata: MapStyleDataEvent

定义于: src/ui/events.ts:286

当地图的样式加载完成或更改时触发(由Map#setStyle方法引起);


styledataloading

styledataloading: MapStyleDataEvent

定义于: src/ui/events.ts:291

当地图样式开始加载时触发(由Map#setStyle方法引起);


styleimagemissing

styleimagemissing: MapStyleImageMissingEvent

定义于: src/ui/events.ts:351

当地图需要但找不到已注册的图像时触发;监听此事件提供了一种创建缺少图像的方法;如果监听器没有添加缺少的图像,则不会渲染图层需要该图像的元素;

参见

将生成的图标添加到地图


terrain

terrain: MapTerrainEvent

定义于: src/ui/events.ts:416

当地形的一个图块加载完成或发生错误时触发;此事件的属性"tile"提供了相关图块信息;


terrainloading

terrainloading: MapTerrainEvent

定义于: src/ui/events.ts:421

当地形的一个图块开始加载时触发;


touchcancel

touchcancel: MapTouchEvent

定义于: src/ui/events.ts:247

当触摸事件被取消时触发;


touchend

touchend: MapTouchEvent

定义于: src/ui/events.ts:242

当触摸事件结束时触发;


touchmove

touchmove: MapTouchEvent

定义于: src/ui/events.ts:216

当触摸移动时触发;


touchstart

touchstart: MapTouchEvent

定义于: src/ui/events.ts:222

当地图内发生触摸开始事件时触发;

参见

创建可拖动点


webglcontextlost

webglcontextlost: MapContextEvent

定义于: src/ui/events.ts:195

当WebGL上下文丢失时触发;


webglcontextrestored

webglcontextrestored: MapContextEvent

定义于: src/ui/events.ts:199

当WebGL上下文恢复时触发;


wheel

wheel: MapWheelEvent

定义于: src/ui/events.ts:410

当地图内发生滚轮事件时触发;


zoom

zoom: MapLibreEvent<MouseEvent | TouchEvent | WheelEvent | undefined>

定义于: src/ui/events.ts:360

在从一个缩放级别到另一个缩放级别的动画过渡期间重复触发,可能是由用户交互或Map#flyTo等方法引起的。

Prev
MapDataEvent
Next
MapGeoJSONFeature