Module

Functions responsible for creating and controlling the map.

The basic map can be created through Module.initialize.

Other Classes can be created and used through Module.

The worker item added to Function initialize will be supported in the beta version engine from February 1, 2024. It uses 'XDWorldWorker.js' and 'XDWorldWorker.wasm' provided with the engine to distribute and process the load that can occur in the engine.

Module.initialize({
    container: document.querySelector("Container ID"),
    terrain: {
        dem: {
            url: "Terrain DEM data request URL",
            name: "Terrain DEM layer name",
            servername: "Request Server name",
        },
        image: {
            url: "Terrain image data request URL",
            name: "Terrain image layer name",
            servername: "Request Server name",
        },
        worker: {
            use: "Use of web worker",
            path: "Web worker file request URL",
            count: "Set the number of web workers to use",
        },
    },
    defaultKey: "Issued key",
});

Function

initialize(object) -> object

Creates a map.

Activates the web worker feature through the worker item option.

Information

Name	Type	Description
container	HTML Element	Container area containing the map.
terrain	Module.CreateOptions	Map creation information.
worker	Module.CreateWorkerOptions	Web worker creation information.
defaultKey	string	Engine API issued Key

• Return

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

  • .name : Operating API name

  • .return : API return information (object: normal return value, string: failure error code)

Template

// Use sandbox
Module.initialize({
    container: document.getElementById("map"),
    terrain: {
        dem: {
            url: "https://xdworld.vworld.kr",
            name: "dem",
            servername: "XDServer3d",
            encoding: true,
        },
        image: {
            url: "https://xdworld.vworld.kr",
            name: "tile_mo_HD",
            servername: "XDServer3d",
        },
    },
    worker: {
        use: true,
        path: "./worker/XDWorldWorker.js",
        count: 5,
    },
    defaultKey: "Issued key",
});

createBarGraph(id) → JSBarGraph

Creates and returns a 2D bar graph object.

Information

Name	Type	Description
id	string	Created object ID name.

• Return

  • JSBarGraph: Object creation success.

  • null: Object creation failure.

Template

let object = Module.createBarGraph("newBarGraph");

createBarGraph3D(id) → JSBarGraph3D

Creates and returns a 3D bar graph object.

Information

Name	Type	Description
id	string	Created object ID name.

• Return

  • JSBarGraph3D: Object creation success.

  • null: Object creation failure.

Template

let object = Module.createBarGraph3D("newBarGraph3D");

createBillboard(id) → JSBillboard

Creates and returns a billboard object.

Information

Name	Type	Description
key	string	Key of the object being created.

• Return

  • JSBillboard: Object creation success.

  • null: Object creation failure.

Template

let object = Module.createBillboard("newBillboard");

createGhostSymbol(id) → JSGhostSymbol

Creates and returns a ghost symbol object.

Information

Name	Type	Description
id	string	Created object ID name.

• Return

  • JSGhostSymbol: Object creation success.

  • null: Object creation failure.

Template

let ghostSymbol = Module.createGhostSymbol("newGhostSymbol");

createLineString(id) → JSLineString

Creates and returns a line object.

Information

Name	Type	Description
id	string	Created object ID name.

• Return

  • JSLineString: Object creation success.

  • null: Object creation failure.

Template

let object = Module.createLineString("newPolyLine");

createMultiPoint(id) → JSMultiPoint

Creates and returns a multipoint object.

Information

Name	Type	Description
id	string	Created object ID name.

• Return

  • JSMultiPoint: Object creation success.

  • null: Object creation failure.

Template

let object = Module.createMultiPoint("newMultiPoint");

createPipe(id) → JSPipe

Creates and returns a pipe object.

Information

Name	Type	Description
id	string	Created object ID name.

• Return

  • JSPipe: Object creation success.

  • null: Object creation failure.

Template

let object = Module.createPipe("newPipe");

createPoint(id) → JSPoint

Creates and returns a POI object.

Information

Name	Type	Description
id	string	Created object ID name.

• Return

  • JSPoint: Object creation success.

  • null: Object creation failure.

Template

let object = Module.createPoint("newPoint");

createPointGraph(id) → JSPointGraph

Creates and returns a 3D point graph object.

Information

Name	Type	Description
id	string	Created object ID name.

