Extends
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.
# getAvailableLayerCollections() → {Array.<LayerCollectionsStatus>}
Get all collections in center separated by layer collections.
# getCenterImageMetadata() → {Image}
Retrieves metadata of the images at the center of the view.
The image metadata.
# getLayerCollections() → {Array.<LayerCollections>}
Get all collections separated by layer collections.
# getMaxZoom() → {number}
Gets the maximum zoom level of the layer.
- Overrides:
The maximum zoom level of the layer.
# getMinZoom() → {number}
Gets the minimum zoom level of the layer.
- Overrides:
The minimum zoom level of the layer.
# getOpacity() → {number}
Gets the opacity of the layer (between 0 and 1).
- Overrides:
The opacity of the layer.
# getVisible() → {boolean}
Gets the visibility of the layer (true or false).
- Overrides:
The visibility of the layer.
# hasInfrared() → {boolean}
Checks if infrared imagery is available in the current mode.
- Returns
trueif infrared imagery is available, otherwisefalse.
# hideVexcelSources(vexcelLayers)
Sets the sources for removing in the base Imagery Layer
Parameters:
| Name | Type | Description |
|---|---|---|
vexcelLayers |
Array.<string> | List of layer sources to remove. Should be values from VexcelLayers |
# 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(layerCollection, collectionId)
Loads discrete imagery by project.
Parameters:
| Name | Type | Description |
|---|---|---|
layerCollection |
string | The layer collections 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. |
# setMaxZoom(maxZoom)
Sets the maximum zoom (exclusive) at which the layer is visible. Note that the zoom levels for layer visibility are based on the view zoom level, which may be different from a tile source zoom level.
Parameters:
| Name | Type | Description |
|---|---|---|
maxZoom |
number | The maximum zoom of the layer. |
- Overrides:
# setMinZoom(minZoom)
Sets the minimum zoom (inclusive) at which the layer is visible. Note that the zoom levels for layer visibility are based on the view zoom level, which may be different from a tile source zoom level.
Parameters:
| Name | Type | Description |
|---|---|---|
minZoom |
number | The minimum zoom of the layer. |
- Overrides:
# setOpacity(opacity)
Sets the opacity of the layer, allowed values range from 0 to 1.
Parameters:
| Name | Type | Description |
|---|---|---|
opacity |
number | The opacity of the layer. |
- Overrides:
# setVisible(visible)
Sets the visibility of the layer (true or false).
Parameters:
| Name | Type | Description |
|---|---|---|
visible |
boolean | The visibility of the layer. |
- Overrides:
# showVexcelSources(vexcelLayers)
Sets the sources for the base Imagery Layer to the specified list, removing all others
Parameters:
| Name | Type | Description |
|---|---|---|
vexcelLayers |
Array.<string> | List of layer sources to keep. Should be values from VexcelLayers |