JSMultiPoint

API for creating and modifying Multi POI objects.

Create a API with Module.createMultiPoint.

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

Function

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();

setMainPoint(id, position, icon) → boolean

Creates a MultiPoint object.

Creates a main POI for visualization at the center coordinate.

Information

Name	Type	Description
id	string	id of the Multi POI object.
position	JSVector3D	Multi POI location coordinates (longitude, latitude, altitude).
icon	JSIcon	Icon for object display.

• Return

  • true: Creation successful.

  • false: Creation failed.

• Sample

  • Refer to function initPage.

  • Sandbox_MultiPoint

Template

setMainPointVisible(visible) → boolean

Sets the visibility of the Main POI.

Information

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

• Return

  • true: Object setting successful.

  • false: If the object does not exist.

Template

object.setMainPointVisible(true); // Visible On
object.setMainPointVisible(false); // Visible Off

setSpreadEffect(set) → boolean

Sets the effect of Sub POIs spreading out based on the distance between the camera and the object on/off.

When off, Sub POIs remain in a spread out state regardless of camera distance.

Information

Name	Type	Description
set	boolean	Set the effect on/off. true for on, false for off.

• Return

  • true: Object setting successful.

  • false: If the object does not exist.

Template

object.setSpreadEffect(true); // Effect On
object.setSpreadEffect(false); // Effect Off

insertSubPoint(id, icon) → boolean

Adds a MultiPoint object.

Adds a POI automatically arranged in a clockwise direction based on the central coordinate.

The key of the object is composed of (main POI name)#(name received as input).

Information

Name	Type	Description
id	string	id of the Multi POI object.
icon	JSIcon	Icon for object display.

• Return

  • true: Addition successful.

  • false: Addition failed.

• Sample

  • Refer to function createSubPoints.

  • Sandbox_MultiPoint

Template

setBar(color, altitude, width) → boolean

Creates a line connecting the terrain to the main POI location.

The altitude and width units are in meters.

Information

Name	Type	Description
color	JSColor	Color for line visualization
altitude	number	Starting height of the column
width	number	Thickness of the column

• Return

  • true: Object addition successful.

  • false: Object addition failed.

• Sample

  • Refer to function createMultiPoint.

  • Sandbox_MultiPoint

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);