DTS SDK

https://sdk.freedo3d.com/doc/api/
Admin
DTS SDK is a JavaScript-based API for web front-end developers to load, display, and interact with...
Tokens:10,971
Snippets:36
Trust Score:5.9
Update:9 months ago
Show doc for...
Tokens:
Raw
### Miscellaneous and Settings API

Source: https://sdk.freedo3d.com/doc/api/global

Endpoints for miscellaneous operations and settings adjustments, including starting processes, managing compass visibility, enabling interaction, and setting terrain alpha.

```APIDOC
## Miscellaneous and Settings API

### Description
Contains endpoints for miscellaneous operations like starting processes, and for adjusting various settings such as compass visibility, interaction modes, and terrain alpha.

### Endpoints

- **POST /api/misc/startprocess**
  - **Description**: Starts a new process.
  - **Method**: POST

- **POST /api/settings/setcompassvisible**
  - **Description**: Sets the visibility of the compass.
  - **Method**: POST

- **POST /api/settings/setenableinteract**
  - **Description**: Enables or disables interaction with the scene.
  - **Method**: POST

- **POST /api/settings/setinteractivemode**
  - **Description**: Sets the interactive mode for the scene.
  - **Method**: POST

- **POST /api/settings/setterrainalpha**
  - **Description**: Adjusts the alpha transparency of the terrain.
  - **Method**: POST

- **POST /api/settings/enablecameraMovingevent**
  - **Description**: Enables or disables camera moving events.
  - **Method**: POST

### Parameters

*Note: Specific parameters for each endpoint are not detailed in the provided text.*
```

--------------------------------

### Video Projection Management API

Source: https://sdk.freedo3d.com/doc/api/global

APIs for managing video projections, including adding, updating, deleting, showing, hiding, getting, and focusing.

```APIDOC
## VideoProjection_Add

### Description
Adds a new video projection.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
#### Request Body
- **projectionData** (object) - Required - Data for the new video projection (e.g., `{"videoUrl": "http://example.com/video.mp4", "position": {"x": 0, "y": 0, "z": 0}}`).

### Request Example
```json
{
  "method": "VideoProjection_Add",
  "params": {
    "projectionData": {"videoUrl": "http://example.com/video.mp4", "position": {"x": 0, "y": 0, "z": 0}}
  }
}
```

### Response
#### Success Response (200)
- **result** (number) - The ID of the newly added video projection.

#### Response Example
```json
{
  "result": 127
}
```
```

```APIDOC
## VideoProjection_Update

### Description
Updates an existing video projection.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
#### Request Body
- **id** (number) - Required - The ID of the video projection to update.
- **projectionData** (object) - Required - The updated data for the video projection (e.g., `{"videoUrl": "http://example.com/updated_video.mp4"}`).

### Request Example
```json
{
  "method": "VideoProjection_Update",
  "params": {
    "id": 128,
    "projectionData": {"videoUrl": "http://example.com/updated_video.mp4"}
  }
}
```

### Response
#### Success Response (200)
- **result** (number) - Indicates success (e.g., 1 for success, 0 for failure).

#### Response Example
```json
{
  "result": 1
}
```
```

```APIDOC
## VideoProjection_Delete

### Description
Deletes a specific video projection.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
#### Request Body
- **id** (number) - Required - The ID of the video projection to delete.

### Request Example
```json
{
  "method": "VideoProjection_Delete",
  "params": {
    "id": 129
  }
}
```

### Response
#### Success Response (200)
- **result** (number) - Indicates success (e.g., 1 for success, 0 for failure).

#### Response Example
```json
{
  "result": 1
}
```
```

```APIDOC
## VideoProjection_Show

### Description
Shows a specific video projection.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
#### Request Body
- **id** (number) - Required - The ID of the video projection to show.

### Request Example
```json
{
  "method": "VideoProjection_Show",
  "params": {
    "id": 130
  }
}
```

### Response
#### Success Response (200)
- **result** (number) - Indicates success (e.g., 1 for success, 0 for failure).

#### Response Example
```json
{
  "result": 1
}
```
```

```APIDOC
## VideoProjection_Hide

### Description
Hides a specific video projection.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
#### Request Body
- **id** (number) - Required - The ID of the video projection to hide.

### Request Example
```json
{
  "method": "VideoProjection_Hide",
  "params": {
    "id": 131
  }
}
```

### Response
#### Success Response (200)
- **result** (number) - Indicates success (e.g., 1 for success, 0 for failure).

#### Response Example
```json
{
  "result": 1
}
```
```

