BaseLayer

BaseLayer

基础图层类

注：不可直接实例化，需继承后使用

constructor

构造函数

Parameters

• sourceId string?

addToMap

添加图层到地图

Parameters

• map Map
• before string? 图层插入到某个图层之前， before为图层id

Returns this

removeFromMap

从地图上移除图层

Parameters

• map Map?
• noSource boolean? 是否移除source

Returns this

getLayerId

获取layer id

Returns string

getSourceData

获取source data

Returns GeoJSONSourceRaw

getSourceId

获取source id

Returns string

addFeature

添加元素到图层，如果元素已存在，则不添加

Parameters

• feature BaseFeature

Returns this

addFeatures

添加多个元素到图层

Parameters

• features Array<BaseFeature>

Returns this

setFeatures

重新添加元素列表到图层，会清空原有元素列表

Parameters

• features Array<BaseFeature>

Returns this

getFeatures

获取feature，如果不传featureId，则返回所有feature，否则返回指定feature

Parameters

• featureId string? featureId

Returns (BaseFeature | Array<BaseFeature> | undefined)

clearFeatures

清空元素

Returns this

updateFeature

更新元素

Parameters

• featureId string
• options Partial<xxFeatureOptions>
• immediateRender boolean?

Returns this

removeFeature

移除元素

Parameters

• featureId string
• dontUnbind boolean? 是否不解绑Layer

Returns this

removeFeatures

移除多个元素

Parameters

• featureIds Array<string>
• dontUnbind boolean? 是否不解绑Layer

Returns this

hasFeature

判断是否包含某个元素

Parameters

• featureId string

Returns boolean

scaleWithAnimation

带动画缩放

Parameters

• duration number 动画持续时间，单位毫秒

• options Object? 属性

  • options.cubicBezier Array<number>? 缓动函数，4个参数，分别为控制点1x, 控制点1y, 控制点2x, 控制点2y
  • options.onFinished Function? 动画结束回调
  • options.onProgress Function? 动画过程回调, 参数为动画进度，0-1

• featureIds Array<string>? 指定缩放的元素, 不传则缩放所有元素

Returns this

fitToBounds

将图层视角调整到最佳显示范围

Parameters

• option FitBoundsOptions?

Returns this

getBounds

获取图层最佳显示范围

Returns LngLatBoundsLike

setPaintProperty

设置图层[Paint](/jsapi/apis/types/Types.html#paint)

Parameters

• property string
• value any

Returns this

setLayoutProperty

设置图层[Layout](/jsapi/apis/types/Types.html#layout)

Parameters

• property string
• value any

Returns this

getPaintProperty

获取图层[Paint](/jsapi/apis/types/Types.html#paint)

Parameters

• property string

Returns any

getLayoutProperty

获取图层[Layout](/jsapi/apis/types/Types.html#layout)

Parameters

• property string

Returns any

show

显示图层

Returns this

hide

隐藏图层

Returns this

on

监听鼠标事件

Parameters

• type T
• cb function (ev: LayerMouseEvent<T>, feature: (Array<F> | F)): void
• featureId string?

Returns this

once

监听鼠标事件，只触发一次

Parameters

• type T
• cb function (ev: LayerMouseEvent<T>, feature: (Array<F> | F)): void
• featureId string?

Returns this

off

取消监听鼠标事件

Parameters

• type T
• cb function (ev: LayerMouseEvent<T>): void?

Returns this

isAddedToMap

判断是否已经绘制在地图上

Returns boolean

LayerMouseEvent

图层事件类型

Type: LayerMouseEvent

Examples

type LayerMouseEvent<T extends keyof MapLayerEventType> = MapLayerEventType[T] & EventData