DTS二次开发文档

Class: Tag

Tag

Tag已停止更新，推荐使用功能更丰富的标注对象Marker

<protected> new Tag()

Deprecated:
  • 标签类，实现标签对象的CURD（添加、修改、查询、删除） 一般通过api.tag调用其方法
See:

Extends

Methods

add(data, fn)

添加一个或多个Tag对象

Parameters:
Name Type Description
data object | array

标签数据，可以是Object类型或者Array类型，对于每一个标签，支持以下属性：

  • id (string) 字符串类型的ID

  • groupId (string) 可选，Group分组

  • userData (string) 可选，用户自定义数据

  • coordinate (array) 坐标值：标签添加的位置坐标，取值示例

  • imagePath (string) 图片路径，支持本地路径和网络路径，资源引入说明

  • imageSize (array) 图片尺寸[width,height]，取值范围：[0~任意正数]

  • url (string) 鼠标点击标签后弹出的网页的URL，也可以是本地视频文件，鼠标点击标签后会弹出视频播放窗口，资源引入说明

  • popupBackgroundColor (Color) 弹窗背景色，支持四种格式，取值示例

  • popupPos (array) 弹窗位置: [x, y]，数组元素类型：(number)，数组元素取值范围：[任意正整数]

  • popupSize (array) 弹窗尺寸：[width, height]，数组元素类型：(number)，数组元素取值范围：[任意正整数]

  • range (array) 标签的可见范围 [Min,Max]，Min和Max指摄像机相对于标签的最小和最大距离，在此范围内标签才可见，类型均为浮点数，元素取值范围：[1.0~100000.0]，单位：米

  • text (string) 标签显示的文字

  • textRange (number) 文字的可见范围，取值范围：[1.0~100000.0]，单位：米

  • textSize (number) 文字大小，取值范围：[0~任意正整数]

  • textColor (Color) 文字颜色，支持四种格式，取值示例

  • textBorderColor (Color) 文字边框颜色，支持四种格式，取值示例

  • textBackgroundColor (Color) 文本背景颜色，默认值白色，支持四种格式，取值示例

  • showLine (boolean) 标签下方是否显示垂直牵引线，默认值：true

  • hoverImagePath (string) 鼠标悬停时显示的图片路径，资源引入说明

  • autoHidePopupWindow (boolean) 是否自动关闭弹出窗口，默认值：true，失去焦点后会自动关闭

  • autoHeight (boolean)自动判断下方是否有物体，设置正确高度，默认值：false

  • coordinateType (number) 坐标系类型，取值范围：0(Projection), 1(WGS84)，如果不设置此参数，默认为0。
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
let o = {
            id: 'p1',//tag唯一标识
            coordinate: [495269.37, 2491073.25, 25.4],//坐标位置
            imagePath: HostConfig.Path + '/samples/images/tag.png',//图片路径
            imageSize: [100,100],//图片宽高[width,height]
            url: HostConfig.Path + '/samples/popup/chart.html',//鼠标点击标签后弹出的网页的URL
            popupBackgroundColor: [1.0, 1.0, 1.0, 0.1],//弹窗背景色
            range: [1, 8000.0],//标签的可见范围 [Min,Max]
            showLine: true,//标签下方是否显示垂直牵引线
            text: '北京银行',//标签显示的文字
            textSize: 10,// 文字大小
            textRange: 3000,//文字的可见范围
            textColor: Color.Black,//文字颜色
            textBackgroundColor: Color.White,//文本背景颜色
            hoverImagePath: HostConfig.Path + '/samples/images/hilightarea.png',//鼠标悬停时显示的图片路径
            autoHidePopupWindow: true, //失去焦点后会自动关闭弹出窗口
            autoHeight: true//自动判断下方是否有物体
        };
        __g.tag.add(o);

clear(fn)

删除场景中所有的Tag

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

delete(ids, fn)

删除一个或多个Tag对象

Parameters:
Name Type Description
ids string | array

要删除的Tag对象的ID或者ID数组（可以删除一个或者多个）
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

focus(ids, distance, flyTime, rotation, fn)

自动定位到合适的观察距离

Parameters:
Name Type Description
ids string | array

Tag对象的ID或者ID数组
distance number

可选参数，观察点距离目标点（被拍摄物体）的距离，取值范围：[0.01~任意正数]，如果设置为0或者不设置，系统自动计算
flyTime number

可选参数，相机飞行的时间，取值范围：[0~任意正数]，单位：秒，默认值2秒
rotation array

可选参数，相机旋转的欧拉角：[Pitch,Yaw,Roll]，数组元素类型：(number)，取值范围：Pitch[-90~90] Yaw[-180~180] Roll[0]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

focusAll(distance, flyTime, rotation, fn)

自动定位到能观察所有Tag对象的合适距离

Parameters:
Name Type Description
distance number

可选参数，观察点距离目标点（被拍摄物体）的距离，取值范围：[0.01~任意正数]，如果设置为0或者不设置，系统自动计算
flyTime number

可选参数，相机飞行的时间，取值范围：[0~任意正数]，单位：秒，默认值2秒
rotation array

可选参数，相机旋转的欧拉角：[Pitch,Yaw,Roll]，数组元素类型：(number)，取值范围：Pitch[-90~90] Yaw[-180~180] Roll[0]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

get(ids, fn)

根据ID获取Tag的详细信息

Parameters:
Name Type Description
ids string | array

