IStreetSmartAPI Interface

API used to use and modify various StreetSmart components.

Definition

Namespace: StreetSmart.Common.Interfaces.API
Assemblies:  StreetSmart.WinForms (in StreetSmart.WinForms.dll) Version: 25.7.0.0+8d57adf8e9b2f0e8b292285b4ebbbdc257654fdc
  StreetSmart.WPF (in StreetSmart.WPF.dll) Version: 25.7.0.0+8d57adf8e9b2f0e8b292285b4ebbbdc257654fdc
C#
public interface IStreetSmartAPI

Properties

GUI The GUI of StreetSmart
Settings Object which is an Interface for changing certain settings withing the api
Shortcuts Object which is an Interface for enabling/disabling shortcuts

Methods

AddOverlay Add a GeoJSON overlay to the panorama viewer. SRS of API initialisation is used. Use overload with sourceSrs parameter if provided GeoJSON is in a different coordinate system.
AddWFSLayer Add a WFS Layer as overlay to the panorama viewer. Can be removed with removeOverlay
CloseDevTools Close the developer tools
CloseViewer Close a panorama or oblique viewer.
Destroy Destroys the API. Cleans up its event handlers and makes used memory available for garbage collection.
GetActiveMeasurement Returns the active measurement in GeoJSON format
GetAddressSettings Returns the object containing the address search settings
GetApiReadyState Returns the current 'ready'-state of the API. This is an asynchronous function.
GetApplicationName Returns the application name of the API. This is an asynchronous function.
GetApplicationVersion Returns the used version of the API. This is an asynchronous function.
GetBearerToken Returns the Bearer token from the API. This is an asynchronous function.
GetDebugLogs Returns all logs, including ones invisible to integrators.
GetPermissions Returns the object containing functionalities that are currently permitted to use by the user. This is an asynchronous function.
GetViewers Return an array with references to all viewers.
Init Initializes the API using the inserted values. Required to use functional PanoramaViewers.
Open Open a panorama and/or oblique viewer using a query. The query can be a coordinate, an extent, an address or a panorama/oblique ID.
RemoveOverlay Removes a GeoJSON overlay from the panorama viewer.
RestartStreetSmart Restarts streetsmart
RestartStreetSmart(String) Restarts streetsmart
SetActiveMeasurement Set the active measurement in GeoJSON format
SetOverlayDrawDistance Set overlay draw distance
SetSnapping Sets whether or not cursor movements will snap to nearby features while in measurement mode
ShowDevTools Show the developer tools
StartMeasurementMode Starts the measurement
StopMeasurementMode Stops the measurement
UpdateOverlay Update a GeoJSON overlay to the panorama viewer. SRS of API initialisation is used. Use overload with sourceSrs parameter if provided GeoJSON is in a different coordinate system.

Events

APIReady Triggers when the frame is loaded. After this trigger, you can login in the the API.
BearerTokenChanged Bearer token has changed
MeasurementChanged Measurement changed or added.
MeasurementSaved Measurement saved.
MeasurementStarted Measurement started
MeasurementStopped Measurement stopped.
ViewerAdded Viewer is added (panoramic or oblique)
ViewerRemoved Viewer is removed (panoramic of oblique)

Version Information

Supported in: 18.7

See Also