Class MapController

Index

Properties

instance baseMap mapClickListener mapViewId filesDir cacheDir densityDPI dpiScale isDestroy

Accessors

mapOptions maxZoom minZoom bmMapCtr

Methods

getInstance alignParameters getMapControlHandle getMapViewCtrlInstance createOverlayLayer addOverlay removeOverlay removeOverlays getOverlayLayer getOverlayLayers getOverlays getOverlaysAll removeOverlayLayer setViewport getViewport fitVisibleMapRect setViewPadding setGeoRoundLimit getZoomUnits getLayerByTag setLocation clearCustomLocation setLocationConfig setLocationInfo pixel2ll pixel2bdll ll2pixel bdll2pixel addEventListener removeEventListener fireMapEvent addOverlayEventListener removeOverlayEventListener fireOverlayEvent setOnTouchMessageListener changeMapStatusReason triggerMapLoadFinish setDEMEnable addTileLayer removeTileLayer switchLayer setMaxZoom setMinZoom zoomTo zoomInOne zoomOutOne getZoom setMapCenter setMapCenterWithOffset getCenter getRotate getPerPixelMc enableGesturesRotate disableGesturesRotate enableGesturesZoom disableGesturesZoom enableGesturesDrag disableGesturesDrag enableGesturesPich disableGesturesPich switchIndoorFloor getIndoorInfo initCustomStyle setMapLanguage getMapLanguage setCustomStylePath setCustomStyleById setCustomStyleEnable showBaseIndoorMap isBaseIndoorMapMode isBaseIndoorMapShow setMapThemeScene getMapThemeScene showTrafficMap switchDayOrDarkTheme setGestureConfig getGestureConfig showLayers showLayersByTag setVirtualPoiShowEnable getVirtualPoiShowEnable setLittle3DEnable setEnableOverLook getSkyOffset getLayerIDByTag set3DModelEnable setHouseHeightEnable setOnBackOrForeground setBaiduHeatMapEnabled addHeatMap startHeatMapFrameAnimation stopHeatMapFrameAnimation setHeatMapFrameAnimationIndex removeHeatMap updateHeatMap addHexagonMap removeHexagonMap customParticleEffectByType closeParticleEffectByType showParticleEffectByType snapshot setMapType setMapClickListener setBgkColor resetBgkColor setForceUseBgkColor onceDraw refresh destroy cleanUp onWillDisappear

Properties

`Static` instance

instance: MapController

baseMap

baseMap: Maybe<BaseMap>

mapClickListener

mapClickListener: null | IMapClickListener = null

`Readonly` mapViewId

mapViewId: string = ''

地图唯一标识

`Readonly` filesDir

filesDir: string = ''

沙盒文件目录

`Readonly` cacheDir

cacheDir: string = ''

沙盒缓存目录

`Readonly` densityDPI

densityDPI: number = 1

设备的像素密度

`Readonly` dpiScale

dpiScale: number = 1

适配比例

isDestroy

isDestroy: boolean = false

Accessors

mapOptions

get mapOptions(): MapOptions
获取地图配置类

Returns MapOptions
Since
1.0.0
set mapOptions(mapOptions): void
设置地图配置类
Parameters
- mapOptions: MapOptions
Returns void
Since
1.0.0

maxZoom

get maxZoom(): number
获取当前地图最大缩放级别

Returns number
Since
1.0.0
set maxZoom(zoom): void
设置地图最大缩放级别
Parameters
- zoom: number
Returns void
Since
1.0.0

minZoom

get minZoom(): number
获取地图最小缩放级别

Returns number
Since
1.0.0
set minZoom(zoom): void
设置地图最小缩放级别
Parameters
- zoom: number
  最小级别，范围3-21
Returns void
Since
1.0.0

bmMapCtr

get bmMapCtr(): Maybe<default>
Returns Maybe<default>

Methods

`Static` getInstance

