Area Marker methods
- Last UpdatedOct 29, 2025
- 2 minute read
These API methods are used to to mark a specific area in the Engage 3D model view. The start and end points for these areas are passed back to the extension in JSON format. For example, these commands can be used to identify inspection areas.
Initiate Area Marker
{ "name": "InitiateAreaPoints", "args": [] };
Places markers on Engage 3D model.
Save Area Marker
{ "name": "SaveAreaEntry", "args": [] };
Creates area markers on Engage 3D model, based on already saved areas data from Extension page and saves the edited area markers information. Needs to pass JSON data as input.
JSON Data
This is an example of JSON data.
{
"AreaId": "0fdc836d-0a40-4b32-bf33-5a97149bf13f",
"Operation": "New",
"Point1Info": {
"Marker": "Marker1",
"Point": {
"X": 28088.551073431998,
"Y": -4803.5679256533476,
"Z": 2706.7739119540092
},
"PickSegID": [18386, 331299],
"Pid": 69881,
"PickPointTagName": "AREA-100-STRUC1-PLATFORM1"
},
"Point2Info": {
"Marker": "Marker2",
"Point": {
"X": 34504.972379862309,
"Y": 5528.1248344894339,
"Z": 29.553026309491543
},
"PickSegID": [18386, 329842],
"Pid": 69449,
"PickPointTagName": "AREA-100-BASEPLATE1"
}
}
|
AreaId |
Unique identifier |
|---|---|
|
Operation |
Type of operation data to extension page
|
|
Point1Info Point2Info |
Pointer information includes X,Y,Z coordinates of marker along with
|
Select Area Marker
{ "name": "SelectAreaEntry", "args": [] };
Selects an area marker from the 3D model. Needs to pass already present AreaId value as argument to this method.
Example: {"name": " SelectAreaEntry", "args": ['0fdc836d-0a40-4b32-bf33-5a97149bf13f'] };
This API method needs to be called to edit the created markers.
Delete Area Marker
{ "name": "DeleteAreaEntry", "args": [] };
Deletes an area marker from the 3D model. Needs to pass already present AreaId value as argument to this method.
Example: {"name": "DeleteAreaEntry", "args": ['0fdc836d-0a40-4b32-bf33-5a97149bf13f'] };