Classes
Methods
# changeImage3D(id)
Loads a 3D image by its image ID.
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | The ID of the image to load in 3D mode. |
# changeMode(mode) → {Promise.<{status: number, msg: string}>}
Changes the view mode of the map.
Parameters:
| Name | Type | Description |
|---|---|---|
mode |
'3D' | '2D' | The mode to switch to. |
- A promise resolving with the operation status and message, or rejecting on failure.
# changeOrientation(orientation) → {Promise.<{status: number, msg: string}>}
Changes the imagery orientation in 3D mode.
Parameters:
| Name | Type | Description |
|---|---|---|
orientation |
string | The orientation to change to. |
- A promise resolving with the operation status and message, or rejecting if 3D mode is not active.
# getAvailableCapturePrograms() → {Array.<CaptureProgramStatus>}
Get all collections in center separated by capture program.
# getCapturePrograms() → {Array.<CaptureProgram>}
Get all collections separated by capture program.
# getCenterImageMetadata() → {Array.<Object>}
Retrieves metadata of the images at the center of the view.
The image metadata.
# hasInfrared() → {boolean}
Checks if infrared imagery is available in the current mode.
- Returns
trueif infrared imagery is available, otherwisefalse.
# is3DAvailable(collectionIdopt, centeropt, zoomopt) → {boolean}
Checks if 3D mode is available for a specific collection, center, and zoom level.
If center or zoom are not specified or are null, the function will use the map's current center and zoom.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
collectionId |
string |
<optional> |
null | The ID of the collection to check. If not provided, it will check all available collections. |
center |
Location |
<optional> |
null | The geographical center [longitude, latitude] to check for 3D availability. Defaults to the map's current center if not provided. |
zoom |
number |
<optional> |
null | The zoom level to check for 3D mode. Defaults to the map's current zoom if not provided. |
- Returns
trueif 3D mode is available, otherwisefalse.
# isOrientationAvailable(orientation, collectionIdopt) → {boolean}
Checks whether orientation is available for the given collection (if specified).
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
orientation |
string | The orientation to check. Defaults to the map's current orientation if not provided. |
||
collectionId |
string | null |
<optional> |
null | The ID of the collection to check. If |
- Returns
trueif the orientation is available, otherwisefalse.
# loadDiscreteByProject(captureProgram, collectionId)
Loads discrete imagery by project.
Parameters:
| Name | Type | Description |
|---|---|---|
captureProgram |
string | The capture program identifier. |
collectionId |
string | The collection name. |
# selectCollection(id)
Selects a collection to be displayed in the imagery.
Parameters:
| Name | Type | Description |
|---|---|---|
id |
string | The collection to set on top. |