getInstance(bmController, context): MapController
Parameters
- bmController: default
- context: Context
Returns MapController

alignParameters

alignParameters(): void
Returns void

getMapControlHandle

getMapControlHandle(): undefined | number
Returns undefined | number

getMapViewCtrlInstance

getMapViewCtrlInstance(): undefined | number
Returns undefined | number

createOverlayLayer

createOverlayLayer(belowId?): undefined | OverlayLayer
创建覆盖物图层
Parameters
- belowId: number = 0
Returns undefined | OverlayLayer
Since
1.2.3

addOverlay

addOverlay(overlay): void
添加地图覆盖物
Parameters
- overlay: Overlay
  覆盖物对象
Returns void
Since
1.0.0

removeOverlay

removeOverlay(overlay): void
移除地图覆盖物
Parameters
- overlay: Overlay
  覆盖物对象
Returns void
Since
1.0.0

removeOverlays

removeOverlays(type?): void
按类别移除地图覆盖物
Parameters
- Optional type: OverlayType
  覆盖物类型
Returns void
Since
1.0.2

getOverlayLayer

getOverlayLayer(): OverlayLayer
获取默认覆盖物图层

Returns OverlayLayer
Since
1.2.3

getOverlayLayers

getOverlayLayers(): OverlayLayer[]
获取所有覆盖物图层

Returns OverlayLayer[]
Since
2.0.3

getOverlays

getOverlays(type?): Overlay[]
获取默认覆盖物图层中的覆盖物
Parameters
- Optional type: OverlayType
  指定覆盖物类型
Returns Overlay[]
Since
2.0.3

getOverlaysAll

getOverlaysAll(type?): Overlay[]
获取所有覆盖物图层中的覆盖物
Parameters
- Optional type: OverlayType
  指定覆盖物类型
Returns Overlay[]
Since
2.0.3

removeOverlayLayer

removeOverlayLayer(layer): void
移除覆盖物图层
Parameters
- layer: OverlayLayer
Returns void
Since
1.2.3

setViewport

setViewport(points, options?): void
根据地理坐标设置地图最佳视野
Parameters
- points: LatLng[]
  坐标序列点
- Optional options: IViewportOption
  可选配置
Returns void
Since
1.1.0

getViewport

getViewport(points, options?): IViewportFit
根据地理坐标获取地图最佳视野
Parameters
- points: Bounds | LatLng[]
  坐标序列点
- Optional options: IViewportOption
  可选配置
Returns IViewportFit
表示地图的中心点，偏移量和级别

Since
1.1.0

fitVisibleMapRect

fitVisibleMapRect(bounds, insets, withAnimated): void
据当前mapView的窗口大小，预留insets指定的边界区域后，将mapRect指定的地理范围显示在剩余的区域内，并尽量充满
Parameters
- bounds: Bounds
  要显示的地图范围
- insets: WinBound
  屏幕四周预留的边界大小
- withAnimated: boolean
Returns void
Since
1.1.0

setViewPadding

setViewPadding(left, right, top, bottom): void
设置地图操作区距控件的距离
Parameters
- left: number
- right: number
- top: number
- bottom: number
Returns void
Since
1.2.0

setGeoRoundLimit

setGeoRoundLimit(bounds): void
设置地图操作区地理显示范围
Parameters
- bounds: Bounds
Returns void
Since
1.2.0

getZoomUnits

getZoomUnits(zoom): number
根据级别获取1像素对应的MC单位
Parameters
- zoom: Nullable<number>
  级别
Returns number

getLayerByTag

getLayerByTag(tag): Nullable<TLayer | TLayer[]>
获取图层实例对象
Parameters
- tag: SysEnum.LayerTag
  图层标记
Returns Nullable<TLayer | TLayer[]>

setLocation

setLocation(opts): void
更新定位图层数据
Parameters
- opts: ILocation
Returns void
Since
1.0.0

clearCustomLocation

clearCustomLocation(): void
Returns void

setLocationConfig

