@indoor-map/fmap-js • Docs
覆盖物管理类 提供各类地图覆盖物的创建、添加、移除和批量管理功能
Constructors
new FMapMarker()
new FMapMarker(
fmap):FMapMarker
Parameters
• fmap: FMap
Returns
Accessors
count
Get Signature
get count():
number
获取已管理的覆盖物数量
Returns
number
Methods
addBillboardMarker()
addBillboardMarker(
options):FMCompositeMarker
添加立式图片标注（始终面向屏幕的 billboard 图标，无背景板） 基于 FMCompositeMarker 纯图片模式实现（v3.x 中 FMImageMarker 只能平贴地面）
Parameters
• options
标注配置
• options.collision?: boolean
• options.height?: number
• options.level?: number
• options.size?: number | [number, number]
• options.url: string
• options.x: number
• options.y: number
Returns
FMCompositeMarker
复合标注实例
addCompositeMarker()
addCompositeMarker(
options):FMCompositeMarker
添加复合标注（图文混合）
Parameters
• options
复合标注配置
• options.anchor?: unknown
• options.collision?: boolean
• options.heading?: number
• options.height?: number
• options.image?: Record<string, unknown>
• options.layout?
• options.layout.align?: string
• options.layout.spacings?: number[]
• options.layout.style?: string
• options.level?: number
• options.media?: Record<string, unknown>
• options.text?: Record<string, unknown>
• options.tilt?: number
• options.x: number
• options.y: number
• options.z?: number
• options.zoomRange?: [number, number]
Returns
FMCompositeMarker
复合标注实例
addDomMarker()
addDomMarker(
options):FMDomMarker
添加DOM标注
Parameters
• options: DomMarkerOptions
DOM标注配置
Returns
FMDomMarker
DOM标注实例
addDynamicModel()
addDynamicModel(
options):FMDynamicModel
添加动态模型
Parameters
• options: DynamicModelOptions
动态模型配置
Returns
FMDynamicModel
动态模型实例
addExtrudeMarker()
addExtrudeMarker(
options):FMExtrudeMarker
添加拉伸几何体
Parameters
• options
拉伸几何体配置
• options.color?: string
• options.extrudeHeight?: number
• options.height?: number
• options.level?: number
• options.lineColor?: string
• options.opacity?: number
• options.points: object[]
• options.topColor?: string
Returns
FMExtrudeMarker
拉伸几何体实例
addHeatMap()
addHeatMap(
options):FMHeatMap
添加热力图
Parameters
• options: HeatMapOptions
热力图配置
Returns
FMHeatMap
热力图实例
addImageMarker()
addImageMarker(
options):FMImageMarker
添加图片标注
Parameters
• options: ImageMarkerOptions
图片标注配置
Returns
FMImageMarker
图片标注实例
addImageMarkers()
addImageMarkers(
markers):FMImageMarker[]
批量添加图片标注
Parameters
• markers: ImageMarkerOptions[]
图片标注配置数组
Returns
FMImageMarker[]
图片标注实例数组
addLineMarker()
addLineMarker(
options):FMLineMarker
添加线标注
Parameters
• options: LineMarkerOptions
线标注配置
Returns
FMLineMarker
线标注实例
addLocationMarker()
addLocationMarker(
options):FMLocationMarker
添加定位标注
Parameters
• options: LocationMarkerOptions
定位标注配置
Returns
FMLocationMarker
定位标注实例
addPolygonMarker()
addPolygonMarker(
options):FMPolygonMarker
添加多边形标注
Parameters
• options: PolygonMarkerOptions
多边形标注配置
Returns
FMPolygonMarker
多边形标注实例
addSearchMarker()
addSearchMarker(
options):string
添加搜索结果标记（立式 billboard 图标，无背景板）
Parameters
• options: ImageMarkerOptions
图片标注配置
Returns
string
标记ID
addTextMarker()
addTextMarker(
options):FMTextMarker
添加文字标注
Parameters
• options: TextMarkerOptions
文字标注配置
Returns
FMTextMarker
文字标注实例
clearAll()
clearAll():
void
清除所有已管理的覆盖物（含通用标记、搜索标记、路线标记、途经点标记）
Returns
void
clearRouteMarkers()
clearRouteMarkers():
void
清除所有路线标记
Returns
void
clearSearchMarkers()
clearSearchMarkers():
void
清除所有搜索标记
Returns
void
clearViapointMarkers()
clearViapointMarkers():
void
清除所有途经点标记
Returns
void
drawRouteLine()
drawRouteLine(
routeResult,options?):string
绘制路线线
Parameters
• routeResult
路线结果（包含路径点或导航结果）
• routeResult.path?: object[]
• routeResult.subs?: object[]
• options?
线标注配置
• options.color?: string
• options.width?: number
Returns
string
线标注ID
drawViapointMarkers()
drawViapointMarkers(
points,options?):void
绘制途经点标记
Parameters
• points: object[]
途经点坐标数组
• options?
标记配置
• options.color?: string
• options.size?: number
Returns
void
removeMarker()
removeMarker(
marker):void
移除指定覆盖物
Parameters
• marker: string | object
要移除的覆盖物实例或ID
Returns
void