JSGhostSymbol

API for creating and modifying ghost symbol objects.

Create a API with Module.createGhostSymbol.

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

Function

getBasePointX() → number

Returns the X-axis offset value based on the center coordinates of the ghost symbol.

Information

• Return

  • X-axis offset value (in meters).

• Sample

  • Refer to function displayGhostSymbolProperties.

  • Sandbox_Ghost Symbol Editing

Template

getBasePointY() → number

Returns the Y-axis offset value based on the center coordinates of the ghost symbol.

Information

• Return

  • Y-axis offset value (in meters).

• Sample

  • Refer to function displayGhostSymbolProperties.

  • Sandbox_Ghost Symbol Editing

Template

getBasePointZ() → number

Returns the Z-axis offset value based on the center coordinates of the ghost symbol.

Information

• Return

  • Z-axis offset value (in meters).

• Sample

  • Refer to function displayGhostSymbolProperties.

  • Sandbox_Ghost Symbol Editing

Template

getDescription() → string

Returns the description of the object.

Information

• Return

  • string: Successful return of the object description string.

  • null: If the object is null.

Template

var strDesc = object.getDescription();

getGhostSymbolMapKey() → string

Returns the referenced object name of the ghost symbol.

Information

• Return

  • string: Successful return of the referenced object name of the ghost symbol.

  • null: Failure to return the name.

Template

getId() → string

Returns the Key of the object.

Information

• Return

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

  • null: If the object is null.

Template

var strKey = object.getId();

getPosition() → JSVector3D

Returns the latitude and longitude position of the ghost symbol object.

Information

• Return

  • JSVector3D: Returns the centroid coordinates (longitude, latitude, altitude) of the ghost symbol successfully.

  • null: Coordinate return failed.

• Sample

  • Refer to function displayGhostSymbolProperties.

  • Sandbox_Ghost Symbol Editing

Template

getRotationX() → number

Returns the X-axis rotation angle of the ghost symbol object.

Information

• Return

  • X-axis rotation angle.

• Sample

  • Refer to function displayGhostSymbolProperties.

  • Sandbox_Ghost Symbol Editing

Template

getRotationY() → number

Returns the Y-axis rotation angle of the ghost symbol object.

Information

• Return

  • Y-axis rotation angle.

• Sample

  • Refer to function displayGhostSymbolProperties.

  • Sandbox_Ghost Symbol Editing

Template

getRotationZ() → number

Returns the Z-axis rotation angle of the ghost symbol object.

Information

• Return

  • Z-axis rotation angle.

• Sample

  • Refer to function displayGhostSymbolProperties.

  • Sandbox_Ghost Symbol Editing

Template

getScale() → JSSize3D

Returns the size of the ghost symbol object.

Information

• Return

  • JSSize3D: Successful return of the ghost symbol size (x,y,z).

  • null: Failure to return size.

• Sample

  • Refer to function displayGhostSymbolProperties.

  • Sandbox_Ghost Symbol Editing

Template

moveVertically(alt) → boolean

Moves the object vertically (up/down).

Information

Name	Type	Description
alt	number	Vertical movement distance of the object.

• Return

  • true: Successful specification of movement distance.

  • false: Failure to specify movement distance.

Template

var newGhostSymbol = Module.createGhostSymbol("newGhostSymbol");
newGhostSymbol.moveVertically(150.0);

setBasePoint(x, y, z) → boolean

Sets the movement based on the center coordinates of the ghost symbol by the input values.

Information

Name	Type	Description
x	number	X-axis movement value (in meters).
y	number	Y-axis movement value (in meters).
z	number	Z-axis movement value (in meters).

• Return

  • true: Successful object setting.

  • false: Failed object setting.

• Sample

  • Refer to function setBasePoint.

  • Sandbox_Ghost Symbol Editing

Template

setGhostSymbol(name) → boolean

Specifies the object model registered in the ghost symbol map.

Information

Name	Type	Description
name	string	Name of the registered object.

• Return

  • true: Successful object setting.

  • false: Failed object setting.

• Sample

  • Refer to function createGhostSymbol.

  • Sandbox_Ghost Symbol Editing

Template

setPosition(position) → boolean

Sets the position of the ghost symbol object.

Information

Name	Type	Description
position	JSVector3D	Ghost symbol location coordinates (longitude, latitude, altitude).

• Return

  • true: Setting successful.

  • false: Setting failed.

• Sample

  • Refer to function createGhostSymbol.

  • Sandbox_Ghost Symbol Editing

Template

setScale(scale) → boolean

Sets the size of the ghost symbol object.

Input values for scale(x,y,z) must be greater than 0.

Initial size setting for x,y,z is (1,1,1).

Information

Name	Type	Description
scale	JSSize3D	Size setting for the ghost symbol.

• Return

  • true: Successful object setting.

  • false: Failed object setting.

• Sample

  • Refer to function createGhostSymbol.

  • Sandbox_Ghost Symbol Editing

Template

setRotation(x, y, z) → boolean

Sets the rotation angles of the ghost symbol object.

Information

Name	Type	Description
x	number	Rotation angle change on the X-axis.
y	number	Rotation angle change on the Y-axis.
z	number	Rotation angle change on the Z-axis.

• Return

  • true: Successful object setting.

  • false: Failed object setting.

• Sample

  • Refer to function setRotation.

  • Sandbox_Ghost Symbol Editing

Template

Getter / Setter

getColor(), setColor(color) → JSColor

Sets the color of the object.

Information

Name	Type	Description
color	JSColor	Color of the object

• Return

  • The color of the object

Template

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

getOpacity(), setOpacity(opacity) → number

Sets the opacity of the object.

Information

Name	Type	Description
opacity	number	Opacity of the object

• Return

  • The opacity of the object

Template

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