setLocationConfig(opts): void
更新定位图层设置
Parameters
- opts: ILocationConfig
Returns void
Since
2.0.0

setLocationInfo

setLocationInfo(data, config?): void
更新定位图层信息
Parameters
- data: ILocation
- Optional config: ILocationConfig
Returns void
Since
2.0.0

pixel2ll

pixel2ll(left, top): Nullable<LatLng>
屏幕像素坐标转地理坐标
Parameters
- left: number
- top: number
Returns Nullable<LatLng>
Since
1.2.2

pixel2bdll

pixel2bdll(left, top): Nullable<LatLng>
屏幕像素坐标转百度地理坐标
Parameters
- left: number
  像素坐标left
- top: number
  像素坐标top
Returns Nullable<LatLng>
Since
1.0.0

ll2pixel

ll2pixel(latLng, height?): Nullable<[number, number]>
地理坐标转屏幕像素坐标
Parameters
- latLng: LatLng
- height: number = 0
  高度，默认0
Returns Nullable<[number, number]>
Since
1.2.2

bdll2pixel

bdll2pixel(latLng, height?): Nullable<[number, number]>
百度地理坐标转屏幕像素坐标
Parameters
- latLng: LatLng
- height: number = 0
  高度，默认0
Returns Nullable<[number, number]>
Since
1.0.0

addEventListener

addEventListener(model, fun): void
注册地图事件
Parameters
- model: MapEvent
  地图事件名称
- fun: Callback<TMapViewEvent>
  回调响应函数
Returns void
Since
1.0.0

removeEventListener

removeEventListener(model, fun): void
移除地图事件
Parameters
- model: MapEvent
  地图事件名称
- fun: Callback<TMapViewEvent>
  回调响应函数
Returns void
Since
1.0.0

fireMapEvent

fireMapEvent(model, content, reason?): void
Parameters
- model: MapEvent
- content: TMapViewEvent
- Optional reason: MapStatusChangeReason
Returns void

addOverlayEventListener

addOverlayEventListener(type, model, fun): void
添加覆盖物类型统一事件
Parameters
- type: OverlayType
  覆盖物类型
- model: OverlayEvent
  事件类型
- fun: Callback<EventOverlayBundle>
  回调响应函数
Returns void
Since
1.1.2

removeOverlayEventListener

removeOverlayEventListener(type, model, fun): void
移除覆盖物类型统一事件
Parameters
- type: OverlayType
  覆盖物类型
- model: OverlayEvent
  事件类型
- fun: Callback<EventOverlayBundle>
  回调响应函数
Returns void
Since
1.1.2

fireOverlayEvent

fireOverlayEvent(type, model, content): void
Parameters
- type: OverlayType
- model: OverlayEvent
- content: EventOverlayBundle
Returns void

setOnTouchMessageListener

setOnTouchMessageListener(listener): void
设置手势移动监听事件
Parameters
- listener: OnTouchListener
Returns void
Since
1.2.3

changeMapStatusReason

changeMapStatusReason(reason): void
主动改变状态原因
Parameters
- reason: MapStatusChangeReason
Returns void
Since
1.2.3

triggerMapLoadFinish

triggerMapLoadFinish(): void
Internal
触发地图加载完成回调内部方法，由MapLoadStateHandler调用

Returns void

setDEMEnable

setDEMEnable(isEnabled): void
地形图
Parameters
- isEnabled: boolean
Returns void

addTileLayer

addTileLayer(layer): void
添加瓦片图层
Parameters
- layer: default
Returns void
Since
1.2.0

removeTileLayer

removeTileLayer(layer): void
移除瓦片图层
Parameters
- layer: default
Returns void
Since
1.2.0

switchLayer

switchLayer(sourceLayer, targetLayer): any
交换图层位置
Parameters
- sourceLayer: number
- targetLayer: number
Returns any
Since
1.2.2
switchLayer(sourceLayer, targetLayer): any
交换图层位置
Parameters
- sourceLayer: default
- targetLayer: default
Returns any
Since
1.2.2

