The sunlight analysis class is used for conducting sunlight analysis and obtaining the results.
Name | Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
optional
The object has the following properties:
|
Members
-
Get or set the display mode of the analysis results, including sunlight ratio or shadow ratio.
-
Get the current status of whether the analysis is enabled.
-
endTime : JulianDate
-
Set the end time of sunlight analysis.
-
startTime : JulianDate
-
Set the start time of sunlight analysis.
-
Set or get the visual color for the shadow area, where the alpha value is used to adjust the color blending cofficient. The default color value is (0.0, 0.0, 1.0, 0.7).
See:
Methods
-
Clear the analysis results.
-
Asynchronously get the total duration for which the current location is in sunlight or shadow.
Name Type Description windowPosition
Cartesian2 Window coordinates. Returns:
The total duration for which current location is in shade, with the unit being seconds. -
Start analysis.
-
Set the color table.
Name Type Description colorTable
ColorTable Color table object.