Fengmap JavaScript SDK v3.1.10

Class: FMCompositeMarker

FMCompositeMarker

FMCompositeMarker 文本标注对象, 属于fengmap.plugin.markers.min.js

new fengmap.FMCompositeMarker(options)

Name Type Description
options json

参数

Name Type Description
layout json

视图中心的地图坐标

Name Type Description
style string

image：只显示图片，text：只显示文字
limage-rtext：左图右文
ltext-rimage：左文右图
timage-btext：上图下文
ttext-bimage：上文下图
overlay-text：文字覆盖图片
align string

当style为limage-rtext或者ltext-rimage时值可以为center，top，bottom
当style为timage-btext或者ttext-bimage时值可以为left，center，right
当style为overlay-text时值可以为图（位置包括：top，center，bottom）-文字（位置包括：left，center，right），例子：bottom-right代表文字在图的底部，文字与图右对齐
spacings number

文字与图片的间距，默认值为0，只有layout.style为limage-rtext（左图右文）、ltext-rimage(左文右图)、limage-rtext（左图右文）、timage-btext：上图下文、ttext-bimage：上文下图时有效
media json

媒体信息，包括图片或视频

Name Type Description
url string

图片或视频url地址，为视频时仅单独显示，不可与文字组合使用
size Array

图片或视频大小，数组第一个元素是宽，第二个元素为高，默认为[32, 32]，注：当render为fengmap.FMMarkerRenderMode.BILLBOARD和fengmap.FMMarkerRenderMode.FLAT有效，当render为fengmap.FMMarkerRenderMode.FIX_BILLBOARD和fengmap.FMMarkerRenderMode.FIX_FLAT无效，大小有rectangle控制
image json

图片信息，已废弃 3.2.4 版本及以后版本将不可用, 使用 options.media代替

Name Type Description
url string

图片url地址
size Array

图片大小，数组第一个元素是宽，第二个元素为高，默认为[32, 32]
text json

文字信息

Name Type Description
padding array

文字内边距默认值为 [0,0,0,0]
plateColor string

底色，默认无
plateStrokeColor string

底色边框颜色，默认无
plateStrokeWidth number

文字背景边框宽度，注：只有描边颜色没有描边宽度时，默认描边宽度为 1
plateOpacity number

背景透明度，默认为1
plateStrokeRadius number

背景圆角半径，默认为0
content json

文字内容信息

Name Type Description
textAlign string

fengmap.FMTextAlign 文字对齐方式。水平居中、左对齐、右对齐，默认为fengmap.FMTextAlign.Center
lineSpacing number

行间距默认为2，当小于2时也等于2
fontSize number

文本字号, 默认20px
fontWeight number | string

文字粗细
fontFamily string

字体样式，如果没有给定，使用默认字体样式
fillColor string

文本填充色，rgb类型字符串，默认 "255,0,0"
strokeColor string

文本边框填充色，rgb类型字符串。默认 '255,255,0'
strokeWidth number

描边线宽
text string | array

文字内容，必填, 换行符为“%rn%”
text[].text string

当为数组时的文字内容，必填
text[].textAlign string

fengmap.FMTextAlign 文字对齐方式。水平居中、左对齐、右对齐，默认为与上面的设置的textAlign一致
text[].lineSpacing number

行间距默认，默认与上面设置的lineSpacing一致，当小于2时也等于2
text[].fontSize number

文本字号, 默认与上面设置的fontSize一致
text[].fontWeight number | string

文字粗细, 默认与上面设置的fontWeight一致
text[].fontFamily string

字体样式，默认与上面设置的fontFamily一致
text[].fillColor string

文本填充色，默认与上面设置的fillColor一致
text[].strokeColor string

文本边框填充色，默认与上面设置的strokeColor一致
text[].strokeWidth number

描边线宽，默认与上面设置的strokeWidth一致
x number

图片地图位置x值，默认对应楼层中心点坐标,必填
y number

图片地图位置y值，默认对应楼层中心点坐标,必填
render fengmap.FMMarkerRenderMode

渲染方式，fengmap.FMMarkerRenderMode.BILLBOARD始终面向屏幕(不随地图缩放而缩放),fengmap.FMMarkerRenderMode.FIX_BILLBOARD始终面向屏幕(随地图缩放而缩放，需要搭配参数rectangle)，fengmap.FMMarkerRenderMode.FLAT平铺(不随地图缩放而缩放)，fengmap.FMMarkerRenderMode.FIX_FLAT矩形平铺(随地图缩放而缩放，需要搭配参数rectangle)，默认为billboard
rectangle fengmap.FMRectangle

矩形bound对象
anchor json

锚点信息

Name Type Description
baseon string

