JSTimeSeriesObject

API for creating and modifying time series objects.

Create a API with Module.createTimeSeriesObject.

After creation, initialize time series data by passing parameters to the create() or createbyJson() API.

When data updates are needed, call the insert(), then merge() functions to update the data.

let object = Module.createTimeSeriesObject("ID");

// For detailed parameters, refer to the API documentation
object.create(/*parameter*/);
// ... or ...
object.createJSON(/*parameter*/);
// ... or ...
object.insert(/*parameter*/);
// ... or ...
object.merge(/*parameter*/);

Function

create(parameter) → object

Creates a time series object.

Passes the entire data (image, latitude and longitude reference points, object size, object shape) via the parameter variable.

Information

Name	Type	Description
parameter	JSTimeSeriesObject.ObjectData	Entire data.

• Return

  • .result: API success status (1: Success, 0: Failure).

  • .name: Operating API name.

  • .return: Includes Error message if item exists

Template

createbyJson(parameter) → object

Creates a time series object.

Passes the entire data (image, latitude and longitude reference points, object size, object shape) via the parameter variable.

Information

Name	Type	Description
parameter	JSTimeSeriesObject.ObjectData	Entire data.

• Return

  • .result: API success status (1: Success, 0: Failure).

  • .name: Operating API name.

  • .return: Includes Error message if item exists

Template

insert(parameter) → object

Inputs additional object information.

Afterwards, calling merge() is necessary to add the input data to the existing object.

Passes the entire data (image, latitude and longitude reference points, object size, object shape) via the parameter variable.

Information

Name	Type	Description
parameter	JSTimeSeriesObject.ObjectData	Entire data.

• Return

  • .result: API success status (1: Success, 0: Failure).

  • .name: Operating API name.

  • .return: Includes Error message if item exists

Template

merge() → object

Function to add data inputted by insert() to the existing object.

Information

• Return

  • .result: API success status (1: Success, 0: Failure).

  • .name: Operating API name.

  • .return: Includes Error message if item exists

Template

Type Definitions

JSTimeSeriesObject.ObjectData

Name	Type	Attributes	Default	Description
position	JSVector3D			3D coordinates (latitude, longitude, altitude)
segment	number	optional	4	Polygon shape (2 for plane, 3 for triangle, 4 for square, 5 for pentagon)
rotate	number	optional	0	Object rotation direction (0,360: north, 90: east, 180: south, 270: west)
horizontal	number	optional	5.0	Object size setting during create API operation (horizontal)
vertical	number	optional	5.0	Object size setting during create API operation (vertical)
shape	number	optional	0	Object shape (0: polygon, 1: plane)
color	JSColor	optional	JSColor(255, 255, 255, 255)	Main color of the object.
area	JSTimeSeriesObject.AreaData	optional		Object size (necessary for texture computation).
image	JSTimeSeriesObject.ImageData			Image data.
legend	JSTimeSeriesObject.Legend	optional	JSColor(255, 255, 255, 255)	About Creating Legends.

JSTimeSeriesObject.AreaData

Name	Type	Attributes	Default	Description
min	JSVector3D	optional	JSVector3D(0, 0, 0)	Minimum 3D coordinates (latitude, longitude, altitude)
max	JSVector3D	optional	JSVector3D(0, 0, 0)	Maximum 3D coordinates (latitude, longitude, altitude)

JSTimeSeriesObject.ImageData

Name	Type	Description
width	number	Image width.
height	number	Image height.
image	array	Image pixel data (pixel data obtained from CanvasRenderingContext2D.getImageData() on a canvas).

JSTimeSeriesObject.Legend

Legend data. Store multiple data and color items grouped together in an array.

Name	Type	Description
data	number	Size of the legend.
color	JSColor or array (array defining argb with four floats)	Color of the legend.