```APIDOC
## VideoProjection_Get

### Description
Retrieves data for a specific video projection.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
#### Request Body
- **id** (number) - Required - The ID of the video projection to retrieve.

### Request Example
```json
{
  "method": "VideoProjection_Get",
  "params": {
    "id": 132
  }
}
```

### Response
#### Success Response (200)
- **result** (object) - The data of the video projection.

#### Response Example
```json
{
  "result": {
    "id": 132,
    "videoUrl": "http://example.com/video.mp4",
    "position": {"x": 0, "y": 0, "z": 0}
  }
}
```
```

```text

```

--------------------------------

### HighlightArea get Method

Source: https://sdk.freedo3d.com/doc/api/HighlightArea

Retrieves specified highlight areas by their IDs. Accepts an array of IDs and an optional callback function.

```javascript
highlightArea.get(ids, fn)
```

--------------------------------

### Polyline Management API

Source: https://sdk.freedo3d.com/doc/api/global

APIs for managing polylines, including adding, updating, deleting, clearing, focusing, getting, showing, and hiding polylines.

```APIDOC
## Polyline_Add

### Description
Adds a new polyline.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
#### Request Body
- **polylineData** (object) - Required - Data for the new polyline (e.g., `{"points": [{"x": 0, "y": 0, "z": 0}, {"x": 1, "y": 1, "z": 1}]}`).

### Request Example
```json
{
  "method": "Polyline_Add",
  "params": {
    "polylineData": {"points": [{"x": 0, "y": 0, "z": 0}, {"x": 1, "y": 1, "z": 1}]}
  }
}
```

### Response
#### Success Response (200)
- **result** (number) - The ID of the newly added polyline.

#### Response Example
```json
{
  "result": 117
}
```
```

```APIDOC
## Polyline_Update

### Description
Updates an existing polyline.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
#### Request Body
- **id** (number) - Required - The ID of the polyline to update.
- **polylineData** (object) - Required - The updated data for the polyline (e.g., `{"points": [{"x": 2, "y": 2, "z": 2}]}`).

### Request Example
```json
{
  "method": "Polyline_Update",
  "params": {
    "id": 118,
    "polylineData": {"points": [{"x": 2, "y": 2, "z": 2}]}
  }
}
```

### Response
#### Success Response (200)
- **result** (number) - Indicates success (e.g., 1 for success, 0 for failure).

#### Response Example
```json
{
  "result": 1
}
```
```

```APIDOC
## Polyline_Delete

### Description
Deletes a specific polyline.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
#### Request Body
- **id** (number) - Required - The ID of the polyline to delete.

### Request Example
```json
{
  "method": "Polyline_Delete",
  "params": {
    "id": 119
  }
}
```

### Response
#### Success Response (200)
- **result** (number) - Indicates success (e.g., 1 for success, 0 for failure).

#### Response Example
```json
{
  "result": 1
}
```
```

```APIDOC
## Polyline_Clear

### Description
Clears a specific polyline.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
#### Request Body
- **id** (number) - Required - The ID of the polyline to clear.

### Request Example
```json
{
  "method": "Polyline_Clear",
  "params": {
    "id": 120
  }
}
```

### Response
#### Success Response (200)
- **result** (number) - Indicates success (e.g., 1 for success, 0 for failure).

#### Response Example
```json
{
  "result": 1
}
```
```

```APIDOC
## Polyline_Focus

### Description
Focuses on a specific polyline.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
#### Request Body
- **id** (number) - Required - The ID of the polyline to focus on.

### Request Example
```json
{
  "method": "Polyline_Focus",
  "params": {
    "id": 121
  }
}
```

### Response
#### Success Response (200)
- **result** (number) - Indicates success (e.g., 1 for success, 0 for failure).

#### Response Example
```json
{
  "result": 1
}
```
```

```APIDOC
## Polyline_Get

### Description
Retrieves data for a specific polyline.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
#### Request Body
- **id** (number) - Required - The ID of the polyline to retrieve.

### Request Example
```json
{
  "method": "Polyline_Get",
  "params": {
    "id": 122
  }
}
```

### Response
#### Success Response (200)
- **result** (object) - The data of the polyline.

#### Response Example
```json
{
  "result": {
    "id": 122,
    "points": [{"x": 0, "y": 0, "z": 0}, {"x": 1, "y": 1, "z": 1}]
  }
}
```
```

```APIDOC
## Polyline_Show

### Description
Shows a specific polyline.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
#### Request Body
- **id** (number) - Required - The ID of the polyline to show.

### Request Example
```json
{
  "method": "Polyline_Show",
  "params": {
    "id": 123
  }
}
```

### Response
#### Success Response (200)
- **result** (number) - Indicates success (e.g., 1 for success, 0 for failure).

#### Response Example
```json
{
  "result": 1
}
```
```

```APIDOC
## Polyline_Hide

### Description
Hides a specific polyline.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
#### Request Body
- **id** (number) - Required - The ID of the polyline to hide.

### Request Example
```json
{
  "method": "Polyline_Hide",
  "params": {
    "id": 124
  }
}
```

### Response
#### Success Response (200)
- **result** (number) - Indicates success (e.g., 1 for success, 0 for failure).

#### Response Example
```json
{
  "result": 1
}
```
```