setMaxZoom

setMaxZoom(zoom): void
设置地图最大缩放级别
Parameters
- zoom: number
  最大级别，范围3-21
Returns void
Since
1.0.0

setMinZoom

setMinZoom(zoom): void
设置地图最小缩放级别
Parameters
- zoom: number
  最小级别，范围3-21
Returns void
Since
1.0.0

zoomTo

zoomTo(level?, center?, screenOffset?): void
更新地图到指定等级
Parameters
- level: number = 3
  地图等级，默认为3
- Optional center: Nullable<LatLng>
  地图缩放位置地理坐标，可选
- Optional screenOffset: Nullable<[number, number]>
  地图缩放位置像素坐标，可选
Returns void
Since
1.0.0

zoomInOne

zoomInOne(center?, screenOffset?): void
放大地图一级
Parameters
- Optional center: Nullable<LatLng>
  放大中心点，可选
- Optional screenOffset: Nullable<[number, number]>
  地图缩放位置像素坐标，可选
Returns void
Since
1.0.0

zoomOutOne

zoomOutOne(center?, screenOffset?): void
缩小地图一级
Parameters
- Optional center: Nullable<LatLng>
  缩小中心点
- Optional screenOffset: Nullable<[number, number]>
  地图缩放位置像素坐标
Returns void
Since
1.0.0

getZoom

getZoom(): number
获取当前地图等级

Returns number
Since
1.0.0

setMapCenter

setMapCenter(center, zoom?, isAnimate?, animationTime?): void
根据经纬度设置并更新地图中心点
Parameters
- center: ISetCenter
  移动到新的地图窗口中心点位置
- zoom: Nullable<number> = undefined
  缩放等级
- isAnimate: boolean = true
  是否启用动画过度
- animationTime: number = 300
  动画时间
Returns void
Since
1.0.0

setMapCenterWithOffset

setMapCenterWithOffset(center, offset, zoom, isAnimate?, animationTime?): void
根据经纬度设置并更新地图中心点
Parameters
- center: ISetCenter
  移动到新的地图窗口中心点位置
- offset: Point
  偏移量，单位像素坐标
- zoom: Nullable<number>
  缩放等级
- isAnimate: boolean = true
  是否启用动画过度
- animationTime: number = 300
  动画时间
Returns void
Since
1.1.0

getCenter

getCenter(options?): LatLng | Point
获取地图中心点默认为经纬度坐标，若配置mercator参数为true则返回墨卡托坐标
Parameters
- Optional options: Nullable<IGetPoint>
Returns LatLng | Point
Since
1.0.0

getRotate

getRotate(): number
获取旋转角

Returns number
Since
1.0.0

getPerPixelMc

getPerPixelMc(): number
获取每像素代表多少墨卡托

Returns number
Since
1.0.0

enableGesturesRotate

enableGesturesRotate(): void
允许手势触发地图旋转

Returns void
Since
1.0.0

disableGesturesRotate

disableGesturesRotate(): void
不允许手势触发地图旋转

Returns void
Since
1.0.0

enableGesturesZoom

enableGesturesZoom(): void
允许手势触发地图缩放

Returns void
Since
1.0.0

disableGesturesZoom

disableGesturesZoom(): void
不允许手势触发地图缩放

Returns void
Since
1.0.0

enableGesturesDrag

enableGesturesDrag(): void
允许手势触发地图拖动

Returns void
Since
1.0.0

disableGesturesDrag

disableGesturesDrag(): void
不允许手势触发地图拖动

Returns void
Since
1.0.0

enableGesturesPich

enableGesturesPich(): void
允许手势触发地图倾斜

Returns void
Since
1.0.0

disableGesturesPich

disableGesturesPich(): void
不允许手势触发地图倾斜

Returns void
Since
1.0.0

switchIndoorFloor

