Class: FdSunshine

var viewer = Freedo.FdApp.createDefaultViewer("freedoContainer");

var sunshine = new Freedo.FdTools.FdSunshine(viewer);
sunshine.start();

// 更新方法：
sunshine.update({
   date: '2020/1/1', // 分析日期
   startTime: '8:00', // 开始时间
   endTime: '12:00', // 结束时间
   height: 5, // 分析区域的高度
   extrudedHeight: 12 // 分析区域的拉伸高度
});

// 显示进度条：
sunshine.showProgress = true; // 默认false（不显示）

// 销毁：
sunshine.destroy();

Members

---

date :Date

日期

Type:

• Date

---

endTime :String

结束时间

Type:

• String

---

extrudedHeight :Number

拉伸高度

Type:

• Number

---

height :Number

底部高度

Type:

• Number

---

showLegend :Number

显示/隐藏图例

Type:

• Number

---

showProgress :Boolean

显示分析进度

Type:

• Boolean

---

startTime :String

开始时间

Type:

• String

Methods

---

destroy()

销毁

---

on(listener [, scope])

注册事件捕捉

Parameters:

Name	Type	Argument	Description
listener	FdTools.FdSunshine~FdSunshineCallback		当有事件触发时被执行的函数。
scope	Object	<optional>	listener函数执行时的绑定的对象。

Returns:

返回一个函数，调用该函数可以取消监听。

Type

Freedo.Event~RemoveCallback

---

remove()

销毁

---

start()

开始日照分析

---

update(option)

更新日照分析

Parameters:

Name	Type	Description
option	Object	更新选项，可能是以下值： Properties Name Type Argument Description date String <optional> 开始分析的日期，如：'2010/01/01' 或 '2010-1-1' startTime String <optional> 分析起始时间，如：'08:10' endTime String <optional> 分析结束时间，如：'12:40'。当结束时间大于起始时间时，结束时间是当天的时间；否则，结束时间为第二天的时间 height Number <optional> 分析区域的底部高度 extrudedHeight Number <optional> 分析区域的拉伸高度

Type Definitions

---

FdSunshineCallback(eventType, eventArg)

Parameters:

Name	Type	Description
eventType	String	事件类型有以下几种：Start（开始）/ AnaFinished（分析完成）/ProgressChanged（分析进度）
eventArg	Object	Start 无返回值，AnaFinished 返回分析结果，ProgressChanged 时间返回分析进度（数值0 ~ 1）