```APIDOC
## Polyline_ShowAll

### Description
Shows all polylines.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
No specific parameters required for this action, the ID 125 is implicitly used.

### Request Example
```json
{
  "method": "Polyline_ShowAll",
  "params": {}
}
```

### Response
#### Success Response (200)
- **result** (number) - Indicates success (e.g., 1 for success, 0 for failure).

#### Response Example
```json
{
  "result": 1
}
```
```

```APIDOC
## Polyline_HideAll

### Description
Hides all polylines.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
No specific parameters required for this action, the ID 126 is implicitly used.

### Request Example
```json
{
  "method": "Polyline_HideAll",
  "params": {}
}
```

### Response
#### Success Response (200)
- **result** (number) - Indicates success (e.g., 1 for success, 0 for failure).

#### Response Example
```json
{
  "result": 1
}
```
```

--------------------------------

### HighlightArea updateBegin Method

Source: https://sdk.freedo3d.com/doc/api/HighlightArea

Initiates the update process for highlight areas. This method typically precedes a series of update operations.

```javascript
highlightArea.updateBegin()
```

--------------------------------

### HighlightArea show Method

Source: https://sdk.freedo3d.com/doc/api/HighlightArea

Shows specified highlight areas by their IDs. Accepts an array of IDs and an optional callback function.

```javascript
highlightArea.show(ids, fn)
```

--------------------------------

### Custom Object Management API

Source: https://sdk.freedo3d.com/doc/api/global

APIs for managing custom objects, including setting tint color, clearing, highlighting, and clearing all custom objects.

```APIDOC
## CustomObject_SetTintColor

### Description
Sets the tint color for custom objects.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
#### Request Body
- **id** (number) - Required - The ID of the custom object.
- **color** (object) - Required - The color to set (e.g., `{"r": 255, "g": 0, "b": 0, "a": 255}`).

### Request Example
```json
{
  "method": "CustomObject_SetTintColor",
  "params": {
    "id": 326,
    "color": {"r": 255, "g": 0, "b": 0, "a": 255}
  }
}
```

### Response
#### Success Response (200)
- **result** (number) - Indicates success (e.g., 1 for success, 0 for failure).

#### Response Example
```json
{
  "result": 1
}
```
```

```APIDOC
## CustomObject_Clear

### Description
Clears a specific custom object.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
#### Request Body
- **id** (number) - Required - The ID of the custom object to clear.

### Request Example
```json
{
  "method": "CustomObject_Clear",
  "params": {
    "id": 219
  }
}
```

### Response
#### Success Response (200)
- **result** (number) - Indicates success (e.g., 1 for success, 0 for failure).

#### Response Example
```json
{
  "result": 1
}
```
```

```APIDOC
## CustomObject_Highlight

### Description
Highlights a specific custom object.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
#### Request Body
- **id** (number) - Required - The ID of the custom object to highlight.

### Request Example
```json
{
  "method": "CustomObject_Highlight",
  "params": {
    "id": 220
  }
}
```

### Response
#### Success Response (200)
- **result** (number) - Indicates success (e.g., 1 for success, 0 for failure).

#### Response Example
```json
{
  "result": 1
}
```
```

--------------------------------

### HighlightArea focus Method

Source: https://sdk.freedo3d.com/doc/api/HighlightArea

Focuses on specified highlight areas. Allows control over distance, fly time, and rotation. An optional callback function can be provided.

```javascript
highlightArea.focus(ids, distance, flyTime, rotation, fn)
```

--------------------------------

### Marker API

Source: https://sdk.freedo3d.com/doc/api/global

Endpoints for managing markers, including adding, updating, retrieving, deleting, clearing, focusing, showing, hiding, and managing popup windows.