switchIndoorFloor(floor, uid): void
设置显示楼层
Parameters
- floor: string
- uid: string
Returns void
Since
1.0.0

getIndoorInfo

getIndoorInfo(uid?): Nullable<IndoorFloorBundles>
获取建筑楼层数据
Parameters
- Optional uid: Nullable<string>
Returns Nullable<IndoorFloorBundles>
Since
1.0.0

initCustomStyle

initCustomStyle(r_path, callback, overwrite?): void
设置地图样式
Parameters
- r_path: string
  rawfile样式文件路径
- callback: Callback<void>
  回调函数
- overwrite: boolean = false
  是否覆盖已经存在的样式
Returns void
Since
1.0.0

setMapLanguage

setMapLanguage(language): void
Parameters
- language: MapLanguage
Returns void

getMapLanguage

getMapLanguage(): number
Returns number

setCustomStylePath

setCustomStylePath(src, resPath?): boolean
Parameters
- src: string
- Optional resPath: string
Returns boolean

setCustomStyleById

setCustomStyleById(styleId, styleCallBack?): void
Parameters
- styleId: string
- Optional styleCallBack: CustomMapStyleCallBack
Returns void

setCustomStyleEnable

setCustomStyleEnable(enable): boolean
地图切换显示个性化样式
Parameters
- enable: boolean
Returns boolean
Since
1.0.0

showBaseIndoorMap

showBaseIndoorMap(bShow): void
设置室内地图显示
Parameters
- bShow: boolean
  是否显示
Returns void

isBaseIndoorMapMode

isBaseIndoorMapMode(): boolean
检查是否处于室内地图模式

Returns boolean
是否处于室内地图模式

isBaseIndoorMapShow

isBaseIndoorMapShow(): boolean
检查室内地图是否显示

Returns boolean
室内地图是否显示

setMapThemeScene

setMapThemeScene(themeId, sceneId): void
设置地图主题场景
Parameters
- themeId: number
  主题ID
- sceneId: number
  场景ID
Returns void

getMapThemeScene

getMapThemeScene(): undefined | null | NAThemeScene
获取地图主题场景

Returns undefined | null | NAThemeScene
地图主题场景

showTrafficMap

showTrafficMap(bShow): void
显示交通图层
Parameters
- bShow: boolean
  是否显示
Returns void

switchDayOrDarkTheme

switchDayOrDarkTheme(theme, isDarkMode): void
切换日间/夜间主题
Parameters
- theme: number
  主题ID
- isDarkMode: boolean
  是否为暗黑模式
Returns void

setGestureConfig

setGestureConfig(config): void
设置手势配置
Parameters
- config: IGestureConfig
  手势配置
Returns void

getGestureConfig

getGestureConfig(): null | IGestureConfig
获取手势配置

Returns null | IGestureConfig
手势配置

showLayers

showLayers(layerId, bShow): void
显示/隐藏图层
Parameters
- layerId: number
  图层ID
- bShow: boolean
  是否显示
Returns void

showLayersByTag

showLayersByTag(layerTag, bShow): void
根据标签显示/隐藏图层
Parameters
- layerTag: string
  图层标签
- bShow: boolean
  是否显示
Returns void

setVirtualPoiShowEnable

setVirtualPoiShowEnable(bShow): void
设置虚拟POI显示是否启用
Parameters
- bShow: boolean
  是否显示
Returns void

getVirtualPoiShowEnable

getVirtualPoiShowEnable(): boolean
获取虚拟POI显示是否启用

Returns boolean
是否启用虚拟POI显示

setLittle3DEnable

setLittle3DEnable(enable): void
设置小地图3D效果
Parameters
- enable: boolean
  是否启用
Returns void

setEnableOverLook

setEnableOverLook(bCanOverLook): void
设置是否允许俯视
Parameters
- bCanOverLook: boolean
  是否允许俯视
Returns void

getSkyOffset

