LabelExObj - CooSDK Documentation

new CooSDK.LabelExObj(props)

标注对象。

Name Type Description

props

Object

包含如下属性的Object：

Name	Type	Default	Description
`clusterColor`	ColorObj	`new ColorObj(1, 1, 0.0, 1.0)`	optional 聚合文字颜色。
`clusterDistance`	Number	`2000`	optional 最小聚合显示距离。
`clusterRange`	Number	`100`	optional 聚合显示范围。
`delay`	Number	`300`	optional 聚合延时,单位为毫秒。
`hoverTime`	Number	`500`	optional 悬浮时间，单位ms。
`geoPosArray`	Array.<(String\|PositionObj)>		经度,纬度,高度格式的字符数组，也可是标注经纬度坐标对象数组。
`groundLiftUp`	Number	`1`	optional 贴地抬高高度，单位m。
`infoArray`	Array.<String>	`null`	optional 标注自定义信息数组，可以存放用户自定义的信息，但字符串长度不宜过长。
`labelIdArray`	Array.<String>		标注自定义标识id数组。
`textArray`	Array.<String>		标注显示文字名称数组。
`isCluster`	Boolean	`true`	optional 标注是否聚合显示。
`isDepthTest`	Boolean	`false`	optional 是否开启深度测试。
`isHoverPick`	Boolean	`false`	optional 是否开启悬浮拾取。
`isJoinPick`	Boolean	`true`	optional 是否可以被拾取。
`isNearGround`	Boolean	`false`	optional 是否贴地。
`isTransit`	Boolean	`false`	optional 是否开启中转加载方式（一般会根据数组内容长度自动选择，若有特殊需求可开启此选项，一般不建议）。
`refreshThreshold`	Number	`0`	optional 视角高度变化聚合闸值，低于该值的视角高度变化不会触发标注聚合，设置为0则不做限制。
`pickColor`	ColorObj	`new ColorObj(1,0,0,0.5)`	optional 拾取高亮颜色。
`screen`	CooMap \| ScreenObj	`null`	optional 所属窗口，默认为CooMap所拥有的主窗口。
`textSymbol`	TextSymbol	`new TextSymbol()`	optional 文字符号。
`then`	CBOCallback		optional 对象创建完成后触发的回调事件，传出参数为LabelExObj对象本体。

Demo:

CooSDK Application 标注demo

Members

callback : CBCallback|String

获取或者设置标注被拾取后触发回调事件绑定的函数，若取消原先绑定的函数，则赋值为"none"。

Default Value: "none"

clusterColor : ColorObj

获取或者设置聚合文字颜色(RGBA)。

Default Value: new ColorObj(1, 1, 0.0, 1.0)

clusterDistance : Number

获取或者设置标注聚合最低触发距离。

Default Value: 2000

clusterRange : Number

获取或者设置聚合范围。

Default Value: 100

geoPosArray : Array.<PositionObj>

获取或者设置标注坐标对象数组。

id : Number

获取或者设置标注图层id。

infoArray : Array.<String>

获取或者设置标注自定义信息数组，可以存放用户自定义的信息，但字符串长度不可过长。

Default Value: null

isCluster : Boolean

获取或者设置标注是否聚合，否则抽稀。

Default Value: false

isDepthTest : Boolean

获取或者设置是否开启深度测试。

Default Value: false

isJoinPick : Boolean

获取或者设置是否可以被拾取。

Default Value: true

isPick : Boolean

获取或者设置是否开启拾取功能。

Default Value: false

isTransit : Boolean

获取或者设置是否开启中转加载方式（一般会根据数组内容长度自动选择，若有特殊需求可开启此选项，一般不建议）。

Default Value: false

isVisible : Boolean

获取或者设置标注显隐状态。

Default Value: true

labelIdArray : Array.<String>

获取或者设置标注自定义标识id数组。

pickColor : ColorObj

获取或者设置标注被拾取后高亮的颜色。

Default Value: new ColorObj(1,0,0,0.5)

refreshThreshold : number

获取或者设置视角高度变化聚合闸值，低于该值的视角高度变化不会触发标注聚合，设置为0则不做限制。

screen : CooMap|ScreenObj

获取或者设置所属窗口，默认为CooMap所拥有的主窗口。

Default Value: null

textArray : Array.<String>

获取或者设置标注文字名称数组。

textSymbol : TextSymbol

获取或者设置文字符号。

Default Value: new TextSymbol()

