JSSurfaceGraph

API for creating and modifying 3D mesh grid graph objects.

Creates a 3D mesh grid graph object using the Module.createPointGraph API.

var object = Module.createSurfaceGraph("ID");

Function

create(position, size) → boolean

Creates the graph.

Information

Name	Type	Description
position	JSVector3D	Graph location coordinates (longitude, latitude, altitude).
size	JSSize3D	Size of the mesh grid graph.

• Return

  • true: creation successful.

  • false: creation failed.

• Sample

  • Refer to the createGraph function.

  • Sandbox_Surface Graph

Template

getId() → string

Returns the ID of the object.

Information

• Return

  • string: Successful return of the object's Key string.

  • null: If the object is null.

Template

lat strKey = object.getId();

insertAxisPoint(axis, value) → boolean

Adds tick values to the list for the X and Y axes.

Information

Name	Type	Description
axis	number	Axis type. 0: X-axis. 1: Y-axis
value	number	Tick value.

• Return

  • true: Addition successful.

  • false: Addition failed.

• Sample

  • Refer to the createGraph function.

  • Sandbox_Surface Graph

Template

insertLegend(value, color) → boolean

Sets the legend position value and color.

Information

Name	Type	Description
value	number	Legend section value.
color	JSColor	Legend color.

• Return

  • true: Addition successful.

  • false: Addition failed.

• Sample

  • Refer to the createGraph function.

  • Sandbox_Surface Graph

Template

setAnimationSpeed(speed) → boolean

Sets the animation playback speed for the 3D mesh grid graph.

Information

Name	Type	Description
speed	number	Bar rising animation speed (set values between 0.1 and 1.0)

• Return

  • true : Setting successful.

  • false : Setting failed.

• Sample

  • Refer to the createGraph function.

  • Sandbox_Surface Graph

Template

setData(x, y, value) → boolean

Adds data to compose the 3D mesh grid graph.

Information

Name	Type	Description
x	number	X-axis tick value.
y	number	Y-axis tick value.
value	number	Data.

• Return

  • true : Setting successful.

  • false : Setting failed.

• Sample

  • Refer to the createGraph function.

  • Sandbox_Surface Graph

Template

setValueRange(min, max, interval) → boolean

Sets the height axis range for the 3D mesh grid graph.

Information

Name	Type	Description
min	number	Axis minimum value.
max	number	Axis maximum value.
interval	number	Graph tick mark display interval (input values greater than 0.0).

• Return

  • true : Setting successful.

  • false : Setting failed.

• Sample

  • Refer to the createGraph function.

  • Sandbox_Surface Graph

Template

setUnitText(text) → boolean

Sets the unit display text for the height axis of the 3D mesh grid graph.

Information

Name	Type	Description
text	string	Unit display text.

• Return

  • true : Setting successful.

  • false : Setting failed.

• Sample

  • Refer to the createGraph function.

  • Sandbox_Surface Graph

Template

Getter / Setter

getDescription(), setDescription(desc) → string

Set a description for the object.

Information

Name	Type	Description
desc	string	Object description string.

• Return

  • string: Successful return of the object's description string.

  • null: If the object is null.

Template

var strDesc = object.getDescription();
// ... or ...
object.setDescription("First Object.");

getName(), setName(name) → string

Sets the name of the object.

Information

Name	Type	Description
name	string	The name to set for the object.

• Return

  • string: Successful return of the object's name.

  • null: If the object is null.

Template

var objName = object.getName();
// ... or ...
object.setName("MyObject");

getVisible(), setVisible(visible) → boolean

Sets the visibility state of an object.

Information

Name	Type	Description
visible	boolean	true: Make the object visible. false: Hide the object.

• Return

  • true: Object visible state.

  • false: Object hidden state.

Template

var objName = object.getName();
// ... or ...
object.setVisible(true);