getSkyOffset(): number
获取天空偏移

Returns number
天空偏移值

getLayerIDByTag

getLayerIDByTag(tag): number
根据标签获取图层ID
Parameters
- tag: string
  图层标签
Returns number
图层ID

set3DModelEnable

set3DModelEnable(isEnable): void
设置3D模型显示是否启用
Parameters
- isEnable: boolean
Returns void
Since
2.0.0

setHouseHeightEnable

setHouseHeightEnable(isEnable): void
设置建筑高度显示是否启用
Parameters
- isEnable: boolean
Returns void
Since
2.0.2

setOnBackOrForeground

setOnBackOrForeground(isForeground): void
Parameters
- isForeground: boolean
Returns void

setBaiduHeatMapEnabled

setBaiduHeatMapEnabled(enabled): void
Parameters
- enabled: boolean
Returns void

addHeatMap

addHeatMap(heatmap): void
添加自定义热力图
Parameters
- heatmap: HeatMap
  自定义热力图
Returns void

startHeatMapFrameAnimation

startHeatMapFrameAnimation(): void
开始热力图帧动画

Returns void

stopHeatMapFrameAnimation

stopHeatMapFrameAnimation(): void
停止热力图帧动画

Returns void

setHeatMapFrameAnimationIndex

setHeatMapFrameAnimationIndex(index): void
设置热力图帧
Parameters
- index: number
Returns void

removeHeatMap

removeHeatMap(heatmap): void
移除自定义热力图
Parameters
- heatmap: HeatMap
  自定义热力图
Returns void

updateHeatMap

updateHeatMap(heatmap): void
更新热力图
Parameters
- heatmap: HeatMap
  热力图对象
Returns void

addHexagonMap

addHexagonMap(hexagonMap): void
添加蜂窝热力图
Parameters
- hexagonMap: HexagonMap
  蜂窝热力图
Returns void

removeHexagonMap

removeHexagonMap(hexagonMap): void
移除蜂窝热力图
Parameters
- hexagonMap: HexagonMap
  蜂窝热力图
Returns void

customParticleEffectByType

customParticleEffectByType(particleEffectType, particleOptions): Promise<boolean>
自定义粒子效果
Parameters
- particleEffectType: ParticleEffectType
  效果类型
- particleOptions: ParticleOptions
  粒子效果
Returns Promise<boolean>

closeParticleEffectByType

closeParticleEffectByType(particleEffectType): void
关闭粒子效果
Parameters
- particleEffectType: ParticleEffectType
  效果类型
Returns void

showParticleEffectByType

showParticleEffectByType(particleEffectType): boolean
显示粒子效果
Parameters
- particleEffectType: ParticleEffectType
  效果类型
Returns boolean

snapshot

snapshot(region?): Promise<PixelMap>
发起地图截图
Parameters
- Optional region: any
Returns Promise<PixelMap>

setMapType

setMapType(type): void
Parameters
- type: MapType
Returns void

setMapClickListener

setMapClickListener(listener): void
注册点击事件
Parameters
- listener: IMapClickListener
  回调响应函数
Returns void
Since
2.0.0

setBgkColor

setBgkColor(color): void
设置背景色
Parameters
- color: ColorString
Returns void
Since
2.0.3

resetBgkColor

resetBgkColor(): void
重置背景色

Returns void
Since
2.0.3

setForceUseBgkColor

setForceUseBgkColor(isUse): void
设置是否强制使用背景色
Parameters
- isUse: boolean
Returns void
Since
2.0.3

onceDraw

onceDraw(): void
主动调用绘制一次

Returns void
Since
1.0.2

refresh

refresh(): void
Returns void

destroy

destroy(): void
Returns void

cleanUp

cleanUp(): void
清理地图内部实例

Returns void

onWillDisappear

onWillDisappear(): void
销毁地图控制器实例如果使用Navigation框架，需要在onWillDisappear中调用此方法，进行销毁

Returns void