```APIDOC
## Marker API

### Description
Manages markers in the 3D scene. Supports operations such as adding, updating, retrieving, deleting, clearing, focusing, controlling visibility, and managing associated popup windows.

### Endpoints

- **POST /api/marker/add**
  - **Description**: Adds a new marker.
  - **Method**: POST

- **POST /api/marker/update**
  - **Description**: Updates an existing marker.
  - **Method**: POST

- **GET /api/marker/get**
  - **Description**: Retrieves information about a marker.
  - **Method**: GET

- **POST /api/marker/delete**
  - **Description**: Deletes a marker.
  - **Method**: POST

- **POST /api/marker/clear**
  - **Description**: Removes all markers.
  - **Method**: POST

- **POST /api/marker/focus**
  - **Description**: Focuses the view on a specific marker.
  - **Method**: POST

- **POST /api/marker/focusall**
  - **Description**: Focuses the view on all markers.
  - **Method**: POST

- **POST /api/marker/show**
  - **Description**: Makes a marker visible.
  - **Method**: POST

- **POST /api/marker/hide**
  - **Description**: Hides a marker.
  - **Method**: POST

- **POST /api/marker/showall**
  - **Description**: Makes all markers visible.
  - **Method**: POST

- **POST /api/marker/hideall**
  - **Description**: Hides all markers.
  - **Method**: POST

- **POST /api/marker/showpopupwindow**
  - **Description**: Shows the popup window for a marker.
  - **Method**: POST

- **POST /api/marker/hidepopupwindow**
  - **Description**: Hides the popup window for a marker.
  - **Method**: POST

- **POST /api/marker/showallpopupwindow**
  - **Description**: Shows popup windows for all markers.
  - **Method**: POST

- **POST /api/marker/hideallpopupwindow**
  - **Description**: Hides popup windows for all markers.
  - **Method**: POST

### Parameters

*Note: Specific parameters for each endpoint are not detailed in the provided text.*
```

--------------------------------

### Weather API

Source: https://sdk.freedo3d.com/doc/api/global

Endpoint for simulating weather conditions over time.

```APIDOC
## Weather API

### Description
Provides functionality to simulate weather conditions over a specified period.

### Endpoints

- **POST /api/weather/simulatetime**
  - **Description**: Simulates weather conditions for a given time.
  - **Method**: POST

### Parameters

*Note: Specific parameters for this endpoint are not detailed in the provided text.*
```

--------------------------------

### Camera and Animation API

Source: https://sdk.freedo3d.com/doc/api/global

Endpoints for controlling camera movement, pausing and resuming animations, and retrieving animation lists.

```APIDOC
## Camera and Animation API

### Description
Manages camera behavior and animations within the 3D scene. Allows for camera movement, pausing and resuming animations, and fetching available animation lists.

### Endpoints

- **POST /api/camera/move**
  - **Description**: Moves the camera to a specified position or orientation.
  - **Method**: POST

- **POST /api/camera/pauseanimation**
  - **Description**: Pauses the current camera animation.
  - **Method**: POST

- **POST /api/camera/resumeanimation**
  - **Description**: Resumes a paused camera animation.
  - **Method**: POST

- **GET /api/camera/getanimationlist**
  - **Description**: Retrieves a list of available camera animations.
  - **Method**: GET

### Parameters

*Note: Specific parameters for each endpoint are not detailed in the provided text.*
```

--------------------------------

### HighlightArea add Method

Source: https://sdk.freedo3d.com/doc/api/HighlightArea

Adds a new highlight area to the scene. This method takes data for the highlight area and an optional callback function.

```javascript
highlightArea.add(data, fn)
```

--------------------------------

### HighlightArea update Method

Source: https://sdk.freedo3d.com/doc/api/HighlightArea

Updates an existing highlight area with new data. Requires the data for the update and an optional callback function.

```javascript
highlightArea.update(data, fn)
```

--------------------------------

### Tile Layer API

Source: https://sdk.freedo3d.com/doc/api/global

Endpoints for managing tile layers, including collision settings, viewport visibility, object retrieval, and cut polygon operations.

```APIDOC
## Tile Layer API

### Description
Provides functionalities for managing tile layers. This includes setting collision properties, controlling viewport visibility, retrieving object IDs, and performing cut polygon operations.

### Endpoints

- **POST /api/tilelayer/setcollision**
  - **Description**: Sets collision properties for a tile layer.
  - **Method**: POST

- **POST /api/tilelayer/modifier/add**
  - **Description**: Adds a modifier to a tile layer.
  - **Method**: POST

- **POST /api/tilelayer/modifier/update**
  - **Description**: Updates an existing modifier on a tile layer.
  - **Method**: POST

- **POST /api/tilelayer/modifier/delete**
  - **Description**: Deletes a modifier from a tile layer.
  - **Method**: POST

- **POST /api/tilelayer/modifier/clear**
  - **Description**: Removes all modifiers from a tile layer.
  - **Method**: POST

- **POST /api/tilelayer/setviewportvisible**
  - **Description**: Controls the visibility of a tile layer within the viewport.
  - **Method**: POST

- **GET /api/tilelayer/getobjectids**
  - **Description**: Retrieves the IDs of objects within a tile layer.
  - **Method**: GET

- **GET /api/tilelayer/getactorinfo**
  - **Description**: Retrieves information about actors within a tile layer.
  - **Method**: GET

- **POST /api/tilelayer/cutpolygon/add**
  - **Description**: Adds a cut polygon to a tile layer.
  - **Method**: POST

- **POST /api/tilelayer/cutpolygon/update**
  - **Description**: Updates an existing cut polygon on a tile layer.
  - **Method**: POST

- **POST /api/tilelayer/cutpolygon/delete**
  - **Description**: Deletes a cut polygon from a tile layer.
  - **Method**: POST

- **POST /api/tilelayer/cutpolygon/clear**
  - **Description**: Removes all cut polygons from a tile layer.
  - **Method**: POST

### Parameters

*Note: Specific parameters for each endpoint are not detailed in the provided text.*
```

