CustomItem
类：自定义标签
Constructor
new Glodon.Bimface.Earth.Plugins.Drawable.CustomItem(customItemConfig)
构造自定义标签
Parameters:
| Name | Type | Description |
|---|---|---|
| customItemConfig | Glodon.Bimface.Earth.Plugins.Drawable.CustomItemConfig | 自定义标签的配置项 |
Methods
enableDepthTest(isEnabled)
设置是否开启深度检测，开启后可监听标签的遮挡状态变化事件
Parameters:
| Name | Type | Description |
|---|---|---|
| isEnabled | Boolean | 是否开启深度检测。 |
getContent()
获取自定义标签内容
Returns:
| Type | Description |
|---|---|
| String | 自定义标签内容 |
getHeight()
获取自定义标签高度
Returns:
| Type | Description |
|---|---|
| Number | 自定义标签高度 |
getLocation()
获取外部标签的位置坐标
Returns:
| Type | Description |
|---|---|
| Object | 外部标签的位置坐标 |
getOffsetX()
获取自定义标签沿X轴的偏移量
Returns:
| Type | Description |
|---|---|
| Number | 自定义标签沿X轴的偏移量(屏幕坐标)，单位为px |
getOffsetY()
获取自定义标签沿Y轴的偏移量
Returns:
| Type | Description |
|---|---|
| Number | 自定义标签沿Y轴的偏移量(屏幕坐标)，单位为px |
getOpacity()
获取自定义标签透明度
Returns:
| Type | Description |
|---|---|
| Number | 自定义标签透明度 |
getTooltip()
获取标签的提示文字内容
Returns:
| Type | Description |
|---|---|
| String | 标签的提示文字内容 |
getTooltipStyle()
获取标签的提示样式
Returns:
| Type | Description |
|---|---|
| Object | 标签的提示样式 |
getVisibleDistance()
获取可见距离
Returns:
| Type | Description |
|---|---|
| Number | 可见距离，单位同场景单位。 |
getWidth()
获取自定义标签宽度
Returns:
| Type | Description |
|---|---|
| Number | 自定义标签宽度,单位为px |
hide()
隐藏外部标签
isDepthTestEnabled()
获取深度检测的开启状态
Returns:
| Type | Description |
|---|---|
| Boolean | 深度检测是否开启。 |
onClick(callback)
设置左键点击事件
Parameters:
| Name | Type | Description |
|---|---|---|
| callback | Function | 回调函数 |
onDoubleClick(callback)
设置双击事件的回调函数
Parameters:
| Name | Type | Description |
|---|---|---|
| callback | Function | 回调函数 |
onEndDrag(callback)
设置拖拽事件
Parameters:
| Name | Type | Description |
|---|---|---|
| callback | Function | 回调函数 |
onObstructionChanged(callback)
设置标签遮挡状态变化事件，将返回标签是否被遮挡（true/false）。仅当开启深度检测后才生效。
Parameters:
| Name | Type | Description |
|---|---|---|
| callback | Function | 标签被遮挡状态变化的回调函数。 |
Example
设置标签被遮挡后隐藏
// 开启标签的深度检测
customItem.enableDepthTest(true);
// 设置标签遮挡状态变化事件
customItem.onObstructionChanged(hideItem);
// 设置标签显隐状态
function hideItem(isObstructed){
if(isObstructed){
customItem.hide();
}else{
customItem.show();
}
}onRightClick(callback)
设置右键点击事件
Parameters:
| Name | Type | Description |
|---|---|---|
| callback | Function | 回调函数 |
setContent(content)
设置自定义标签内容
Parameters:
| Name | Type | Description |
|---|---|---|
| content | String | 自定义标签内容 |
setHeight(height)
设置自定义标签高度
Parameters:
| Name | Type | Description |
|---|---|---|
| height | Number | 自定义标签高度,单位为px |
setLocation(location)
设置外部标签的位置坐标
Parameters:
| Name | Type | Description |
|---|---|---|
| location | Object | 外部标签的位置坐标 |
setOffsetX(offsetX)
设置自定义标签沿X轴的偏移量
Parameters:
| Name | Type | Description |
|---|---|---|
| offsetX | Number | 自定义标签沿X轴的偏移量(屏幕坐标)，单位为px |
setOffsetY(offsetY)
设置自定义标签沿Y轴的偏移量
Parameters:
| Name | Type | Description |
|---|---|---|
| offsetY | Number | 自定义标签沿Y轴的偏移量(屏幕坐标)，单位为px |
setOpacity(opacity)
设置自定义标签透明度
Parameters:
| Name | Type | Description |
|---|---|---|
| opacity | Number | 自定义标签透明度 |
setTooltip(tip)
设置标签的提示文字内容
Parameters:
| Name | Type | Description |
|---|---|---|
| tip | String | 标签的提示文字内容 |
setTooltipStyle(style)
设置标签的提示样式
Parameters:
| Name | Type | Description |
|---|---|---|
| style | Object | 标签的提示样式 |
Example
设置提示样式示例
customItem.setTooltipStyle({
border: '1px',
textAlign : 'center'
})setVisibleDistance(visibleDistance)
设置可见距离
Parameters:
| Name | Type | Description |
|---|---|---|
| visibleDistance | Number | 可见距离，单位同场景单位，当相机与标签的距离小于可见距离时才会显示标签，默认为空，即不限制距离。 |
setWidth(width)
设置自定义标签宽度
Parameters:
| Name | Type | Description |
|---|---|---|
| width | Number | 自定义标签宽度 |
show()
显示外部标签