JSAnalysis

API for setting analysis functions within the map.

Can be created with the Module.getAnalysis API.

var analysis = Module.getAnalysis();

createShadow(year, month, day, hour, minute) → boolean

Creates shadows for the specified date and time.

Name

Name	Type	Description
year	number	Solar time (year).
month	number	Solar time (month).
day	number	Solar time (day).
hour	number	Solar time (hour).
minute	number	Solar time (minute).

• Return

  • true: Creation successful.

  • false: Creation failed.

Template

Module.getAnalysis.createShadow(2018, 5, 28, 15, 0);

createSlopePlane(angle, color) → boolean

Creates a slope analysis triangular plane.

Name

Name	Type	Description
angle	number	Angle from the terrain.
color	JSColor	Plane color

• Return

  • true : Object creation successful.

  • false : Object creation failed.

• Sample

  • Refer to function getSlopePlane.

  • Sandbox_Slope Analysis

Template

CreateInterpolationPath(option) → array

Returns interpolated line coordinates.

Name

Name	Type	Description
option	JSAnalysis.InterpolationOption	Start point, input points, area, number of vertices, line length

• Return

  • array : List of interpolated line coordinates returned successfully.

  • NULL : Failed to return the list of interpolated line coordinates.

• Sample

  • Refer to function createInterpolatedLine.

  • Sandbox_Line Interpolation (Curved)

Template

getGridAnal() → JSGridAnal

Returns the JSGridAnal class.

Information

• Return

  • JSGridAnal : JSGridAnal object returned successfully.

  • null : Failed to return the JSGridAnal object.

• Sample

  • Refer to function setWindRenderMode.

  • Sandbox_Wind Representation

Template

getJomangRatio(height) → string

Returns the viewshed occlusion ratio.

The input height is considered terrain below the set height, and a mountain above it.

Name

Name	Type	Description
height	number	Terrain reference height

• Return

  • Building#OcclusionRatio#Mountain#OcclusionRatio#Terrain#OcclusionRatio#Sky#OcclusionRatio

  • build#43.15#mount#17.47#terrain#35.04#sky#4.34

• Sample

  • Refer to function getJomangRatio.

  • Sandbox_View Ratio

Template

getJudong(angle) → string

Measures and returns the main building length.

The input height sets the spreading angle.

Name

Name	Type	Description
angle	number	Spreading angle

• Return

  • LayerName#ObjectKey#MainBuildingLength#Longitude#Latitude,

  • facility_build#263500000000000023630202#157.677215#129.123663#35.176768, ...

• Sample

  • Refer to function getJudong.

  • Sandbox_Main Building Length Analysis

Template

setAllObjectRenderShadow(type)

Sets whether to draw shadows for all objects regardless of selection.

Name

Name	Type	Description
type	boolean	If true, generates shadows for all objects. If false, generates shadows only for selected objects.

• Sample

  • Refer to function initPage.

  • Sandbox_Shadow

Template

setShadowSimulation(type)

Starts or stops the solar simulation.

Name

Name	Type	Description
type	boolean	If true, starts the simulation. If false, stops the simulation.

• Sample

  • Refer to function executeShadowSimulation.

  • Sandbox_Shadow

Template

setShadowSimulTerm(term)

Sets the time interval for the solar simulation progress.

Name

Name	Type	Description
term	number	Time interval setting for simulation progress (in minutes).

• Sample

  • Refer to function setShadowSimulationTimeTerm.

  • Sandbox_Shadow

Template

Module.getAnalysis.setShadowSimulTerm(30);

setShadowSimulTime(year, month, day, startHour, startMin, endHour, endMin)

Sets the solar simulation date (year, month, day), start time (hour, minute), end time (hour, minute).

Name

Name	Type	Description
year	number	Simulation year
month	number	Simulation month
day	number	Simulation day
startHour	number	Simulation start hour
startMin	number	Simulation start minute
endHour	number	Simulation end hour
endMin	number	Simulation end minute

• Sample

  • Refer to function setShadowSimulationTimeTerm.

  • Sandbox_Shadow

Template

Module.getAnalysis.setShadowSimulTime(2018, 05, 28, 9, 0, 14, 30);

setViewshedMode(apply)

Starts or stops the viewshed analysis.

Name

Name	Type	Description
apply	boolean	If true, starts the viewshed analysis. If false, stops the viewshed analysis.

Template

Type Definitions

JSAnalysis.InterpolationOption

Interpolation line coordinate creation options.

Name	Type	Attributes	Default	Description
positions	array(JSVector2D)			List of start points for the interpolated line.
input	array(Interpolation)			List of input points for interpolation calculation.
rect	Rect2D			Area for line generation.
vertexcount	number			Number of line vertices.
scale	number			Interval for line generation.