Skip to content

Poi2

说明

Poi2 是一个地图兴趣点类,用于在地图上渲染带有图标和文字的标记点。

构造函数

typescript
new Poi2(context: Context, options?: Partial<PoiOptions2>);

参数

参数类型说明默认值
contextContext地图上下文-
optionsPartial<PoiOptions2>POI配置{}

返回值

Poi2 实例

属性

options

  • 类型PoiOptions2
  • 默认值:见下方默认配置

POI配置项,包含以下字段:

字段类型说明默认值
textstringPOI文本内容""
iconstringPOI图标URL""
icon_size[number, number]图标尺寸[宽,高][22, 22]
levelnumber渲染优先级1
collision_enableboolean是否参与碰撞检测true
opacitynumber整体透明度1
idstringPOI唯一标识""
position{ x: number; y: number; z: number }POI位置坐标{ x: 0, y: 0, z: 0 }
text_font_sizenumber文本字体大小14
icon_rotatenumber图标旋转角度0
depth_testboolean是否进行深度测试false
hide_textboolean是否隐藏文本false
icon_border{ width: number; color: string }图标边框配置undefined
maxWeightnumber最大权重25
minWeightnumber最小权重1
text_opacitynumber文本透明度1
icon_opacitynumber图标透明度1

visible

  • 类型boolean
  • 默认值true

POI是否可见

方法

getPosition

typescript
getPosition(): Vector3;

获取POI的位置

返回值

返回POI的位置坐标

dispose

typescript
dispose(): void;

销毁POI实例

事件

change-{property}

typescript
(event: `change-${keyof PoiOptions2}`, args: { value: any }): void;

当POI的任意配置项发生变化时触发

参数

参数类型说明默认值
valueany变化后的值-

使用示例

typescript
poi.addEventListener("change-text", ({ value }) => {
  console.log("text changed to:", value);
});