JSPointGraph
API for creating and modifying point graph objects.
Create a API with Module.createPointGraph.
var object = Module.createPointGraph("ID");
Function
create(position, size) → boolean
Creates a point graph.
Return
true: Creation successful.
false: Creation failed.
Sample
Refer to the createGraph function.
getId() → string
Returns the ID of the object.
Return
string: Successful return of the object's Key string.
null: If the object is null.
insertData(x, y, z, value) → boolean
Adds graph pointer data.
x
number
x-axis position.
y
number
y-axis position.
z
number
z-axis position.
value
number
Data value.
Return
true: Addition successful.
false: Addition failed.
Sample
Refer to the createGraph function.
insertLegend(value, color) → boolean
Sets values and colors for the graph legend.
value
number
Legend section value.
Return
true: Addition successful.
false: Addition failed.
Sample
Refer to the createGraph function.
setAxisRange(axis, min, max, interval) → boolean
Sets the range and tick mark interval for the x, y, z axes of the graph.
axis
number
Axis type (0: X-axis, 1: Y-axis, 2: Z-axis).
min
number
Minimum value of the axis.
max
number
Maximum value of the axis.
interval
number
Tick mark interval on the graph.
Return
true: Setting successful.
false: Setting failed.
Sample
Refer to the createGraph function.
setPointLineVisible(type) → boolean
Sets the visibility of lines connecting the point graph to the terrain.
type
boolean
true: Lines visible false: Default visibility.
Return
true: Setting successful.
false: Setting failed.
Sample
Refer to the createGraph function.
Getter / Setter
getDescription(), setDescription(desc) → string
Set a description for the object.
desc
string
Object description string.
Return
string: Successful return of the object's description string.
null: If the object is null.
getName(), setName(name) → string
Sets the name of the object.
name
string
The name to set for the object.
Return
string: Successful return of the object's name.
null: If the object is null.
getVisible(), setVisible(visible) → boolean
Sets the visibility state of an object.
visible
boolean
true: Make the object visible. false: Hide the object.
Return
true: Object visible state.
false: Object hidden state.
Last updated