Label

此类表示地图上的文本标注。

构造函数

  • 创建文本标注实例

    参数类型说明
    contentstring标注内容，支持HTML
    opts 可选LabelOptions可选参数
    属性类型说明
    enableClickingboolean是否响应点击事件
    enableMassClearboolean是否在调用 map.clearOverlays() 时清除此覆盖物
    offsetSize文本标注的位置偏移值
    positionPoint文本标注的地理位置

    返回值 Label

    示例代码1

    const label = new BMap.Label('Hello BMap', {
      position: new BMap.Point(116.404, 39.915),
      offset: new BMap.Size(20, -10),
    });
    map.addOverlay(label);

方法

  • 添加事件监听函数

    参数类型说明
    eventstring事件名称
    handlerFunction事件处理函数

    返回值 void

    示例代码1

    label.addEventListener('click', (e) => {
      console.log('label clicked', e);
    });

  • 禁止覆盖物在 map.clearOverlays() 方法中被清除

    返回值 void

  • 允许覆盖物在 map.clearOverlays() 方法中被清除

    返回值 void

  • 返回覆盖物所在的地图实例

    返回值 Map

  • 返回文本标注的偏移值

    返回值 Size

  • 返回文本标注的地理坐标

    返回值 Point

  • 返回文本标注的标题

    返回值 string

  • 移除事件监听函数

    参数类型说明
    eventstring事件名称
    handlerFunction事件处理函数

    返回值 void

    示例代码1

    const handler = (e: any) => { console.log(e); };
    label.addEventListener('click', handler);
    label.removeEventListener('click', handler);

  • 设置文本标注的内容，支持HTML

    参数类型说明
    contentstring标注内容

    返回值 void

    示例代码1

    label.setContent('<strong>新内容</strong>');

  • 设置文本标注的偏移值

    参数类型说明
    offsetSize偏移量

    返回值 void

    示例代码1

    label.setOffset(new BMap.Size(10, -5));

  • 设置文本标注的地理坐标，仅当通过 map.addOverlay() 添加时有效

    参数类型说明
    positionPoint地理坐标

    返回值 void

    示例代码1

    label.setPosition(new BMap.Point(116.410, 39.920));

  • 设置文本标注的CSS样式，样式作用于标注容器元素

    参数类型说明
    stylesobjectCSS样式对象，属性名使用驼峰命名（如 backgroundColor）

    返回值 void

    示例代码1

    label.setStyle({ color: 'red', fontSize: '14px', border: '1px solid blue' });

  • 设置文本标注的标题，鼠标悬停时显示

    参数类型说明
    titlestring标题文字

    返回值 void

    示例代码1

    label.setTitle('标注标题');

  • 设置覆盖物的 zIndex

    参数类型说明
    zIndexnumber层叠顺序值

    返回值 void

    示例代码1

    label.setZIndex(100);