JSBarGraph3D

API for setting up and modifying 3D bar graph objects.

Create a API with Module.createBarGraph3D.

var object = Module.createBarGraph3D("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();

create(position, size) → boolean

Create a 3D graph object.

Information

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

• Return

  • true : Object creation successful.

  • false : Object creation failed.

• Sample

  • Refer to function createGraph.

  • Sandbox_3D Bar Graph

Template

insertColumn(name, label, color) → boolean

Adds Column information to the graph.

Information

Name	Type	Description
name	string	Column distinction name.
label	string	Column name (displayed at the bottom of the graph).
color	JSColor	Color of the graph bar.

• Return

  • true: Addition successful.

  • false: Addition failed.

• Sample

  • Refer to function createGraph.

  • Sandbox_3D Bar Graph

Template

insertRow(name, label) → boolean

Adds Row information to the graph.

Information

Name	Type	Description
name	string	Row distinction name.
label	string	Row name (displayed at the bottom of the graph).

• Return

  • true: Addition successful.

  • false: Addition failed.

• Sample

  • Refer to function createGraph.

  • Sandbox_3D Bar Graph

Template

setAnimationSpeed(speed) → boolean

Sets the animation speed of the graph bars rising.

Information

Name	Type	Description
speed	number	Animation speed of the bars rising (set between 0.1~1.0).

• Return

  • true : Speed setting successful.

  • false : Speed setting failed.

• Sample

  • Refer to function createGraph.

  • Sandbox_3D Bar Graph

Template

setColumnTextBackgroundColor(key, color) → boolean

Sets the background color of the Column label at the bottom of the graph bar.

Information

Name	Type	Description
key	string	The key of the Column for which to change the text color.
color	JSColor	Label background color.

• Return

  • true : Setting successful.

  • false : Setting failed.

Template

setColumnTextColor(key, outColor, fillColor) → boolean

Sets the background color of the Column label at the bottom of the graph bar.

Information

Name	Type	Description
key	string	The key of the Column for which to change the text color.
outColor	JSColor	Text outline color.
fillColor	JSColor	Text fill color.

• Return

  • true : Setting successful.

  • false : Setting failed.

Template

var graph = Module.createBarGraph3D("Graph");
//...
var outlineColor = new Module.JSColor(255, 255, 255);
var fillColor = new Module.JSColor(0, 0, 0);
graph.setColumnTextColor("Column0", outlineColor, fillColor);

setData(name, label, data) → boolean

Adds graph data for the specified Column and Row.

Information

Name	Type	Description
name	string	Column distinction name.
label	string	Row distinction name.
data	number	Graph input value.

• Return

  • true : Data addition successful.

  • false : Data addition failed.

• Sample

  • Refer to function createGraph.

  • Sandbox_3D Bar Graph

Template

setUnitText(unit) → boolean

Sets the unit text displayed on the graph's height axis.

Information

Name	Type	Description
unit	string	Unit display text.

• Return

  • true : Unit text setting successful.

  • false : Unit text setting failed.

• Sample

  • Refer to function createGraph.

  • Sandbox_3D Bar Graph

Template

setValueRange(min, max, value) → boolean

Sets the minimum and maximum values for the graph's height axis.

Information

Name	Type	Description
min	number	Minimum value for the height axis.
max	number	Maximum value for the height axis.
value	number	Interval for the tick marks.

• Return

  • true : Size setting successful.

  • false : Size setting failed.

• Sample

  • Refer to function createGraph.

  • Sandbox_3D Bar 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);