IStreetSmartAPIOpen Method

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.

Definition

Namespace: StreetSmart.Common.Interfaces.API
Assembly: StreetSmart.WinForms (in StreetSmart.WinForms.dll) Version: 24.7.0.0+cc0a01953d1235087ce28d3e921f5bb47d3c0460
C#
Task<IList<IViewer>> Open(
	string query,
	IViewerOptions options
)

Parameters

query  String
query for open a panoramic image
options  IViewerOptions
viewer options for open the panoramic image

Return Value

TaskIListIViewer
Asynchronous function, A list of opened viewers

Example

This sample shows how to use the Open(String, IViewerOptions) function.
C#
using System;
using System.Collections.Generic;
using StreetSmart.Common.Exceptions;
using StreetSmart.Common.Factories;
using StreetSmart.Common.Interfaces;

namespace Demo
{
  public class Example
  {
    private IStreetSmartAPI _api;
    private System.Windows.Forms.Panel plStreetSmart = new System.Windows.Forms.Panel();

    public void StartAPI()
    {
      _api = StreetSmartAPIFactory.Create();
      _api.APIReady += OnAPIReady;
      plStreetSmart.Controls.Add(_api.GUI);
    }

    private async void OnAPIReady(object sender, EventArgs args)
    {
      // The dom element within the api must be rendered.
      IDomElement element = DomElementFactory.Create();

      // The initialisation options of the api
      IOptions options = OptionsFactory.Create("myUsername", "myPassword", "myAPIKey", "EPSG:28992", element);

      // Initialize the api.
      await _api.Init(options);

      // The open viewer options for open a new panorama viewer in EPSG:28992.
      IViewerOptions viewerOpt = ViewerOptionsFactory.Create(new List<ViewerType> {ViewerType.Panorama}, "EPSG:28992");

      try
      {
        IList<IViewer> viewers = await _api.Open("Lange Haven 145, Schiedam", viewerOpt);
        // Todo: add functionality
      }
      catch (StreetSmartImageNotFoundException ex)
      {
        // image not found exception (ex)
      }
    }
  }
}

Exceptions

StreetSmartImageNotFoundExceptionThrown when no image is found

Version Information

Supported in: 18.7

See Also