HighlightProvider - CooSDK Documentation

new CooSDK.HighlightProvider(props)

高亮指定数据，仅针对Data类数据。

Name Type Description

props

Object

optional

包含如下属性的Object：

Name	Type	Default	Description
`callback`	CBCallback \| String	`"none"`	optional 高亮倾斜摄影时的回调事件。当dataType值为EnumDataType.OSGB_OBJ时，高亮成功会返回true，失败则会返回false；当dataType值为EnumDataType.OSGB_FEATURE_OBJ时，高亮成功会返回经纬度坐标，失败则不会触发该函数。
`color`	ColorObj	`new ColorObj(1, 0.2, 0.2, 0.3)`	optional 高亮颜色。
`dataArray`	Array.<(ModelData\|OsgbData\|FeatureModelData)>	`[EnumCooMap.ALL_DATA]`	optional Data类数据对象的数组，这里仅支持ModelData、OsgbData和FeatureModelData。
`dataType`	EnumDataType	`EnumDataType.DATA_ALL`	optional 需要高亮的data数据类型。
`faultTolerantValue`	Number	`0.0`	optional 容错值大小，仅在dataType值为EnumData.FEATURE_OBJ时生效。
`fieldInfo`	String	`null`	optional 属性字段及属性值，格式:"属性字段:属性值"，如:"id:JZ1"。仅在dataType值为EnumData.OSGB_FEATURE_OBJ时生效。
`geoPos`	PositionObj	`null`	optional 相交点经纬度坐标，在dataType值为EnumDataType.DATA_ALL时不生效。
`isContinuous`	Boolean	`false`	optional 是否开启高亮失败后尝试重新高亮。
`isLight`	Boolean	`true`	optional 是否高亮。
`isFaultTolerant`	Boolean	`false`	optional 是否启用容差，仅在dataType值为EnumData.FEATURE_OBJ时生效。
`screen`	CooMap \| ScreenObj	`null`	optional 所属窗口，默认为CooMap所拥有的主窗口。
`triggerNum`	Number	`5`	optional 高亮失败后尝试重新高亮次数上限，单位：次。
`triggerTime`	Number	`500`	optional 高亮失败后尝试重新高亮间隔，单位：毫秒。

Example:

// 创建ModelData
var modelData = new CooSDK.ModelData({
     url: gModelDataUrl,
     isLocate: true
});
// 创建FeatureModelData
var fmData = new CooSDK.FeatureModelData({
     url: gFeatureModelPolygonUrl,
     liftUp: 15.3,
     polygonSymbol: new CooSDK.PolygonSymbol(),
     buildGeometryFilter: "PolygonSymbol",
     isLocate: true
});
// 根据id高亮数据整体
var provider = new CooSDK.HighlightProvider({
     dataArray: [modelData]
});
// 根据坐标高亮人工模型数据单个对象
var provider1 = new CooSDK.HighlightProvider({
     dataType: CooSDK.EnumDataType.MODEL_OBJ,
     dataArray: [modelData],
     geoPos: geoPos
});
// 根据坐标高亮矢量数据要素对象
var provider2 = new CooSDK.HighlightProvider({
     dataType: CooSDK.EnumDataType.FEATURE_OBJ,
     geoPos: geoPos,
     dataArray: [fmData]
});

Demo:

CooSDK Application 数据高亮demo

Members

callback : CBCallback|String

获取或者设置高亮倾斜摄影时的回调事件。当dataType值为EnumDataType.OSGB_OBJ时，高亮成功会返回true，失败则会返回false；当dataType值为EnumDataType.OSGB_FEATURE_OBJ时，高亮成功会返回经纬度坐标，失败则不会触发该函数。

Default Value: "none"

color : ColorObj

获取或者设置高亮颜色。

Default Value: new ColorObj(1, 0.2, 0.2, 0.2)

dataArray : Array.<(ModelData|OsgbData|FeatureModelData)>

获取或者设置Data类数据对象的数组，这里仅支持ModelData、OsgbData和FeatureModelData。

Default Value: [EnumCooMap.ALL_DATA]

dataType : EnumDataType

获取或者设置需要高亮的data数据类型。

Default Value: EnumDataType.DATA_ALL

faultTolerantValue : Number

获取或者设置容错值大小，，仅在dataType值为EnumData.FEATURE_OBJ时生效。

Default Value: 0.0

fieldInfo : String

获取或者设置属性字段及属性值，格式:"属性字段:属性值"，如:"id:JZ1"。仅在dataType值为EnumData.OSGB_FEATURE_OBJ时生效。

Default Value: null

geoPos : PositionObj

获取或者设置相交点经纬度坐标，在dataType值为EnumDataType.DATA_ALL时不生效。

Default Value: null

isContinuous : Boolean

获取或者设置是否开启高亮失败后尝试重新高亮。

Default Value: false

isFaultTolerant : Boolean

获取或者设置是否启用容差，仅在dataType值为EnumData.FEATURE_OBJ时生效。

Default Value: false

isLight : Boolean

获取或者设置是否高亮。

Default Value: true

screen : CooMap|ScreenObj

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

Default Value: null

triggerNum : Number

获取或者设置高亮失败后尝试重新高亮次数上限，单位：次。

Default Value: 5

triggerTime : Number

获取或者设置高亮失败后尝试重新高亮间隔，单位：毫秒。

Default Value: 500

Methods

destroy()

从场景中销毁自身。

Returns:

null 空值。

Example:

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

update(props)

更新单个或者多个对象属性，使之立即生效。

一般用于多个属性的同时更新，避免性能开销过大。

Name Type Description

props

Object

optional

包含如下属性的Object：

Name	Type	Description
`callback`	CBCallback \| String	optional 高亮倾斜摄影时的回调事件。当dataType值为EnumDataType.OSGB_OBJ时，高亮成功会返回true，失败则会返回false；当dataType值为EnumDataType.OSGB_FEATURE_OBJ时，高亮成功会返回经纬度坐标，失败则不会触发该函数。
`color`	ColorObj	optional 高亮颜色。
`dataArray`	Array.<(ModelData\|OsgbData\|FeatureModelData)>	optional Data类数据对象的数组，这里仅支持ModelData、OsgbData和FeatureModelData。
`dataType`	EnumDataType	optional 需要高亮的data数据类型。
`faultTolerantValue`	Number	optional 容错值大小，仅在dataType值为EnumData.FEATURE_OBJ时生效。
`fieldInfo`	String	optional 属性字段及属性值，格式:"属性字段:属性值"，如:"id:JZ1"。仅在dataType值为EnumData.OSGB_FEATURE_OBJ时生效。
`geoPos`	PositionObj	optional 相交点经纬度坐标，在dataType值为EnumDataType.DATA_ALL时不生效。
`isFaultTolerant`	Boolean	optional 是否启用容差，仅在dataType值为EnumData.FEATURE_OBJ时生效。
`isLight`	Boolean	optional 是否高亮。

Example:

// 更新高亮颜色
highlightProvider.update({
   color: new CooSDK.ColorObj(1, 0.2, 0.2, 0.9)
});