• Return

  • JSPointGraph: Object creation success.

  • null: Object creation failure.

Template

let object = Module.createPointGraph("newGraph");

createSurfaceGraph(id) → JSSurfaceGraph

Creates and returns a 3D net-type grid graph object.

Information

Name	Type	Description
id	string	Created object ID name.

• Return

  • JSSurfaceGraph: Object creation success.

  • null: Object creation failure.

Template

let object = Module.createSurfaceGraph("newBarGraph3D");

getAnalysis() → JSAnalysis

Returns the JSAnalysis object that executes the analysis API.

Information

• Return

  • JSAnalysis: Created JSAnalysis type object. - null: Object creation failure.

Template

var analysis = Module.getAnalysis();

getGhostSymbolMap() → JSGhostSymbolMap

Creates and returns an API object that manages ghost symbols.

Infomation

• Return

  • JSGhostSymbolMap: Object creation success.

  • null: Creation failure.

Template

let map = Module.getGhostSymbolMap();

getNavigation() → JSNavigationControl

Creates and returns an API object for setting map navigation (compass).

Infomation

• Return

  • JSNavigationControl: Object creation success.

  • null: Creation failure.

Template

let navigation = Module.getNavigation();

getMap() → JSMap

Returns an object that calls the map functionality JSMap.

Infomation

• Return

  • JSMap: Return success.

  • null: Return failure.

Template

javascript let map = Module.getMap();

getSlope() → JSSlope

Creates and returns an API object for slope and slope direction analysis.

Infomation

• Return

  • JSSlope: Object creation success.

  • null: Creation failure.

Template

let slope = Module.getSlope();

getSymbol() → JSSymbol

Creates and returns an API object for managing icons (JSIcon).

Infomation

• Return

  • JSSymbol: Object creation success.

  • null: Creation failure.

Template

let symbol = Module.getSymbol();

getTerrain() → JSTerrain

Returns an object that calls the terrain setting API JSTerrain

Infomation

• Return

  • JSTerrain: Return success.

  • null: Return failure.

Template

let terrain = Module.getTerrain();

Resize(width, height)

Function to change the size of the screen.

If there is no special setting, the viewport is changed to fit the canvas size.

When set to div, the viewport is changed to fit the div size.

Infomation

Name	Type	Description
width	number	Width to change.
height	number	Height.

Template

Module.Resize(400, 300);

SetProxy(proxy)

Sets the bypass proxy URL.

Infomation

Name	Type	Description
proxy	string	Proxy URL.

Template

SetSimpleMode(type)

Sets the rendering simple mode.

When simple mode is set, objects without textures are rendered.

Infomation

Name	Type	Description
type	boolean	true to activate simple mode. false to deactivate simple mode.

Template

Module.SetSimpleMode(0);
Module.SetSimpleMode(1);

XDClearInputPoint() → boolean

Initializes the input point list.

Infomation

• Return

  • true: Initialization success.

  • false : Engine not initialized.

Template

Module.XDClearInputPoint();

XDIsMouseOverDiv(block)

Sets whether to block the map click event.

Infomation

Name	Type	Description
block	boolean	true to activate Block. false to deactivate Block.

Template

Module.XDIsMouseOverDiv(false);

XDRenderData()

Refreshes the screen.

Template

Module.XDRenderData();

XDSetMouseState(mode)

Changes the input state of the mouse.

Infomation

Name	Type	Description
mode	number	Mouse Type List.

Template

Type Definitions

Module.CreateTerrainOptions

Name	Type	Description
dem	Module.CreateTerrainOptions.DEM	Terrain data.
image	Module.CreateTerrainOptions.Image	Image data.

Module.CreateWorkerOptions

Name	Type	Description
use	boolean	Use of web worker.
path	string	Web worker request url.
count	number	Number of web workers to use.

Module.CreateTerrainOptions.DEM

Name	Type	Description
url	string	Terrain DEM data request url.
name	string	Terrain DEM layer name.
servername	string	Request Server name.
encoding	boolean	Whether DEM data is encrypted. true if encrypted. false if not encrypted.

Module.CreateTerrainOptions.Image

Name	Type	Description
url	string	Terrain image data request url.
name	string	Terrain image layer name.
servername	string	Request Server name.