SunlightAnalysis

new CooSDK.SunlightAnalysis(props)

日照分析是用来分析指定区域在指定时间段内的日照情况，常用于建筑规划等需求。


日照分析效果图
Name Type Description
props Object optional

包含如下属性的Object：

Name Type Default Description
callback NNCallback | String "none" optional

退让分析完成时回调事件绑定的函数。
customInfo String "" optional

自定义信息。
day Number 2 optional

日照日期所在日。
endHour Number 18 optional

日照结束播放的终止小时。
endMinute Number 0 optional

日照结束播放的终止分钟。
isPoint Boolean false optional

是否进行单点日照分析。
isVisible Boolean true optional

分析显隐开关。
isWorld Boolean false optional

是否为世界坐标点。默认为经纬度坐标。
lineColor ColorObj new ColorObj(0,1,0,1.0) optional

线颜色。
minPerFrame Number 1.0 optional

每帧跨越多少分钟，分钟/帧。
month Number 2 optional

日照日期所在月份。
nonIntersectArray Array.<EnumLayer> [EnumLayer.ANALYSIS] optional

分析与场景哪些类型图层数据不相交。默认为分析类，即与除分析之外所有图层数据都相交。
playStatus EnumPathPlayStatus EnumPathPlayStatus.PLAY optional

日照播放状态。
point PositionObj null optional

单点日照的坐标。
pointColor ColorObj new ColorObj(1,0,0,1.0) optional

点颜色。
pointSize Number 5 optional

点大小。
screen CooMap | ScreenObj null optional

所属窗口，默认为CooMap所拥有的主窗口。
startHour Number 6 optional

日照开始播放的起始小时。
startMinute Number 0 optional

日照开始播放的起始分钟。
year Number 2020 optional

日照日期所在年份。
Example:
// 创建后请在场景中点击绘制一个区域
var sunlightAnalysis = new CooSDK.SunlightAnalysis();
Demo:

Members

callback : NNCallback|String

获取或者设置退让分析完成时回调事件绑定的函数,若取消原先绑定的函数，则赋值为"none"

Default Value: "none"

customInfo : String

获取或者设置自定义信息。

Default Value: ""

day : Number

日照日期所在日。

Default Value: 2

endHour : Number

日照结束播放的终止小时。

Default Value: 18

endMinute : Number

日照结束播放的终止分钟。

Default Value: 0

isPoint : Boolean

是否进行单点日照分析。

Default Value: false

isVisible : Boolean

获取或者设置分析显隐状态。

Default Value: true

isWorld : Boolean

是否为世界坐标点。默认为经纬度坐标。

Default Value: false

lineColor : ColorObj

线颜色。

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

minPerFrame : Number

每帧跨越多少分钟，分钟/帧。

Default Value: 1.0

month : Number

日照日期所在月份。

Default Value: 2

nonIntersectArray : Array.<EnumLayer>

分析与场景哪些类型图层数据不相交。默认为分析类，即与除分析之外所有图层数据都相交。

Default Value: [EnumLayer.ANALYSIS]

playStatus : EnumPathPlayStatus

日照播放状态。

Default Value: EnumPathPlayStatus.PLAY

point : PositionObj

单点日照的坐标。

Default Value: null

pointColor : ColorObj

获取或者设置点颜色(RGBA)。

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

pointSize : Number

点大小。

Default Value: 5.0

screen : CooMap|ScreenObj

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

Default Value: null

startHour : Number

日照开始播放的起始小时。

Default Value: 6

startMinute : Number

日照开始播放的起始分钟。

Default Value: 0

year : Number

日照日期所在年份。

Default Value: 2020

Methods

deserialize(url) → SunlightAnalysis

Name Type Description
url String

反序列化文件保存路径，支持本地路径和网络路径。
Returns:

日照分析对象。

destroy()

从场景中销毁自身。

Returns:

null 空值。

Example:
// 销毁对象
sunlightAnalysis = sunlightAnalysis.destroy();

getResult(name, reCallback) → String

根据指定参数获取分析结果。

Name Type Description
name EnumAnalysisSunlight

查询参数。
reCallback CBCallback optional

可传递的回调函数，返回查询结果。
Returns:

查询结果。

Example:
// 获取分析结果
var result = sunlightAnalysis.getResult(CooSDK.EnumAnalysisSunlight.POINTS);
console.log(result);

serialize(url)

Name Type Description
url String

序列化文件保存路径，仅支持本地路径。

update(props)

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

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

Name Type Description
props Object optional

包含如下属性的Object：

Name Type Description
callback NNCallback | String optional

退让分析完成时回调事件绑定的函数。
customInfo String optional

自定义信息。
day Number optional

日照日期所在日。
endHour Number optional

日照结束播放的终止小时。
endMinute Number optional

日照结束播放的终止分钟。
isPoint Boolean optional

是否进行单点日照分析。
isVisible Boolean optional

分析显隐开关。
isWorld Boolean optional

是否为世界坐标点。默认为经纬度坐标。
lineColor ColorObj optional

线颜色。
minPerFrame Number optional

每帧跨越多少分钟，分钟/帧。
month Number optional

日照日期所在月份。
nonIntersectArray Array.<EnumLayer> optional

分析与场景哪些类型图层数据不相交。默认为分析类，即与除分析之外所有图层数据都相交。
playStatus EnumPathPlayStatus optional

日照播放状态。
point PositionObj optional

单点日照的坐标。
pointColor ColorObj optional

点颜色。
pointSize Number optional

点大小。
startHour Number optional

日照开始播放的起始小时。
startMinute Number optional

日照开始播放的起始分钟。
year Number optional

日照日期所在年份。
Example:
sunlightAnalysis.update({
   playStatus: CooSDK.EnumPathPlayStatus.STOP
});