文字图层

文字展示图层,继承自Layeropen in new window

可使用鼠标拾取Pickopen in new window

基础示例

静态属性

仅且可以初始化配置,不支持响应式。

名称类型说明
fontFamilyString文字字体, 默认值:Microsoft Yahei
colorString颜色,同css颜色,默认值:’#fff’。
fontSizenumber文字大小, 默认值:14
unitstring绘制大小的方式,即指定width和height属性的单位,默认值:’px’。可选值:px,默认值,按像素绘制。 m,按米来绘制
scaleNumber设置icon缩放,默认值:1
angleNumber设置icon按顺时针旋转角度,默认值:0
flatbooleanicon是否随地图倾斜,即平躺在地图上,默认值:false
collidesboolean是否开启碰撞检测,开启后重叠部分的文字会被隐藏, 默认值:true
offsetarray文字偏移量,基于文字中心点偏移,[{number}x, {number}y], 默认值:[0, 0]
paddingarray文字内边距,[{number}左右边距, {number}上下边距], 默认值:[2, 2]
marginarray文字外边距,[{number}左右边距, {number}上下边距], 默认值:[0, 0]
zoomThresholdArray全图层均可使用,用来指定图层执行渲染的地图层级,初始默认值[0, 30]
lazyNumber组件懒加载,默认-1,不进行懒加载,单位毫秒
---------
enablePickedBoolean是否开启鼠标事件,开启后支持鼠标onClick与onMousemove事件,同时支持改变拾取物体颜色,默认值:false
selectedIndexnumber手动指定选中数据项索引,使该条数据所表示物体变色,-1表示没选中任何元素.默认值:-1,依赖:enablePicked=true
selectedColorstring选中态颜色,默认值:’rgba(20, 20, 200, 1)’,依赖:enablePicked=true
autoSelectboolean根据鼠标位置来自动设置选中项selectedIndex,使选中物体变色,设置为true后selectedIndex失效.默认值:false,依赖:enablePicked=true
onClickfunction(pickObject){}点击事件,如果点击在可选中物体上,则返回对应数据,依赖:enablePicked=true
onDblClickfunction(pickObject){}双击事件,如果双击在可选中物体上,则返回对应数据,依赖:enablePicked=true
onRightClickfunction(pickObject){}右键事件,如果右键在可选中物体上,则返回对应数据
onMousemovefunction(pickObject){}鼠标指针移动事件,如果指针悬浮在在可选中物体上,则返回对应数据,依赖:enablePicked=true

pickObject数据结构

{
    dataIndex: -1, // 返回点击的数据元素索引
    dataItem: {}, // 返回点击的数据元素
}

动态属性

支持响应式。

名称类型说明
visibleBoolean图层显隐,true显示,false隐藏,默认显示
dataArray点数据,GeoJSON格式

data数据结构

[{
    geometry: {
     type: 'Point',
     coordinates: [116.392394, 39.910683]
    },
    properties: {
     text: 'hello world',
    }
}]

ref可用方法

提供无副作用的同步帮助方法

函数返回说明
$$getInstance()mapvgl.TextLayeropen in new window获取TextLayer实例
$$pick({Number}x, {Number}y)pickObject数据结构根据屏幕像素坐标获取元素,依赖:enablePicked=true

事件

事件参数说明
initObject组件实例
最后更新时间:
贡献者: guyangyang