Click or drag to resize

IStreetSmartAPI Interface

API used to use and modify various StreetSmart components.

Namespace:  StreetSmart.WinForms.Interfaces
Assembly:  StreetSmart.WinForms (in StreetSmart.WinForms.dll) Version: 18.3.0.0 (18.3.0.0)
Syntax
public interface IStreetSmartAPI

The IStreetSmartAPI type exposes the following members.

Properties
  NameDescription
Public propertyGUI
The GUI of StreetSmart
Top
Methods
  NameDescription
Public methodAddOverlay
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.
Public methodCloseDevTools
Close the developer tools
Public methodDestroy
Destroys the API. Cleans up its event handlers and makes used memory available for garbage collection.
Public methodGetActiveMeasurement
Returns the active measurement in GeoJSON format
Public methodGetAddressSettings
Returns the object containing the address search settings
Public methodGetApiReadyState
Returns the current 'ready'-state of the API. This is an asynchronous function.
Public methodGetApplicationName
Returns the application name of the API. This is an asynchronous function.
Public methodGetApplicationVersion
Returns the used version of the API. This is an asynchronous function.
Public methodGetDebugLogs
Returns all logs, including ones invisible to integrators.
Public methodGetPermissions
Returns the object containing functionalities that are currently permitted to use by the user. This is an asynchronous function.
Public methodCode exampleInit
Initializes the API using the inserted values. Required to use functional PanoramaViewers.
Public methodCode exampleOpen
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.
Public methodRemoveOverlay
Removes a GeoJSON overlay from the panorama viewer.
Public methodShowDevTools
Show the developer tools
Public methodStartMeasurementMode
Starts the measurement
Public methodStopMeasurementMode
Stops the measurement
Top
Events
  NameDescription
Public eventAPIReady
Triggers when the frame is loaded. After this trigger, you can login in the the API.
Public eventMeasurementChanged
Measurement changed or added.
Public eventViewerAdded
Viewer is added (panoramic or oblique)
Public eventViewerRemoved
Viewer is removed (panoramic of oblique)
Top
See Also