要获取的Tag对象ID或者ID数组（可以获取一个或者多个）
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Example
返回Tag的详细信息
{
            "id":	"p1",
            "groupId":	"",
            "userData":	"",
            "coordinate":	[495269.375000, 2491073.250000, 25.400000],
            "imageSize":	[28.000000, 28.000000],
            "url":	"G:\\TEMP\\Explorer\\SDK\\JS/chart.html",
            "imagePath":	"G:\\TEMP\\Explorer\\SDK\\JS/images/tag.png",
            "hoverImagePath":	"G:\\TEMP\\Explorer\\SDK\\JS/images/hilightarea.png",
            "popupPos":	[0.000000, 0.000000],
            "popupSize":	[0.000000, 0.000000],
            "text":	"北京银行",
            "textColor":	[0.000000, 0.000000, 0.000000, 1.000000],
            "textBackgroundColor":	[1.000000, 1.000000, 1.000000, 1.000000],
            "popupBackgroundColor":	[1.000000, 1.000000, 1.000000, 0.100000],
            "textBorderColor":	[0.000000, 0.000000, 0.000000, 0.000000],
            "range":	[1.000000, 8000.000000],
            "textRange":	3000.000000,
            "showLine":	1,
            "autoHidePopupWindow":	1,
            "textSize":	"10"
        }

hide(ids, fn)

隐藏Tag

Parameters:
Name Type Description
ids string | array

Tag对象的ID或者ID数组
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

hideAll(fn)

隐藏所有Tag

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

hideAllPopupWindow(fn)

隐藏所有标签的弹出窗口

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

hidePopupWindow(ids, fn)

隐藏指定标签的弹出窗口

Parameters:
Name Type Description
ids string | array

标签的ID或者数组
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setAutoHidePopupWindow(id, newVal, fn)

设置是否自动关闭标签的弹出窗口

Parameters:
Name Type Description
id string

标签的唯一标识符ID
newVal boolean

是否自动关闭标签的弹出窗口
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setCoordinate(id, newVal, fn)

设置标签的位置

Parameters:
Name Type Description
id string

标签的唯一标识符ID
newVal array

新的位置坐标，取值示例
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setImagePath(id, newVal, fn)

设置标签的图片

Parameters:
Name Type Description
id string

标签的唯一标识符ID
newVal string

新的图片路径，资源引入说明
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setImageSize(id, newVal, fn)

设置标签图片的大小

Parameters:
Name Type Description
id string

标签的唯一标识符ID
newVal array

新的图片尺寸[width,height]，取值范围：[0~任意正数]
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setRange(id, newVal, fn)

设置标签的可见范围

Parameters:
Name Type Description
id string

标签的唯一标识符ID
newVal array

新的可见范围 [Min,Max]，Min和Max指摄像机相对于标签的最小和最大距离，在此范围内标签才可见，类型均为浮点数，元素取值范围：[1.0~100000.0]，单位：米
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setShowLine(id, newVal, fn)

设置标签是否显示垂直牵引线

Parameters:
Name Type Description
id string

标签的唯一标识符ID
newVal boolean

是否显示垂直牵引线
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setText(id, newVal, fn)

设置标签的文本

Parameters:
Name Type Description
id string

标签的唯一标识符ID
newVal string

新的文本值
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setTextBackgroundColor(id, newVal, fn)

设置标签文本的背景颜色

Parameters:
Name Type Description
id string

标签的唯一标识符ID
newVal Color

新的颜色值，支持四种格式，取值示例
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setTextBorderColor(id, newVal, fn)

设置标签文本的边框颜色

Parameters:
Name Type Description
id string

标签的唯一标识符ID
newVal Color

新的颜色值，支持四种格式，取值示例
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setTextColor(id, newVal, fn)

设置标签文本颜色

Parameters:
Name Type Description
id string

标签的唯一标识符ID
newVal Color

新的颜色值，支持四种格式，取值示例
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

setURL(id, newVal, fn)

设置标签的URL

Parameters:
Name Type Description
id string

标注的唯一标识符ID
newVal string

新值，资源引入说明
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

show(ids, fn)

显示Tag

Parameters:
Name Type Description
ids string | array

Tag对象的ID或者ID数组
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

showAll(fn)

显示所有Tag

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

showAllPopupWindow(fn)

显示所有标签的弹出窗口

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

showPopupWindow(ids, fn)

显示指定标签的弹出窗口

Parameters:
Name Type Description
ids string | array

标签的ID或者数组
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

update(data, fn)

修改一个或多个Tag对象

Parameters:
Name Type Description
data object | array

标签数据，参考add方法
fn function

可选的回调函数，请参考二次开发：异步接口调用方式

updateBegin()

用于批量多次修改对象的属性

在开始修改之前调用updateBegin，然后可以多次调用setXXX方法，最后调用updateEnd提交修改更新数据
注意：
updateBegin不是异步调用，不需要await，也没有回调函数参数

Inherited From:
Overrides:
Example
__g.xxx.updateBegin();
for (let i = 0; i < 1000; i++) {
     __g.xxx.setColor(i, Color.Yellow);
} 
__g.xxx.updateEnd(function () {
     log('update finished!');
});

updateEnd(fn)

用于批量多次修改对象的属性，与updateBegin配套使用
注意：
updateEnd是异步调用，可以用回调函数也可以await

Parameters:
Name Type Description
fn function

可选的回调函数，请参考二次开发：异步接口调用方式
Inherited From:
Overrides: