mgis

切换主题

m-gis核心库 v0.4.4

m-gis核心库 / Billboard

类: Billboard ​

定义于: overlay/entity/Billboard.ts:48

用于三维中添加图标

示例 ​

js
   // 添加图层
   const layer = new EntityLayer().addToViewer(this.$viewer);
   const billboard = new Billboard(
     new Position(118.78600228, 31.9135434, 1.66113721),
     {
       icon: require("../../assets/dataImages/locate.png")
     }
   ).addToLayer(layer);
   // billboard 设置样式
   billboard.setStyle({
     horizontalOrigin: 0,
     verticalOrigin: 1
   });
   // 注册 billboard 鼠标移入事件
   billboard.on(MouseEventType.CLICK, evt => {
     console.log(evt);
   });

继承 ​

构造函数 ​

构造函数 ​

new Billboard(position, options?): Billboard

定义于: overlay/entity/Billboard.ts:56

参数 ​

position ​

Position

坐标

options? ​

OPT = DEF_OPT

选项

返回 ​

Billboard

重写了 ​

Overlay.constructor

属性 ​

_attr ​

_attr: any

定义于: overlay/Overlay.ts:26

继承自 ​

Overlay._attr

_bid ​

_bid: any

定义于: overlay/Overlay.ts:17

继承自 ​

Overlay._bid

_customData ​

_customData: any

定义于: overlay/Overlay.ts:29

继承自 ​

Overlay._customData

_delegate ​

_delegate: any

定义于: overlay/Overlay.ts:21

继承自 ​

Overlay._delegate

_icon ​

_icon: string | HTMLCanvasElement

定义于: overlay/entity/Billboard.ts:50

_id ​

_id: string | number

定义于: overlay/Overlay.ts:16

继承自 ​

Overlay._id

_layer ​

_layer: any

定义于: overlay/Overlay.ts:22

继承自 ​

Overlay._layer

_options ​

_options: any

定义于: overlay/Overlay.ts:18

继承自 ​

Overlay._options

_overlayEvent ​

_overlayEvent: OverlayEvent

定义于: overlay/Overlay.ts:28

继承自 ​

Overlay._overlayEvent

_position ​

_position: Position

定义于: overlay/entity/Billboard.ts:49

重写了 ​

Overlay._position

_positions ​

_positions: any

定义于: overlay/Overlay.ts:20

继承自 ​

Overlay._positions

_relaters ​

_relaters: any

定义于: overlay/Overlay.ts:30

继承自 ​

Overlay._relaters

_show ​

_show: boolean

定义于: overlay/Overlay.ts:24

继承自 ​

Overlay._show

_size ​

_size: [number, number]

定义于: overlay/entity/Billboard.ts:51

_state ​

_state: any

定义于: overlay/Overlay.ts:23

继承自 ​

Overlay._state

_style ​

_style: any

定义于: overlay/Overlay.ts:25

继承自 ​

Overlay._style

interactionEvents ​

interactionEvents: any[]

定义于: overlay/Overlay.ts:31

继承自 ​

Overlay.interactionEvents

type ​

type: any

定义于: overlay/Overlay.ts:27

继承自 ​

Overlay.type

访问器 ​

attr ​

Getter 签名 ​

get attr(): any

定义于: overlay/Overlay.ts:106

返回 ​

any

Setter 签名 ​

set attr(attr): void

定义于: overlay/Overlay.ts:102

覆盖物的额外属性设置

参数 ​
attr ​

any

返回 ​

void

继承自 ​

Wall.attr

center ​

Getter 签名 ​

get center(): Position

定义于: overlay/Overlay.ts:137

返回 ​

Position

继承自 ​

Overlay.center

customData ​

Getter 签名 ​

get customData(): any

定义于: overlay/Overlay.ts:141

返回 ​

any

继承自 ​

Overlay.customData

delegate ​

Getter 签名 ​

get delegate(): any

定义于: overlay/Overlay.ts:124

覆盖物的代理对象

