JSBillboard

API for setting up and modifying billboard objects made of planes.

Create a API with Module.createBillboard.

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

Function

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

set(position, icon, width, height) → boolean

Set options for creating a billboard object.

Information

Name	Type	Description
position	JSVector3D	Billboard location (based on the bottom center point) coordinates (longitude, latitude, altitude).
icon	JSIcon	Image icon of the object.
width	number	Width of the object (in meters).
height	number	Height of the object (in meters).

• Return

  • true: Billboard option setting successful.

  • false: Billboard option setting failed.

• Sample

  • Refer to function createBillboard.

  • Sandbox_Billboard

Template

setImage(position, data, width, height) → boolean

Set options for creating a billboard object.

The data variable is based on a binary array data of Uint8Array.

Information

Name	Type	Description
position	JSVector3D	Billboard location (based on the bottom center point) coordinates (longitude, latitude, altitude).
data	array	Image binary data.
width	number	Width of the image.
height	number	Height of the image.

• Return

  • true: Billboard option setting successful.

  • false: Billboard option setting failed.

• Sample

  • Refer to function createBillboard.

  • Sandbox_Billboard Text

Template

setSizeScale(x, y, z) → boolean

Set the scale of the object's representation.

Each value must be set to a number greater than 0.

Information

Name	Type	Description
x	number	Scale along the x-axis.
y	number	Scale along the y-axis.
z	number	Scale along the z-axis.

• Return

  • true: Billboard option setting successful.

  • false: Billboard option setting failed.

Template

setSizeFix(type) → boolean

Set the object's size to be fixed or variable.

Information

Name	Type	Description
type	boolean	true for fixed size mode, false for variable size mode.

• Return

  • true: Billboard size option setting successful.

  • false: Billboard size option setting failed.

• Sample

  • Refer to function setBillboardFixSize.

  • Sandbox_Billboard Size Option

Template

setRotationMode(type) → boolean

Set the directional representation of the billboard object.

Information

Name	Type	Description
type	boolean	true for screen-facing fixed mode. false for fixed horizontal and variable vertical rotation mode.

• Return

  • true: Billboard rotation option setting successful.

  • false: Billboard rotation option setting failed.

• Sample

  • Refer to function setBillboardRotationMode.

  • Sandbox_Billboard Rotation Option

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