PanToAsync(Bookmark,Nullable<TimeSpan>) Method

In This Topic

Pan the view to the position defined in a bookmark.

Syntax

C#
Visual Basic (Declaration)

public Task<bool> PanToAsync( 
   Bookmark bookmark,
   Nullable<TimeSpan> duration
)

Public Overloads Function PanToAsync( _
   ByVal bookmark As Bookmark, _
   Optional ByVal duration As Nullable(Of TimeSpan) _
) As Task(Of Boolean)

Parameters

bookmark: The bookmark containing the position in which to pan.
duration: The amount of time to navigate the view to the new camera position. If null it uses the default navigation duration.

Return Value

True if the navigation is completed, false if it was interrupted by another view navigation.

Remarks

Pan in 2D maintains the current camera scale and heading and modifies the X and Y position. Pan in 3D maintains the current camera pitch and heading and modifies the X and Y position.

Example

Pan To Bookmark Asynchronous

public async Task<bool> PanToBookmarkAsync(string bookmarkName)
{
  //Get the active map view.
  var mapView = MapView.Active;
  if (mapView == null)
    return false;

  //Get the first bookmark with the given name.
  var bookmark = await QueuedTask.Run(() => mapView.Map.GetBookmarks().FirstOrDefault(b => b.Name == bookmarkName));
  if (bookmark == null)
    return false;

  //Pan the view to the bookmark.
  return await mapView.PanToAsync(bookmark, TimeSpan.FromSeconds(2));
}

Pan To Bookmark

public Task<bool> PanToBookmark(string bookmarkName)
{
  return QueuedTask.Run(() =>
  {
    //Get the active map view.
    var mapView = MapView.Active;
    if (mapView == null)
      return false;

    //Get the first bookmark with the given name.
    var bookmark = mapView.Map.GetBookmarks().FirstOrDefault(b => b.Name == bookmarkName);
    if (bookmark == null)
      return false;

    //Pan the view to the bookmark.
    return mapView.PanTo(bookmark);
  });
}

public async Task<bool> PanToBookmarkAsync(string bookmarkName)
{
  //Get the active map view.
  var mapView = MapView.Active;
  if (mapView == null)
    return false;

  //Get the first bookmark with the given name.
  var bookmark = await QueuedTask.Run(() => mapView.Map.GetBookmarks().FirstOrDefault(b => b.Name == bookmarkName));
  if (bookmark == null)
    return false;

  //Pan the view to the bookmark.
  return await mapView.PanToAsync(bookmark, TimeSpan.FromSeconds(2));
}

Requirements

Target Platforms: Windows 11, Windows 10, Windows 8.1

Reference

MapView Class
MapView Members
Overload List

Send feedback