返回 ​

any

继承自 ​

Overlay.delegate

icon ​

Getter 签名 ​

get icon(): string | HTMLCanvasElement

定义于: overlay/entity/Billboard.ts:92

返回 ​

string | HTMLCanvasElement

Setter 签名 ​

set icon(icon): void

定义于: overlay/entity/Billboard.ts:87

图标资源

参数 ​
icon ​

string | HTMLCanvasElement

返回 ​

void

id ​

Getter 签名 ​

get id(): any

定义于: overlay/Overlay.ts:78

返回 ​

any

Setter 签名 ​

set id(id): void

定义于: overlay/Overlay.ts:74

设置覆盖物的业务 id

参数 ​
id ​

any

返回 ​

void

继承自 ​

Tileset.id

overlayEvent ​

Getter 签名 ​

get overlayEvent(): OverlayEvent

定义于: overlay/Overlay.ts:115

覆盖物的事件对象

返回 ​

OverlayEvent

继承自 ​

Overlay.overlayEvent

overlayId ​

Getter 签名 ​

get overlayId(): string | number

定义于: overlay/Overlay.ts:61

覆盖物唯一标识

返回 ​

string | number

继承自 ​

Wall.overlayId

position ​

Getter 签名 ​

get position(): Position

定义于: overlay/entity/Billboard.ts:78

返回 ​

Position

Setter 签名 ​

set position(position): void

定义于: overlay/entity/Billboard.ts:73

参数 ​
position ​

Position

返回 ​

void

relaters ​

Getter 签名 ​

get relaters(): any[]

定义于: overlay/Overlay.ts:145

返回 ​

any[]

继承自 ​

Overlay.relaters

show ​

Getter 签名 ​

get show(): boolean

定义于: overlay/Overlay.ts:94

返回 ​

boolean

Setter 签名 ​

set show(show): void

定义于: overlay/Overlay.ts:86

覆盖物的可见性

参数 ​
show ​

boolean

返回 ​

void

继承自 ​

Overlay.show

size ​

Getter 签名 ​

get size(): [number, number]

定义于: overlay/entity/Billboard.ts:115

返回 ​

[number, number]

Setter 签名 ​

set size(size): void

定义于: overlay/entity/Billboard.ts:102

图标尺寸,格式 eg:[32,32]

默认值 ​
ts
@public
参数 ​
size ​

[number, number]

返回 ​

void

state ​

Getter 签名 ​

get state(): any

定义于: overlay/Overlay.ts:133

覆盖物的状态

返回 ​

any

继承自 ​

Overlay.state

viewer ​

Getter 签名 ​

get viewer(): any

定义于: overlay/Overlay.ts:52

返回 ​

any

继承自 ​

Overlay.viewer

方法 ​

addCustomData() ​

addCustomData(key, value): void

定义于: overlay/Overlay.ts:267

参数 ​

key ​

any

value ​

any

返回 ​

void

继承自 ​

Overlay.addCustomData

addToLayer() ​

addToLayer(layer): Billboard

定义于: overlay/Overlay.ts:260

添加到指定图层

参数 ​

layer ​

any

指定图层

返回 ​

Billboard

继承自 ​

Overlay.addToLayer

clearCustomData() ​

clearCustomData(): void

定义于: overlay/Overlay.ts:275

返回 ​

void

继承自 ​

Overlay.clearCustomData

clearRelate() ​

clearRelate(): void

定义于: overlay/Overlay.ts:288

返回 ​

void

继承自 ​

Overlay.clearRelate

eachRelaters() ​

eachRelaters(callback): void

定义于: overlay/Overlay.ts:292

参数 ​

callback ​

any

返回 ​

void

继承自 ​

Overlay.eachRelaters

fire() ​

fire(type, params): Billboard

定义于: overlay/Overlay.ts:339

触发事件

参数 ​

type ​

string | number

params ​

any

返回 ​

Billboard

继承自 ​

Overlay.fire

getCustomData() ​

