21.1.0
new options object
const query = 'Van Voordenpark 1, Zaltbommel';
const options = {
viewerType: [StreetSmartApi.ViewerType.PANORAMA, StreetSmartApi.ViewerType.OBLIQUE],
srs: 'EPSG:28992',
panoramaViewer: {
closable: true,
maximizable: true,
replace: true,
recordingsVisible: true,
navbarVisible: true,
timeTravelVisible : true,
measureTypeButtonVisible: true,
measureTypeButtonStart: true,
measureTypeButtonToggle: true,
},
obliqueViewer: {
closable: true,
maximizable: true,
navbarVisible: true,
timeTravelVisible : true,
}
};
// Open
StreetSmartApi.open(query, options).then( successCallback, errorCallback);
Below is a small example to get you started. For a more in depth example, go to : https://www.cyclomedia.com/en/service-and-support-for-developers/codeexamples
<script type="text/javascript" src="https://unpkg.com/react@16.4.1/umd/react.production.min.js"></script>
<script type="text/javascript" src="https://unpkg.com/react-dom@16.4.1/umd/react-dom.production.min.js"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/openlayers/4.3.3/ol.js"></script>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/lodash.js/4.17.10/lodash.min.js"></script>
<script src="https://streetsmart.cyclomedia.com/api/v19.5/StreetSmartApi.js"></script>
<script>
// Here you can now call StreetSmartApi.init(), StreetSmartApi.open(),
// or use event contents like this: StreetSmartApi.Events.panoramaViewer.RECORDING_LOADED
</script>
Some customers of CycloMedia have the imagery that they bought hosted on an internal website. For this reason the API can connect to this local imagery. For more information, go to : http://localinstallation.cyclomedia.com There you can also find information about how to simulate a local installation for development purposes.
ObliqueViewer component. Do not create this component directly; use the open function.
Get the visibility of a button
(any)
Boolean
:
Returns the ID of this viewer
String
: The ID of this viewer.
Request the ID of a viewer:
StreetSmartApi.open('Van Voordenpark 1, Zaltbommel', {
viewerType: [StreetSmartApi.ViewerType.OBLIQUE],
srs: 'EPSG:28992',
}).then(
function(result) {
console.log(StreetSmartApi.getViewers()[0].getId());
});
Returns whether the timetravel component is visible or hidden.
Boolean
:
Returns whether timetravel is enabled for the ObliqueViewer.
Boolean
:
Returns the type of this viewer.
ViewerType
: The type of this viewer.
Downloads an image of the current oblique image.
Set the brightness of the oblique viewer.
(Number?)
set brightness to a positive number, normally use a value between 50 and 150.
Set the contrast of the oblique viewer.
(Number?)
set contrast to a positive number, normally use a value between 50 and 150.
Changes the viewing direction of the oblique viewer.
(number)
Change direction (-90, 90 180).
Toggle the visibility of a button.
(ObliqueViewerUi)
(Boolean?)
if available, sets enabled to this value
Enables/disables the ability to toggle the sidebar in the ObliqueViewer.
(Boolean?)
if available, sets visibility to this value.
Modify the state of sidebar expanded in the ObliqueViewer.
(Boolean?)
if available, sets expanded to this value.
Toggles the visibility of the sidebar in the ObliqueViewer.
(Boolean?)
if available, sets visibility to this value.
Expands or hides the timetravel components.
(Boolean?)
if available, -value for expanding or hiding time travel.
Enables or disables timetravel in the ObliqueViewer.
(Boolean?)
if available, value for enabling or disabling toggles time travel.
Zoom in in the Oblique image.
Zoom out in the Oblique image.
selection of the features changed.
(string)
: event type
(Object)
: event properties
detail.layerId
Object
Id of the layer(as returned when adding the layer/overlay, empty if all the features are deselected)
detail.layerName
boolean
Name of the layer that has been changed(as provided in options when adding the layer, empty if all the features are deselected)
detail.featureProperties
boolean
properties of the feature that has been changed(empty if feature is deselected)
PanoramaViewer component. Do not create this component directly; use the open function.
Returns the ID of this viewer.
String
: The ID of this viewer.
Request the ID of a viewer:
StreetSmartApi.open('5D4KX5SM', {
viewerType: [StreetSmartApi.ViewerType.PANORAMA],
srs: 'EPSG:28992',
panoramaViewer: { replace: false, },
}).then(
function(result) {
console.log(StreetSmartApi.getViewers()[0].getId());
});
Gets the current active recording of the PanoramaViewer.
Recording
:
Returns the type of this viewer.
ViewerType
: The type of this viewer.
Sets the orientation of the PanoramaViewer to look at a certain coordinate.
(Coordinate)
coordinate to look at
(string?)
If provided, will use to convert coordinate to viewer srs.
Opens a panorama closest to the given address.
(string)
Address you want to search.
(string?)
Optional, coordinate system in which the panorama will be opened. E.g. "EPSG:28992"
Promise<(Recording | Error)>
: Returns a new promise for the result that may be used to chain additional functions.
Open a panorama near Cyclomedia HQ
// Having StreetSmartApi intialized:
let viewer = streetSmartApi.addPanoramaViewer(viewerDomElement);
// Now open the address]
viewer.openByAddress("Van Voordenpark 1B, Zaltbommel", "EPSG:29882").catch(function(err){ console.log(err.message)});
Opens an image by coordinates and accompanying coordinate system.
(Coordinate)
Coordinate of location to open a panorama
(string?)
If provided, will use to convert coordinate to viewer srs.
Promise<(Recording | Error)>
: Returns a new promise for the result that may be used to chain additional functions.
Opens an image by imageId.
(string)
ID of the image that needs to be opened. E.g. "5D38RPNF".
(string?)
Optional, coordinate system in which the panorama will be opened. E.g. "EPSG:28992".
Promise<(Recording | Error)>
: Returns a new promise for the result that may be used to chain additional functions.
Rotates the panorama vertically by a certain amount, as if the camera is turning to the ground.
(number)
amount to rotate the image, in degrees.
Rotates the panorama horizontally by a certain amount, as if the camera is turning to the left.
(number)
amount to rotate the image, in degrees.
Rotates the panorama horizontally by a certain amount, as if the camera is turning to the right.
(number)
amount to rotate the image, in degrees.
Rotates the panorama vertically by a certain amount, as if the camera is turning to the sky.
(number)
amount to rotate the image, in degrees.
Downloads an image of the current panorama.
Set the brightness of the panorama viewer.
(Number?)
set brightness to a positive number, normally use a value between 50 and 150.
Set the contrast of the panorama viewer.
(Number?)
set contrast to a positive number, normally use a value between 50 and 150.
Sets the orientation (yaw, pitch, hFov), in degrees, of the PanoramaViewer to specific values all at once.
Sets the selected feature using the given properties. The selected feature can only be selected if the feature is in sight on the panorama viewer.
(Object)
The properties by which the feature should be determined
(string?)
The layer Id to which the feature is added
// Having StreetSmartApi intialized:
let viewer = streetSmartApi.addPanoramaViewer(viewerDomElement);
var properties = {"MyAttribute1": "MyValue1", "MyAttribute2": "MyValue2"};
viewer.setSelectedFeatureByProperties(properties, layerId);
Toggles the visibility of the Attribute information panel, decided if it should be shown on clicking on a feature.
(Boolean?)
if available, sets visibility to this value.
Toggles the visibility of the 3D cursor in the PanoramaViewer.
(Boolean?)
if available, sets visibility to this value.
Toggles the visibility of the Address features in the PanoramaViewer.
(Boolean?)
if available, sets visibility to this value.
Toggles the visibility of the recording features in the PanoramaViewer.
(Boolean?)
if available, sets visibility to this value.
Enables/disables the ability to toggle the sidebar in the PanoramaViewer.
(Boolean?)
if available, sets visibility to this value.
Modify the state of sidebar expanded in the PanoramaViewer.
(Boolean?)
if available, sets expanded to this value.
Toggles the visibility of the sidebar in the PanoramaViewer.
(Boolean?)
if available, sets visibility to this value.
Expands or hides the timetravel components.
(Boolean?)
if available, -value for expanding or hiding time travel.
Enables or disables timetravel in the PanoramaViewer.
(Boolean?)
if available, value for enabling or disabling toggles time travel.
Zoom in in the Panorama. This will decrease the hFov by 5 degrees.
Zoom out in the Panorama. This will increase the hFov by 5 degrees.
Returns whether the timetravel component is visible or hidden.
Boolean
:
Returns whether timetravel is enabled for the PanoramaViewer.
Boolean
:
Toggle the visibility of a button.
(PanoramaViewerUi)
(any)
if available, set enabled to this value
selection of the features changed.
(string)
: event type
(Object)
: event properties
detail.layerId
Object
Id of the layer(as returned when adding the layer/overlay, empty if all the features are deselected)
detail.layerName
boolean
Name of the layer that has been changed(as provided in options when adding the layer, empty if all the features are deselected)
detail.featureProperties
boolean
properties of the feature that has been changed(empty if feature is deselected)
Measurement changed or added.
(string)
: event type
(Object)
: event properties
detail.activeMeasurement
object
The added or changed Measurement
detail.panoramaViewer
PanoramaViewer
PanoramaViewer where the measurement was changed or added
The surface cursor changed position.
Error loading tile(s)
(string)
: event type
(object)
: event properties
detail.xhr
XMLHttpRequest
The XMLHttpRequest that was used to load the tile
PointCloudViewer component. Do not create this component directly; use the open function.
Toggles between aerial point cloud and street point cloud
(PointCloudType?)
if available, sets the type of point cloud.
Moves the camera of the pointcloud viewer towards a given coordinate.
(Coordinate)
Coordinate to move to.
(Coordinate?)
Coordinate to look at.
Get the visibility of a button.
(any)
Boolean
:
Returns the current position of the camera, and position of the target its looking at.
object
: info
THREE.Vector3
: info.cameraPosition - current position of the camera
THREE.Vector3
: info.cameraTarget - current position of target the camera is looking at
returns {
cameraPosition: {x:100 , y: 12 , z: 5},
cameraTarget: {x:98 , y: 11 , z: 4}
};
Get current visibility of black edges around points.
Boolean
: visibility of edges around points
Get current point budget.
string
: budget - can be 'Low', 'Med' or 'High'
Get current style of points
PointStyle
: style - the style of points
Returns the type of this viewer.
ViewerType
: The type of this viewer.
Rotates the camera of the pointcloud viewer towards a given coordinate.
(Coordinate)
Coordinate to look at.
Rotates the camera a given amount of degrees towards the down
(number)
amount of degrees to rotate right.
Rotates the camera a given amount of degrees towards the left
(number)
amount of degrees to rotate left.
Rotates the camera a given amount of degrees towards the right
(number)
amount of degrees to rotate right.
Rotates the camera a given amount of degrees towards the up
(number)
amount of degrees to rotate right.
Set the maximum amount of point displayed in the viewer.
(string)
can be set to 'Low', 'Med' or 'High'
Set the size points are displayed on.
(number)
new size of points in the viewer. Range between 0.1 and 50.
Set the style of points. See PointStyle Enum.
(PointStyle)
new the style of points
Add a GeoJSON overlay to the panorama viewer. Can be removed with removeOverlay
(object)
Set of parameters for overlay
Name | Description |
---|---|
options.geojson object
|
GeoJSON object containing the layer data |
options.name string?
|
Name of the layer |
options.sourceSrs string?
|
Optional EPSG code (srs) for the source GeoJSON, if not provided, srs of API initialisation is used. |
options.sldXMLtext string?
|
Optional XML string for Styled Layer Descriptor |
options.color string?
|
Optional color string, needs to be a hexadecimal value |
options.visible boolean?
|
Optional for setting the visibility of the layer, default is true |
{id: (string)}
:
var options = {name: 'My GeoJSON', geojson: {}, sourceSrs: 'EPSG:28992', sldXMLtext: 'XMLstring'};
var layer = StreetSmartApi.addOverlay(options);
var layerId = layer.id
Add a WFS Layer as overlay to the panorama viewer. Can be removed with removeOverlay
(Object)
Set of parameters for overlay
Name | Description |
---|---|
options.name string
|
Name of the layer |
options.url string
|
The url where the WFS is hosted. Not needed if a remoteOWS is provided in the sld. |
options.typeName string
|
The type name of the layer. Not needed if a remoteOWS is provided in the sld. |
options.version string
|
The WFS version to be used |
options.sldXMLtext string?
|
Optional XML string for Styled Layer Descriptor, this can contain an remoteOWS with wfs service. |
options.color string?
|
Optional color string, needs to be a hexadecimal string value |
options.authRequired boolean?
|
Whether this layer requires authentication to access |
options.credentials credentials?
|
Credentials used to access the layer. |
options.visible boolean?
|
Optional for setting the visibility of the layer, default is true |
{id: (string)}
:
var options = {
name: 'My Super cool layer',
url: 'http://testserver.com/geoserver/streets/wfs',
typeName: 'streets:street-center-lines',
version: '1.1.0',
color: '#00ff00',
authRequired: true,
credentials: { username: 'Mike', password: 'Tyson'}
};
var layer = StreetSmartApi.addWFSLayer(options);
var layerId = layer.id
Close a panorama or oblique viewer using a window ID (wid).
(string)
The ID of the viewer to close.
Promise<any>
: When the promise resolves, it returns an array with references to all viewers of type
PanoramaViewer
and/or
ObliqueViewer
.
Close a viewer by ID:
StreetSmartApi.open('5D4KX5SM', {
viewerType: [StreetSmartApi.ViewerType.PANORAMA],
srs: 'EPSG:28992',
panoramaViewer: { replace: false, },
}).then(
function(result) {
if (result && result[0]) {
setTimeout(() => {
StreetSmartApi.closeViewer(result[0].props.id).then(
function(res) {
if (res) {
console.log('Opened and closed a viewer, resulting in an empty list of viewers: ' + res);
}
}).catch(
function(err) {
console.log('error closing viewer: ' + err);
}
)
}, 1000);
}
}).catch(
function(reason) {
console.log('Error opening panorama viewer: ' + reason);
}
)
Destroys the API. Cleans up its event handlers and makes used memory available for garbage collection.
Get the active measurement
Array
: Returns Array that includes Type, GeoJSON data and CRS object.
Get the active measurement data
StreetSmartApi.getActiveMeasurement();
result:
{
type: String,
features: [
geometry: Object,
properties: Object,
type: String,
],
crs: Object,
}
Returns the object containing the address search settings.
{locale: (string), database: (string)}
: Object containing the address settings.
Returns the current 'ready'-state of the API.
Boolean
: 'ready'-state.
Returns the application name of the API.
string
: Application name.
Returns the used version of the API.
string
: API version number.
Returns all logs, including ones invisible to integrators.
Array<string>
: Array of console logs
Returns the object containing functionalities that are currently permitted to use by the user.
Array
: Array containing the permissions.
Return an array with references to all viewers.
Array<Object>
: Returns an array with references to all viewers of type
PanoramaViewer
and/or
ObliqueViewer
.
Get opened viewers:
StreetSmartApi.open('5D4KX5SM', {
viewerType: [StreetSmartApi.ViewerType.PANORAMA],
srs: 'EPSG:28992',
replace: false,
}).then(
function(result) {
if (result && result[0]) {
const viewers = StreetSmartApi.getViewers();
console.log('Viewer Array:', viewers);
}
}).catch(
function(reason) {
console.log('Error opening panorama viewer: ' + reason);
}
)
Initializes the API using the inserted values. Required to use functional viewers.
Please choose a feet or metric system like: EPSG:26918 (UTM18 - USA) or EPSG:28992 (Netherlands)
(Object)
Object containing the options used for initializing the API.
Name | Description |
---|---|
options.targetElement Element?
|
DOM element to render the viewers into. |
options.username string?
|
Username of the user. |
options.password string?
|
Password of the user. |
options.tid string?
|
Password of the user. |
options.apiKey string
|
apiKey given to the user. |
options.srs string
|
EPSG code of the coordinate system used in the API. E.g. "EPSG:28992". |
options.locale string
(default 'en-US' )
|
Language used as default in the API. |
options.overlayDrawDistance string
(default 30 )
|
max distance that is used for draw the overlays in the panorama viewer. |
options.configurationUrl string?
|
Alternate configuration url to use for all configuration services. Can be used for a local installation . |
options.addressSettings {locale: string, database: string}?
|
The address settings to use for address searches.
locale - The locale to use. e.g. 'nl'. database - The name of the database. e.g. 'CMDatabase'. |
Promise
: Returns a new promise for the result that may be used to chain additional functions.
Initializing a StreetSmartApi.
<script type="text/javascript" src="src/StreetSamrtApi.js"></script>
// Set variables for initialization.
let options = {
targetElement: document.getElementById('streetsmartApi'),
username: "username",
password: "password",
srs: "EPSG:29882",
apiKey: "XXXX-XXXX-XXXX-XXXX",
locale: "en-US",
overlayDrawDistance: 30,
addressSettings: {
locale: "nl",
database: "CMDatabase"
}
};
// Initalize
StreetSmartApi.init(options).then( successCallback, errorCallback);
Method to add an event listener.
(Function)
Function which was set on the event listener.
StreetSmartAPI
: Returns back the instance of StreetSmartAPI so you can remove events in a chain.
Method to add an event listener.
(Function)
Function which was set on the event listener.
PanoramaViewer
: Returns back the instance of PanoramaViewer so you can remove events in a chain.
Method to add an event listener.
(Function)
Callback for event listener. Will provide an event as the first argument.
StreetSmartAPI
: Returns back the instance of StreetSmartAPI so you can add events in a chain.
Method to add an event listener.
(Function)
Callback for event listener. Will provide an event as the first argument.
PanoramaViewer
: Returns back the instance of PanoramaViewer so you can add events in a chain.
Open a panorama, oblique and/or point cloud viewer using a query. The query can be a coordinate, an extent, an address or a panorama/oblique ID.
(string)
The query
'86580,437038'
'86580,437038,86880,437338'
'Domplein, Utrecht'
'5D4KX5SM'
'014_0849_00135489_NOB16'
(object)
Name | Description |
---|---|
options.viewerType Array<ViewerType>
|
an array indicating what kind of viewer(s) to open |
options.srs string
|
EPSG code of the spatial reference system to use |
options.panoramaViewer PanoramaViewerOptions
|
options object for PanoramaViewer options |
options.obliqueViewer ObliqueViewerOptions
|
options object for ObliqueViewer options |
options.pointcloudViewer PointcloudViewerOptions
|
options object for PointcloudViewer options |
Promise<any>
: When the promise resolves, it returns an array with references to the created
PanoramaViewer
and/or
ObliqueViewer
.
Open a panorama viewer by ID:
StreetSmartApi.open('5D4KX5SM', {
viewerType: [StreetSmartApi.ViewerType.PANORAMA],
srs: 'EPSG:28992',
panoramaViewer: { replace: false, },
}).then(
function(result) {
if (result && result[0]) {
console.log('Opened a panorama viewer through API!', result[0]);
}
}
).catch(
function(reason) {
console.log('Error opening panorama viewer: ' + reason);
}
)
Open a panorama viewer by coordinate and date range (this is only applicable for the panorama viewer):
StreetSmartApi.open(
{
coordinate: [121692.34, 487812.37, 5.60],
dateRange: {from: '2017-03-01', to: '2017-04-01'},
},
{
viewerType: [StreetSmartApi.ViewerType.PANORAMA],
srs: 'EPSG:28992',
panoramaViewer: { replace: false, },
}).then(
function(result) {
if (result && result[0]) {
console.log('Opened a panorama viewer through API!', result[0]);
}
}
).catch(
function(reason) {
console.log('Error opening panorama viewer: ' + reason);
}
)
Open a panorama viewer and oblique viewer by address:
StreetSmartApi.open('Van Voordenpark 1, Zaltbommel', {
viewerType: [StreetSmartApi.ViewerType.PANORAMA, StreetSmartApi.ViewerType.OBLIQUE],
srs: 'EPSG:28992',
}).then(
function(result) {
if (result && result[0] && result[1]) {
console.log('Opened a panorama viewer and oblique viewer through API!', result[0], result[1]);
}
}
).catch(
function(reason) {
console.log('Error opening viewers: ' + reason);
}
)
Open an aerial pointcloud viewer by coordinate:
StreetSmartApi.open(
{
coordinate: [121692.34, 487812.37, 5.60],
},
{
viewerType: [StreetSmartApi.ViewerType.POINTCLOUD],
srs: 'EPSG:28992',
pointcloudViewer: { pointCloudType: StreetSmartApi.PointCloudType.AERIAL }}).then(
function(result) {
if (result && result[0]) {
console.log('Opened a pointcloud viewer through API!', result[0]);
}
}
).catch(
function(reason) {
console.log('Error opening pointcloud viewer: ' + reason);
}
)
Open a panorama viewer and an aerial pointcloud viewer by coordinate:
StreetSmartApi.open(
{
coordinate: [121692.34, 487812.37, 5.60],
},
{
viewerType: [StreetSmartApi.ViewerType.PANORAMA, StreetSmartApi.ViewerType.POINTCLOUD],
srs: 'EPSG:28992',
panoramaViewer: { replace: false, },
pointcloudViewer: { pointCloudType: StreetSmartApi.PointCloudType.AERIAL }}).then(
function(result) {
if (result) {
console.log('Opened a pointcloud viewer and a panorama viewer through API!', result);
}
}
).catch(
function(reason) {
console.log('Error opening pointcloud viewer and panorama viewer: ' + reason);
}
)
Remove a GeoJSON overlay from the panorama viewer
var layer = StreetSmartApi.addOverlay("My GeoJSON", {}, "EPSG:28992");
StreetSmartApi.removeOverlay(layer.id)
EXPERIMENTAL Set the active measurement.
(any)
(object)
A Geojson FeatureCollection including a crs object. see
http://geojson.org/geojson-spec#coordinate-reference-system-objects
Set the active measurement data
var measurement = StreetSmartApi.getActiveMeasurement();
measurement.features[0].properties.id = 'changed_measurement'
StreetSmartApi.setActiveMeasurement(measurement);
measurement:
{
type: String,
features: [
geometry: Object,
properties: Object,
type: String,
],
crs: Object,
}
example crs:
{
type: 'name',
properties: {
name: 'EPSG:28992',
}
}
set de overlay draw distance in
(string)
var layer = StreetSmartApi.addOverlay("My GeoJSON", {}, "EPSG:28992");
StreetSmartApi.setOverlayDrawDistance(50);
Start measurement mode for the given panorama viewer.
(object?)
Object containing measurement options.
Name | Description |
---|---|
options.geometry MeasurementGeometryTypes?
|
Bypasses the measurement mode dialog and starts measurement in the given mode. |
options.measureMethod MeasureMethods?
|
Starts the measurement with a specified measurement method. MeasureSmart, SmartClick or Forward Intersection. only applicable to panorama measurements. |
Start measurement mode without passing a geometry type. The user can then choose the measurement mode.
StreetSmartApi.startMeasurementMode(panoramaViewer);
Start measurement mode as point measurement
StreetSmartApi.startMeasurementMode(panoramaViewer, {geometry:StreetSmartApi.MeasurementGeometryType.POINT});
Start measurement mode as distance measurement
StreetSmartApi.startMeasurementMode(panoramaViewer, {geometry:StreetSmartApi.MeasurementGeometryType.LINESTRING});
Start measurement mode as surface measurement
StreetSmartApi.startMeasurementMode(panoramaViewer, {geometry:StreetSmartApi.MeasurementGeometryType.POLYGON});
Start measurement mode as surface measurement
StreetSmartApi.startMeasurementMode(panoramaViewer, {geometry:StreetSmartApi.MeasurementGeometryType.POLYGON, measureMethod: StreetSmartApi.MeasureMethods.SMART_CLICK });
Stop measurement mode
Stop measurement mode
StreetSmartApi.stopMeasurementMode();
Object which contains event type constants for all components.
Names of oblique events that the ObliqueViewer dispatches.
Names of the events that the PanoramaViewer dispatches.
(string)
(string)
(string)
(string)
(string)
(string)
(string)
(string)
(string)
(string)
(string)
(string)
Object which is an Interface for changing certain settings withing the api
(function)
: sets the units used to show measurement and other geological data.
(function)
: gets the units used to show measurement and other geological data.
(Object)
: Enum containing a list of available unit preferences
gets the units used to show measurement and other geological data.
string
: preference - returns the currently set unit preference
Object which is an Interface for enabeling/disabeling shortcuts
(function)
: enables the usage of a shortcut within the api.
(function)
: disables the usage of a shortcut within the api.
(Object)
: Object containing a list of available shortcut names
removes a shortcut from the list of enabledShortcuts. Can be added with enableShortcut
(string)
The name of the shortcut, as found in ShortCuts.ShortcutNames
boolean
: success - true if shortcut has been disabled, false if unknown shortcut or already disallowed.
Add a shortcut to the list of enabledShortcuts. Can be removed with disableShortcut
(string)
The name of the shortcut, as found in ShortCuts.ShortcutNames
boolean
: success - true if shortcut has been enabled, false if unknown shortcut or already allowed.
Object containing a list of available shortcut names
(String)
(String)
(String)
(String)
(String)
(String)
(String)
(String)
(String)
(String)
(String)
(String)
Coordinate definition
Type: Object
Enum for measure methods.
Type: object
Measurement Geometry types
Type: object
Definition of options for ObliqueViewer
Type: Object
(boolean)
: Show window close button. Default is true.
(boolean)
: Show window maximize button. Default is true.
(boolean)
: Enable viewing earlier oblique images.
(boolean)
: Show viewer navigation bar.
(boolean)
: Show viewer navigation bar.
Definition of oblique viewer UI elements
Type: Object
(Object)
: Buttons
buttons.OVERLAYS
string
Button for opening overlaypanel
buttons.CENTER_MAP
string
Button center map on current oblique location
buttons.IMAGE_INFORMATION
string
Button open image information panel
buttons.ZOOM_IN
string
Zoom in button
buttons.ZOOM_OUT
string
Zoom out button
buttons.SWITCH_DIRECTION
string
Buttons for switching viewing direction
buttons.SAVE_IMAGE
string
Button for saving image
buttons.TOGGLE_NADIR
string
Button for toggling between Oblique and Nadir images
(string)
: timetravel UI elements
(string)
: toolbar
Definition of options for PanoramaViewer
Type: Object
(boolean)
: Show window close button. Default is true.
(boolean)
: Show window maximize button. Default is true.
(boolean)
: Replace already opened panorama viewer.
(boolean)
: Show recording dots.
(boolean)
: Enable viewing earlier recordings.
(boolean)
: Show viewer navigation bar.
(boolean)
: Show viewer navigation bar.
(boolean)
: Show measurement type button in measurement the navigation bar. Default is true.
(boolean)
: Allow toggle of measurement type in measurement the navigation bar. Default is true.
(boolean)
: Start new measurement when clicking on measurement type button in measurement the navigation bar. Default is true.
Definition of panorama viewer UI elements
Type: object
(string)
: Buttons
buttons.ELEVATION
string
Button open elevation panel
buttons.OVERLAYS
string
Button open overlay panel
buttons.OPEN_OBLIQUE
string
Button open oblique on current panorama location
buttons.REPORT_BLURRING
string
Button report blurring issue
buttons.MEASURE
string
Button for measuring
buttons.IMAGE_INFORMATION
string
Button open image information panel
buttons.SAVE_IMAGE
string
Button for saving image
buttons.ZOOM_IN
string
Zoom in button
buttons.ZOOM_OUT
string
Zoom out button
(string)
: timetravel UI elements
(string)
: toolbar
(string)
: recording dots
(string)
: measurements
(string)
: addresses
(string)
: search location
Definition of PointStyles
Type: Object
Definition of options for Point cloud viewer
Type: Object
(PointCloudType)
: type point cloud to open.
Array of length four with four elements. r, g, b, a, respectively.
Type: Array
Definition of viewer types
Type: Object
Type: Object