then : CBOCallback

获取或者设置对象创建完成后触发的回调事件。

Default Value: undefined

then : CBOCallback

获取或者设置对象创建完成后触发的回调事件。

Default Value: undefined

Methods

addChildLabel(geoPosArray, textArray, labelIdArray, infoArray, textSymbol, reCallback)

添加子标注。通常使用同一类TextSymbol的标注，最好在一个批次类添加（不同批次添加会影响加载速度）。

Name	Type	Default	Description
`geoPosArray`	Array.<PositionObj>		标注坐标对象数组。
`textArray`	Array.<String>		文字数组。
`labelIdArray`	Array.<String>		自定义唯一id数组。
`infoArray`	Array.<String>	`null`	optional 自定义属性信息，注意不可包含符号“;”。
`textSymbol`	TextSymbol	`null`	optional 新增标注的样式，如不设置则沿用之前样式。
`reCallback`	CBCallback		optional 添加成功后触发的回调函数。

Example:

var pos = new CooSDK.PositionObj(120.218360866, 30.2102196798, 120.4588537607);
var text = "测试性文字3";
var id = 3;
var info = "test";
textLabel.addChildTextLabel([pos], [text], [id], [info], textSym, function(){
     console.log("add success!");
});

destroy()

从场景中销毁自身。

Returns:

null 空值。

Example:

// 销毁对象
label = label.destroy();

getResult(name, reCallback) → Array.<String>

根据指定参数获取结果数组。

Name	Type	Description
`name`	EnumLabelResult	查询参数。
`reCallback`	CBCallback	optional 可传递的回调函数，返回结果数组。

Returns:

结果数组。

Example:

// 获取分析结果
var result = textLabel.getResult(CooSDK.EnumLabelResult.ID);
console.log(result);

highLightLabel(labelIdArray, isHighLight, highLightColor, reCallback)

根据指定id数组高亮标注。

Name	Type	Description
`labelIdArray`	Array.<String>	id数组。
`isHighLight`	Boolean	高亮状态。
`highLightColor`	ColorObj	高亮颜色。
`reCallback`	CBCallback	optional 高亮成功后触发的回调函数。

Example:

textLabel.highLightLabel([123],true,new ColorObj(1, 0, 0, 1));

modifyChildLabel(geoPosArray, textArray, labelIdArray, infoArray, textSymbol, reCallback)

修改子标注。通常使用同一类TextSymbol的标注，最好在一个批次类修改（不同批次修改会影响加载速度）。

Name	Type	Default	Description
`geoPosArray`	Array.<PositionObj>		标注坐标对象数组。
`textArray`	Array.<String>		文字数组。
`labelIdArray`	Array.<String>		自定义唯一id数组。
`infoArray`	Array.<String>	`null`	optional 自定义属性信息，注意不可包含符号“;”。
`textSymbol`	TextSymbol	`null`	optional 新增标注的样式，如不设置则沿用之前样式。
`reCallback`	CBCallback		optional 修改成功后触发的回调函数。

Example:

var pos = new CooSDK.PositionObj(120.218360866, 30.2102196798, 125);
var text = "测试性文字4";
var id = 5;
var info = "自定义信息修改：！"
var newTextSymbol = new CooSDK.TextSymbol({
     iconUrl: gImagePath8
})
label.modifyChildLabel([pos], [text], [id], [info], newTextSymbol, function () {
     console.log("modifyChildLabel");
});

query(labelIdArray, reCallback)

根据id数组获取其名称、位置、自定义信息等。

Name	Type	Description
`labelIdArray`	Array.<String>	待查询的id数组。
`reCallback`	AAACallback	查询成功后触发的回调函数，回传参数为([text], [position],[information])。

removeChildLabel(labelIdArray, reCallback)

根据指定id数组删除标注。

Name	Type	Description
`labelIdArray`	Array.<String>	id数组。
`reCallback`	CBCallback	optional 删除成功后触发的回调函数。

Example:

textLabel.removeChildLabel([123]);

visibleLabel(labelIdArray, bVisible, bOnlyText, reCallback)

根据指定id数组显隐标注。

Name	Type	Default	Description
`labelIdArray`	Array.<String>		id数组。
`bVisible`	Boolean		显隐状态。
`bOnlyText`	Boolean	`false`	optional 是否仅针对文字做显隐操作。
`reCallback`	CBCallback		optional 显隐成功后触发的回调函数。

Example:

textLabel.visibleLabel([123],false);