--------------------------------

### HighlightArea updateEnd Method

Source: https://sdk.freedo3d.com/doc/api/HighlightArea

Finalizes the update process for highlight areas. This method should be called after all update operations are complete. An optional callback function can be provided.

```javascript
highlightArea.updateEnd(fn)
```

--------------------------------

### Shapefile Layer API

Source: https://sdk.freedo3d.com/doc/api/global

Endpoints for managing Shapefile layers, including adding, deleting, updating, retrieving, focusing, showing, hiding, and opening shapefiles.

```APIDOC
## Shapefile Layer API

### Description
Manages Shapefile layers within the 3D environment. Supports adding, deleting, updating, retrieving details, focusing on, controlling visibility, and opening shapefiles.

### Endpoints

- **POST /api/shapefilelayer/add**
  - **Description**: Adds a new Shapefile layer.
  - **Method**: POST

- **POST /api/shapefilelayer/delete**
  - **Description**: Deletes an existing Shapefile layer.
  - **Method**: POST

- **POST /api/shapefilelayer/clear**
  - **Description**: Removes all Shapefile layers.
  - **Method**: POST

- **POST /api/shapefilelayer/update**
  - **Description**: Updates an existing Shapefile layer.
  - **Method**: POST

- **GET /api/shapefilelayer/get**
  - **Description**: Retrieves information about a Shapefile layer.
  - **Method**: GET

- **POST /api/shapefilelayer/focus**
  - **Description**: Focuses the view on a specific Shapefile layer.
  - **Method**: POST

- **POST /api/shapefilelayer/show**
  - **Description**: Makes a Shapefile layer visible.
  - **Method**: POST

- **POST /api/shapefilelayer/hide**
  - **Description**: Hides a Shapefile layer.
  - **Method**: POST

- **POST /api/shapefilelayer/showall**
  - **Description**: Makes all Shapefile layers visible.
  - **Method**: POST

- **POST /api/shapefilelayer/hideall**
  - **Description**: Hides all Shapefile layers.
  - **Method**: POST

- **POST /api/shapefilelayer/openshapefilelayer**
  - **Description**: Opens a Shapefile layer from a specified file.
  - **Method**: POST

### Parameters

*Note: Specific parameters for each endpoint are not detailed in the provided text.*
```

--------------------------------

### Custom Object Operations API

Source: https://sdk.freedo3d.com/doc/api/global

Endpoints for manipulating custom objects, including highlighting, stopping highlights, calling functions, and adding objects by tile layer.

```APIDOC
## Custom Object Operations API

### Description
Provides functionality to interact with custom objects within the 3D environment. This includes highlighting, stopping highlights, and calling specific functions associated with custom objects.

### Endpoints

- **POST /api/customobject/unhighlight**
  - **Description**: Unhighlights a custom object.
  - **Method**: POST

- **POST /api/customobject/stophighlight**
  - **Description**: Stops the highlight effect on a custom object.
  - **Method**: POST

- **POST /api/customobject/callfunction**
  - **Description**: Calls a specific function on a custom object.
  - **Method**: POST

- **POST /api/customobject/addbytilelayer**
  - **Description**: Adds a custom object based on a tile layer.
  - **Method**: POST

### Parameters

*Note: Specific parameters for each endpoint are not detailed in the provided text.*
```

--------------------------------

### HighlightArea hide Method

Source: https://sdk.freedo3d.com/doc/api/HighlightArea

Hides specified highlight areas by their IDs. Accepts an array of IDs and an optional callback function.

```javascript
highlightArea.hide(ids, fn)
```

--------------------------------

### Custom Tag Management API

Source: https://sdk.freedo3d.com/doc/api/global

APIs for managing custom tags, including clearing, deleting, focusing, showing, hiding, and adding/updating tags.

```APIDOC
## CustomTag_Clear

### Description
Clears a specific custom tag.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
#### Request Body
- **id** (number) - Required - The ID of the custom tag to clear.

### Request Example
```json
{
  "method": "CustomTag_Clear",
  "params": {
    "id": 39
  }
}
```

### Response
#### Success Response (200)
- **result** (number) - Indicates success (e.g., 1 for success, 0 for failure).

#### Response Example
```json
{
  "result": 1
}
```
```

