BaseLayer

BaseLayer 是一个基础组件，用于定义图层。

• 配置文档

API

layerProps

属性名	说明	类型	默认值
visible	图层可见性	boolean	true
opacity	图层透明度	number	1
order	图层顺序	number	1
minzoom	图层最小缩放级别	number	0
maxzoom	图层最大缩放级别	number	22
sourceLayer	矢量切片源使用的图层	string	-
filter	图层过滤器	array	-
slot	图层槽位	string	-
metadata	图层任意属性	object	-
cursor	图层移入时鼠标样式	string	pointer

baseLayerProps

属性名	说明	类型	默认值
继承自	layerProps	-	-
type	图层类型	string	必填
id	图层 ID	string	-
layout	图层布局属性	object	-
paint	图层绘制属性	object	-
paintOpacity	paint包含透明度的属性	array	-
shouldRemoveVisibility	是否移除可见性	boolean	false
customOptions	自定义图层配置	Object	-

baseLayerEmits

事件名	说明	回调参数
load	图层加载完成时触发	Function
mousedown	鼠标按下时触发	Function
mouseup	鼠标抬起时触发	Function
mouseover	鼠标悬停时触发	Function
mousemove	鼠标移动时触发	Function
preclick	鼠标单击前触发	Function
click	鼠标单击时触发	Function
dblclick	鼠标双击时触发	Function
mouseenter	鼠标进入时触发	Function
mouseleave	鼠标离开时触发	Function
mouseout	鼠标移出时触发	Function

Inject

hooks/symbol.ts

export const layerKey: InjectionKey<ShallowRef<LayerSpecification | undefined>> = Symbol('Layer')

hooks/useLayer.ts

export function useLayer<P extends LayerSpecification>() {
  const layer = inject(layerKey)
  if (!layer) {
    consola.error('Layer instance is not available.')
  }
  return unref(layer) as P
}

类型定义

LyerLoadEvent

layers/BaseLayer/BaseLayer.ts

export interface LyerLoadEvent {
  layer: any
  source: any
  map: Map
}

LayerExcludeProps

layers/BaseLayer/BaseLayer.ts

export type LayerExcludeProps<T> = Omit<
  Partial<LayerProps> & T,
  'id' | 'type' | 'source' | 'source-layer'
>

MetadataKey

layers/BaseLayer/BaseLayer.ts

type MetadataKey = `mapbox:${string}` | `custom:${string}`