锚点基于图片还是文字还是全部（all：全部，image：图片，text：文字）
anchor fengmap.FMMarkerAnchor

锚点位置
zoomRange array

标注比例尺缩放级别(可调范围为1-30),默认值:[1,30]
opacity number

透明度，0到1之间，默认为1
collision bool

true:开启避让 false:关闭避让 默认 true，注：render为fengmap.FMMarkerRenderMode.BILLBOARD支持避让，其他不支持
depth bool

文本渲染深度 【true】：开启深度；【false】：关闭深度
height number

离地高度, 默认 1
tilt number

倾斜角度（render为FLAT/FIX_FLAT时生效）
heading number

旋转角度参数（render为FLAT/FIX_FLAT时生效）

Members

height

离地高度

Properties:
Name Type Description
height number

离地高度

readonlylevel

Properties:
Name Type Description
level number

楼层等级,初始化完成后可以获取当前值

opacity

标注透明度

Properties:
Name Type Description
opacity number

标注透明度 修改需要调用update方法更新

plateColor

Properties:
Name Type Description
plateColor String

文字背景色 修改需要调用update方法更新

plateOpacity

Properties:
Name Type Description
plateOpacity number

背景透明度 修改需要调用update方法更新

plateStrokeColor

Properties:
Name Type Description
plateStrokeColor String

文字背景色边框 修改需要调用update方法更新

plateStrokeRadius

Properties:
Name Type Description
plateStrokeRadius number

背景圆角半径 修改需要调用update方法更新

readonlytype

Properties:
Name Type Description
type fengmap.FMType

节点类型, 值为 fengmap.FMType.TEXT_MARKER

visible

Properties:
Name Type Description
visible Boolean

true 显示 false 隐藏

readonlyx

Properties:
Name Type Description
x number

坐标

readonlyy

Properties:
Name Type Description
y number

坐标

zoomRange

标注比例尺缩放级别属性

Properties:
Name Type Description
zoomRange array

标注比例尺缩放级别(可调范围为1-29),默认值:[16,23]

Methods

addTo(floor)

添加到楼层

Name Type Description
floor Object

楼层等级

getBelongedBuildingID(){string|null}

获取当前对象所属的 buildingID

Returns:
Type Description
string | null null 表示归属为当前地图或室内外一体化中的室外主地图

getImage(){string}

获取图片或视频信息

Deprecated
Returns:
Type Description
string 获取图片信息

getMedia(){string}

获取图片或视频信息

Returns:
Type Description
string 获取图片信息

getText(){string|array}

获取文字信息

Returns:
Type Description
string | array 地图覆盖物组

jump(options)

图标标注跳动动画。

Name Type Description
options Object
Name Type Description
height number

图标跳动的高度。
times number

图标跳动次数。不设置该参数或设置为0时, 一直跳动。
duration number

单次跳动动画的持续时长（秒）。
delay number

一次跳动完成到下次跳动开始的等待时长（秒）。

moveTo(options){fengmap.FMAnimation}

动画移动marker到指定位置

Name Type Description
options json
Name Type Description
x number

图片地图位置x值，默认对应楼层中心点坐标
y number

图片地图位置y值，默认对应楼层中心点坐标
animate boolean

是否需要动画，默认false
duration number

移动到指定位置所用的时间（秒）,默认0.5
finish function

移动到指定位置后的回调函数
Returns:
Type Description
fengmap.FMAnimation animation 动画类

remove()

从楼层中移除

rotateTo(options)

水平旋转至特定角度，带动画，只对render为flat（平铺）和FIX_FLAT(矩形平铺)时有效

Name Type Description
options json
Name Type Description
heading number

{number} 角度
animate Boolean

是否启动动画 默认 false
duration number

动画持续时间
finish function

移动到指定位置后的回调函数

setImage(url, size)

设置图片，设置后需要执行update()方法更新

Name Type Description
url string

图片的url地址
size array

图片大小，数组第一个元素是宽，第二个元素为高
Deprecated

setMedia(url, size)

设置图片或视频，设置后需要执行update()方法更新

Name Type Description
url string

图片或视频的url地址
size array

图片大小，数组第一个元素是宽，第二个元素为高

setText(text)

设置文字信息，设置后需要执行update()方法更新, 换行符为“%rn%”

Name Type Description
text string | array

文字信息

stopJump()

停止图标标注跳动动画。

tiltTo(options)

倾斜旋转至特定角度，带动画，只对render为flat（平铺）和FIX_FLAT(矩形平铺)时有效

Name Type Description
options json
Name Type Description
tilt number

{number} 角度
animate Boolean

是否启动动画 默认 false
duration number

动画持续时间
finish function

移动到指定位置后的回调函数

update()

更新marker