```APIDOC
## CustomTag_Delete

### Description
Deletes a specific custom tag.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
#### Request Body
- **id** (number) - Required - The ID of the custom tag to delete.

### Request Example
```json
{
  "method": "CustomTag_Delete",
  "params": {
    "id": 37
  }
}
```

### Response
#### Success Response (200)
- **result** (number) - Indicates success (e.g., 1 for success, 0 for failure).

#### Response Example
```json
{
  "result": 1
}
```
```

```APIDOC
## CustomTag_Focus

### Description
Focuses on a specific custom tag.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
#### Request Body
- **id** (number) - Required - The ID of the custom tag to focus on.

### Request Example
```json
{
  "method": "CustomTag_Focus",
  "params": {
    "id": 40
  }
}
```

### Response
#### Success Response (200)
- **result** (number) - Indicates success (e.g., 1 for success, 0 for failure).

#### Response Example
```json
{
  "result": 1
}
```
```

```APIDOC
## CustomTag_FocusAll

### Description
Focuses on all custom tags.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
No specific parameters required for this action, the ID 57 is implicitly used.

### Request Example
```json
{
  "method": "CustomTag_FocusAll",
  "params": {}
}
```

### Response
#### Success Response (200)
- **result** (number) - Indicates success (e.g., 1 for success, 0 for failure).

#### Response Example
```json
{
  "result": 1
}
```
```

```APIDOC
## CustomTag_Show

### Description
Shows a specific custom tag.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
#### Request Body
- **id** (number) - Required - The ID of the custom tag to show.

### Request Example
```json
{
  "method": "CustomTag_Show",
  "params": {
    "id": 58
  }
}
```

### Response
#### Success Response (200)
- **result** (number) - Indicates success (e.g., 1 for success, 0 for failure).

#### Response Example
```json
{
  "result": 1
}
```
```

```APIDOC
## CustomTag_Hide

### Description
Hides a specific custom tag.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
#### Request Body
- **id** (number) - Required - The ID of the custom tag to hide.

### Request Example
```json
{
  "method": "CustomTag_Hide",
  "params": {
    "id": 59
  }
}
```

### Response
#### Success Response (200)
- **result** (number) - Indicates success (e.g., 1 for success, 0 for failure).

#### Response Example
```json
{
  "result": 1
}
```
```

```APIDOC
## CustomTag_ShowAll

### Description
Shows all custom tags.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
No specific parameters required for this action, the ID 60 is implicitly used.

### Request Example
```json
{
  "method": "CustomTag_ShowAll",
  "params": {}
}
```

### Response
#### Success Response (200)
- **result** (number) - Indicates success (e.g., 1 for success, 0 for failure).

#### Response Example
```json
{
  "result": 1
}
```
```

```APIDOC
## CustomTag_HideAll

### Description
Hides all custom tags.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
No specific parameters required for this action, the ID 61 is implicitly used.

### Request Example
```json
{
  "method": "CustomTag_HideAll",
  "params": {}
}
```

### Response
#### Success Response (200)
- **result** (number) - Indicates success (e.g., 1 for success, 0 for failure).

#### Response Example
```json
{
  "result": 1
}
```
```

```APIDOC
## CustomTag_Add

### Description
Adds a new custom tag.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
#### Request Body
- **tagData** (object) - Required - Data for the new tag (e.g., `{"name": "New Tag", "position": {"x": 0, "y": 0, "z": 0}}`).

### Request Example
```json
{
  "method": "CustomTag_Add",
  "params": {
    "tagData": {"name": "New Tag", "position": {"x": 0, "y": 0, "z": 0}}
  }
}
```

### Response
#### Success Response (200)
- **result** (number) - The ID of the newly added tag.

#### Response Example
```json
{
  "result": 114
}
```
```

```APIDOC
## CustomTag_Update

### Description
Updates an existing custom tag.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
#### Request Body
- **id** (number) - Required - The ID of the custom tag to update.
- **tagData** (object) - Required - The updated data for the tag (e.g., `{"name": "Updated Tag"}`).

### Request Example
```json
{
  "method": "CustomTag_Update",
  "params": {
    "id": 115,
    "tagData": {"name": "Updated Tag"}
  }
}
```

### Response
#### Success Response (200)
- **result** (number) - Indicates success (e.g., 1 for success, 0 for failure).

#### Response Example
```json
{
  "result": 1
}
```
```

```APIDOC
## CustomTag_Get

### Description
Retrieves data for a specific custom tag.

### Method
POST

### Endpoint
/websites/sdk_freedo3d_doc_api

### Parameters
#### Request Body
- **id** (number) - Required - The ID of the custom tag to retrieve.

### Request Example
```json
{
  "method": "CustomTag_Get",
  "params": {
    "id": 116
  }
}
```

### Response
#### Success Response (200)
- **result** (object) - The data of the custom tag.

#### Response Example
```json
{
  "result": {
    "id": 116,
    "name": "Example Tag",
    "position": {"x": 10, "y": 20, "z": 30}
  }
}
```
```