getCustomData(key): any

定义于: overlay/Overlay.ts:271

参数 ​

key ​

any

返回 ​

any

继承自 ​

Overlay.getCustomData

off() ​

off(type, callback, context?): Billboard

定义于: overlay/Overlay.ts:324

注销事件

参数 ​

type ​

string | number

事件类型

callback ​

any

监听回调

context? ​

any

返回 ​

Billboard

继承自 ​

Overlay.off

on() ​

on(type, callback, context?): Billboard

定义于: overlay/Overlay.ts:304

注册事件

参数 ​

type ​

string | number

事件类型

callback ​

any

监听回调

context? ​

any

返回 ​

Billboard

继承自 ​

Overlay.on

relate() ​

relate(overlay): void

定义于: overlay/Overlay.ts:279

参数 ​

overlay ​

Overlay

返回 ​

void

继承自 ​

Overlay.relate

remove() ​

remove(): Billboard

定义于: overlay/Overlay.ts:243

从图层上移出

返回 ​

Billboard

继承自 ​

Overlay.remove

setLabel() ​

setLabel(text, textStyle): Billboard

定义于: overlay/Overlay.ts:229

设置文字标签

参数 ​

text ​

string

指定文本的属性。支持显式换行符'\ n'。

textStyle ​

any

text 样式

返回 ​

Billboard

继承自 ​

Overlay.setLabel

setStyle() ​

setStyle(style): Billboard

定义于: overlay/entity/Billboard.ts:165

设置 billboard 的样式

参数 ​

style ​

any

样式可选属性

// 样式参数(可选) { "scale": 1, //比例 "pixelOffset": { "x": 0, "y": 0 }, //偏移像素 "rotation": 0, //旋转角度 "horizontalOrigin": 0, // 指定 billboard 水平对齐方式。CENTER: 0, LEFT: 1, RIGHT: -1 "verticalOrigin": 0, // 指定 billboard 垂直对齐方式。 CENTER: 0, BOTTOM: 1, BASELINE: 2, TOP: -1 "heightReference": 0, // 指定 billboard 高度模式。 NONE: 0, CLAMP_TO_GROUND: 1, RELATIVE_TO_GROUND: 2 "color": Color.WHITE, // 指定 billboard 图片的颜色。 "translucencyByDistance": { "near": 0, //最近距离 "nearValue": 0, //最近距离值 "far": 1, //最远距离值 "farValue": 0 //最远距离值 }, //根据距离设置透明度 "scaleByDistance": { "near": 0, //最近距离 "nearValue": 0, //最近距离值 "far": 1, //最远距离值 "farValue": 0 //最远距离值 }, //根据距离设置比例 "distanceDisplayCondition": { "near": 0, //最近距离 "far": Number.MAX_VALUE //最远距离 }, //根据距离设置可见 "disableDepthTestDistance": 0 // 深度检测距离，用于防止剪切地形，设置为零时，将始终应用深度测试。设置为Number.POSITIVE_INFINITY时，永远不会应用深度测试。 }

返回 ​

Billboard

unRelate() ​

unRelate(overlay): void

定义于: overlay/Overlay.ts:283

参数 ​

overlay ​

Overlay

返回 ​

void

继承自 ​

Overlay.unRelate

fromEntity() ​

static fromEntity(entity): Billboard | undefined

定义于: overlay/entity/Billboard.ts:181

从 entity 中解析出 Billboard

参数 ​

entity ​

any

返回 ​

Billboard | undefined

getOverlayType() ​

static getOverlayType(type): string | number | undefined

定义于: overlay/Overlay.ts:361

获取 Overlay 类型

参数 ​

type ​

string

返回 ​

string | number | undefined

继承自 ​

Overlay.getOverlayType

registerType() ​

static registerType(type): void

定义于: overlay/Overlay.ts:349

Overlay 类型注册

参数 ​

type ​

string

返回 ​

void

继承自 ​

Overlay.registerType

MGis 地理三维库

© 2026 MGis