--------------------------------

### HighlightArea clear Method

Source: https://sdk.freedo3d.com/doc/api/HighlightArea

Clears all highlight areas from the scene. An optional callback function can be provided.

```javascript
highlightArea.clear(fn)
```

--------------------------------

### Tools API

Source: https://sdk.freedo3d.com/doc/api/global

Endpoints related to various tools for scene analysis and manipulation, such as plane clipping, volume clipping, skyline analysis, viewshed analysis, and geometry editing.

```APIDOC
## Tools API

### Description
This API group encompasses various tools for scene analysis and manipulation. It includes functionalities for clipping planes and volumes, performing skyline and viewshed analyses, and enabling geometry editing.

### Endpoints

- **POST /api/tools/startplaneclip**
  - **Description**: Starts the plane clipping tool.
  - **Method**: POST

- **POST /api/tools/stopplaneclip**
  - **Description**: Stops the plane clipping tool.
  - **Method**: POST

- **POST /api/tools/startvolumeclip**
  - **Description**: Starts the volume clipping tool.
  - **Method**: POST

- **POST /api/tools/updatevolumeclip**
  - **Description**: Updates the parameters of the volume clipping tool.
  - **Method**: POST

- **POST /api/tools/stopvolumeclip**
  - **Description**: Stops the volume clipping tool.
  - **Method**: POST

- **POST /api/tools/startskylineanalysis**
  - **Description**: Initiates a skyline analysis.
  - **Method**: POST

- **POST /api/tools/stop skylineanalysis**
  - **Description**: Stops the skyline analysis.
  - **Method**: POST

- **POST /api/tools/exportskyline**
  - **Description**: Exports the results of a skyline analysis.
  - **Method**: POST

- **POST /api/tools/startviewshedanalysis**
  - **Description**: Starts a viewshed analysis.
  - **Method**: POST

- **POST /api/tools/stopviewshedanalysis**
  - **Description**: Stops the viewshed analysis.
  - **Method**: POST

- **POST /api/tools/startgeometryedit**
  - **Description**: Enables geometry editing mode.
  - **Method**: POST

- **POST /api/tools/stopgeometryedit**
  - **Description**: Disables geometry editing mode.
  - **Method**: POST

- **POST /api/tools/startfloodfill**
  - **Description**: Starts the flood fill tool.
  - **Method**: POST

- **POST /api/tools/stopfloodfill**
  - **Description**: Stops the flood fill tool.
  - **Method**: POST

### Parameters

*Note: Specific parameters for each endpoint are not detailed in the provided text.*
```

--------------------------------

### Cesium 3D Tiles API

Source: https://sdk.freedo3d.com/doc/api/global

Endpoints for managing Cesium 3D Tiles, including adding, deleting, updating, retrieving, focusing, showing, and hiding tilesets.

```APIDOC
## Cesium 3D Tiles API

### Description
Manages Cesium 3D Tilesets in the 3D environment. Supports operations such as adding, deleting, updating, retrieving details, focusing on, and controlling the visibility of tilesets.

### Endpoints

- **POST /api/cesium3dtile/add**
  - **Description**: Adds a Cesium 3D Tileset.
  - **Method**: POST

- **POST /api/cesium3dtile/delete**
  - **Description**: Deletes a Cesium 3D Tileset.
  - **Method**: POST

- **POST /api/cesium3dtile/clear**
  - **Description**: Removes all Cesium 3D Tilesets.
  - **Method**: POST

- **POST /api/cesium3dtile/update**
  - **Description**: Updates an existing Cesium 3D Tileset.
  - **Method**: POST

- **GET /api/cesium3dtile/get**
  - **Description**: Retrieves information about a Cesium 3D Tileset.
  - **Method**: GET

- **POST /api/cesium3dtile/focus**
  - **Description**: Focuses the view on a specific Cesium 3D Tileset.
  - **Method**: POST

- **POST /api/cesium3dtile/show**
  - **Description**: Makes a Cesium 3D Tileset visible.
  - **Method**: POST

- **POST /api/cesium3dtile/hide**
  - **Description**: Hides a Cesium 3D Tileset.
  - **Method**: POST

- **POST /api/cesium3dtile/showall**
  - **Description**: Makes all Cesium 3D Tilesets visible.
  - **Method**: POST

- **POST /api/cesium3dtile/hideall**
  - **Description**: Hides all Cesium 3D Tilesets.
  - **Method**: POST

### Parameters

*Note: Specific parameters for each endpoint are not detailed in the provided text.*
```

--------------------------------

### Marker 3D API

Source: https://sdk.freedo3d.com/doc/api/global

Endpoints for managing 3D markers, including adding, deleting, updating, retrieving, focusing, showing, and hiding them.

```APIDOC
## Marker 3D API

### Description
Manages 3D markers within the scene. Supports operations like adding, deleting, updating, retrieving details, focusing on, and controlling the visibility of 3D markers.

### Endpoints

- **POST /api/marker3d/add**
  - **Description**: Adds a new 3D marker.
  - **Method**: POST

- **POST /api/marker3d/delete**
  - **Description**: Deletes an existing 3D marker.
  - **Method**: POST

- **POST /api/marker3d/clear**
  - **Description**: Removes all 3D markers.
  - **Method**: POST

- **POST /api/marker3d/update**
  - **Description**: Updates an existing 3D marker.
  - **Method**: POST

- **GET /api/marker3d/get**
  - **Description**: Retrieves information about a 3D marker.
  - **Method**: GET

- **POST /api/marker3d/focus**
  - **Description**: Focuses the view on a specific 3D marker.
  - **Method**: POST

- **POST /api/marker3d/show**
  - **Description**: Makes a 3D marker visible.
  - **Method**: POST

- **POST /api/marker3d/hide**
  - **Description**: Hides a 3D marker.
  - **Method**: POST

- **POST /api/marker3d/showall**
  - **Description**: Makes all 3D markers visible.
  - **Method**: POST

- **POST /api/marker3d/hideall**
  - **Description**: Hides all 3D markers.
  - **Method**: POST

### Parameters

*Note: Specific parameters for each endpoint are not detailed in the provided text.*
```

--------------------------------

### Custom Mesh API

Source: https://sdk.freedo3d.com/doc/api/global

Endpoints for managing custom mesh objects, including adding, deleting, updating, retrieving, focusing, showing, and hiding meshes.

```APIDOC
## Custom Mesh API

### Description
Provides comprehensive control over custom mesh objects within the 3D environment. Operations include adding, deleting, updating, retrieving details, focusing on specific meshes, and controlling their visibility.

### Endpoints

- **POST /api/custommesh/add**
  - **Description**: Adds a new custom mesh.
  - **Method**: POST

- **POST /api/custommesh/delete**
  - **Description**: Deletes an existing custom mesh.
  - **Method**: POST

- **POST /api/custommesh/clear**
  - **Description**: Removes all custom meshes.
  - **Method**: POST

- **POST /api/custommesh/update**
  - **Description**: Updates an existing custom mesh.
  - **Method**: POST

- **GET /api/custommesh/get**
  - **Description**: Retrieves information about a custom mesh.
  - **Method**: GET

- **POST /api/custommesh/focus**
  - **Description**: Focuses the view on a specific custom mesh.
  - **Method**: POST

- **POST /api/custommesh/show**
  - **Description**: Makes a custom mesh visible.
  - **Method**: POST

- **POST /api/custommesh/hide**
  - **Description**: Hides a custom mesh.
  - **Method**: POST

- **POST /api/custommesh/showall**
  - **Description**: Makes all custom meshes visible.
  - **Method**: POST

- **POST /api/custommesh/hideall**
  - **Description**: Hides all custom meshes.
  - **Method**: POST

### Parameters

*Note: Specific parameters for each endpoint are not detailed in the provided text.*
```

--------------------------------

### Flood Fill API

Source: https://sdk.freedo3d.com/doc/api/global

Endpoints for managing flood fill operations, including adding, deleting, clearing, updating, retrieving, focusing, showing, and hiding flood fills.

```APIDOC
## Flood Fill API

### Description
Manages flood fill operations within the 3D scene. Supports adding, deleting, clearing, updating, retrieving details, focusing on, and controlling the visibility of flood fills.

### Endpoints

- **POST /api/floodfill/add**
  - **Description**: Adds a new flood fill region.
  - **Method**: POST

- **POST /api/floodfill/delete**
  - **Description**: Deletes an existing flood fill region.
  - **Method**: POST

- **POST /api/floodfill/clear**
  - **Description**: Removes all flood fill regions.
  - **Method**: POST

- **POST /api/floodfill/update**
  - **Description**: Updates an existing flood fill region.
  - **Method**: POST

- **GET /api/floodfill/get**
  - **Description**: Retrieves information about a flood fill region.
  - **Method**: GET

- **POST /api/floodfill/focus**
  - **Description**: Focuses the view on a specific flood fill region.
  - **Method**: POST

- **POST /api/floodfill/show**
  - **Description**: Makes a flood fill region visible.
  - **Method**: POST

- **POST /api/floodfill/hide**
  - **Description**: Hides a flood fill region.
  - **Method**: POST

- **POST /api/floodfill/showall**
  - **Description**: Makes all flood fill regions visible.
  - **Method**: POST

- **POST /api/floodfill/hideall**
  - **Description**: Hides all flood fill regions.
  - **Method**: POST

### Parameters

*Note: Specific parameters for each endpoint are not detailed in the provided text.*
```
Tokens:
Raw