Class RadMap

Represents the RadMap class.

Inheritance

System.Object

RadMap

Namespace: Telerik.Windows.Controls

Assembly: Telerik.Windows.Controls.DataVisualization.dll

Syntax

[TelerikToolboxCategory("Data Visualization")]
public class RadMap : ItemsControl

Constructors

RadMap()

Initializes a new instance of the RadMap class.

Declaration

public RadMap()

Fields

IsKeyboardNavigationEnabledProperty

Identifies the IsKeyboardNavigationEnabled dependency property.

Declaration

public static readonly DependencyProperty IsKeyboardNavigationEnabledProperty

Field Value

System.Windows.DependencyProperty

MiniMapExpanderVisibilityProperty

Identifies the MiniMapExpanderVisibility dependency property.

Declaration

public static readonly DependencyProperty MiniMapExpanderVisibilityProperty

Field Value

System.Windows.DependencyProperty

MouseLocationIndicatorVisibilityProperty

Identifies the MouseLocationIndicatorVisibility dependency property.

Declaration

public static readonly DependencyProperty MouseLocationIndicatorVisibilityProperty

Field Value

System.Windows.DependencyProperty

ZoomBarPresetsVisibilityProperty

Identifies the ZoomBarPresetsVisibility dependency property.

Declaration

public static readonly DependencyProperty ZoomBarPresetsVisibilityProperty

Field Value

System.Windows.DependencyProperty

Properties

GeoBounds

Gets or sets map geographical bounds.

Declaration

public LocationRect GeoBounds { get; set; }

Property Value

LocationRect

Remarks

You can't use this property to set bounds at the same time with GeoBoundsNW and GeoBoundsSE properties.

GeoBoundsNW

Gets or sets north-west corner of the map geographical bounds.

Declaration

public Location GeoBoundsNW { get; set; }

Property Value

Location

Remarks

You can't use this property to set bounds at the same time with GeoBounds property.

GeoBoundsSE

Gets or sets south-east corner of the map geographical bounds.

Declaration

public Location GeoBoundsSE { get; set; }

Property Value

Location

Remarks

You can't use this property to set bounds at the same time with GeoBounds property.

MouseLocationIndicatorVisibility

Gets or sets visibility of the embedded MouseLocationIndicator UI control.

Declaration

public Visibility MouseLocationIndicatorVisibility { get; set; }

Property Value

System.Windows.Visibility

PinchManipulationSensitivity

Gets or sets sensitivity of the pinch manipulation on the touch screens.

Declaration

public double PinchManipulationSensitivity { get; set; }

Property Value

System.Double

Remarks

The value must be in the [0..1] range.

Methods

ArrangeOverride(Size)

Called to arrange and size the content.

Declaration

protected override Size ArrangeOverride(Size finalSize)

Parameters

System.Windows.Size finalSize

The computed size that is used to arrange the content.

Returns

System.Windows.Size

The calculated size.

ClearContainerForItemOverride(DependencyObject, Object)

Undoes the effects of the PrepareContainerForItemOverride method.

Declaration

protected override void ClearContainerForItemOverride(DependencyObject element, object item)

Parameters

System.Windows.DependencyObject element

The container element.

System.Object item

The item.

Dispose()

Dispose all resources are used by RadMap control.

Declaration

public void Dispose()

ExportToImage(Stream, Boolean, BitmapEncoder)

Exports the current viewport of the map into a steam.

Declaration

public void ExportToImage(Stream stream, bool includeMapObjects = false, BitmapEncoder encoder = null)

Parameters

System.IO.Stream stream

The stream to which the map should be exported.

System.Boolean includeMapObjects

Indicates whether to include or not the objects from the information / visualization layers.

System.Windows.Media.Imaging.BitmapEncoder encoder

The encoder used for the export.

ExportToImage(String, Boolean, BitmapEncoder)

Exports the current viewport of the map into a file with the given fileName parameter.

Declaration

public void ExportToImage(string fileName, bool includeMapObjects = false, BitmapEncoder encoder = null)

Parameters

System.String fileName

The name of the file to which the map should be exported.

System.Boolean includeMapObjects

Indicates whether to include or not the objects from the information / visualization layers.

System.Windows.Media.Imaging.BitmapEncoder encoder

The encoder used for the export.

GetCoercedLocationRect(LocationRect)

Gets a LocationRect whose West is in longitude range(-180;180) by shifting the given LocationRect West longitude.

Declaration

public LocationRect GetCoercedLocationRect(LocationRect baseRect)

Parameters

LocationRect baseRect

Returns

LocationRect

GetGeoSize(Location, Size)

Calculates degree size according to base point and zoom.

Declaration

public Size GetGeoSize(Location basePoint, Size pixelSize)

Parameters

Location basePoint

Base point.

System.Windows.Size pixelSize

The size in pixels.

Returns

System.Windows.Size

Size in degree.

Examples

This example demonstrates how GetGeoSize method can be used to calculate one location from another using pixel distance between 2 points.

Location firstLocation = new Location(40, -100);
double distanceX = 10; // 10 pixels
double distanceY = 20; // 20 pixels
Size pixelSize = new Size(Math.Abs(distanceX), Math.Abs(distanceY));
Size geoSize = this.radMap.GetGeoSize(firstLocation, pixelSize);
Location secondLocation = new Location(
    firstLocation.Latitude - Math.Sign(distanceY) * geoSize.Height,
    firstLocation.Longitude + Math.Sign(distanceX) * geoSize.Width);

Dim firstLocation As New Location(40, -100)
Dim distanceX As Double = 10 ' 10 pixels
Dim distanceY As Double = 20 ' 20 pixels
Dim pixelSize As New Size(Math.Abs(distanceX), Math.Abs(distanceY))
Dim geoSize As Size = Me.radMap.GetGeoSize(firstLocation, pixelSize)
Dim secondLocation As New Location( _
    firstLocation.Latitude - Math.Sign(distanceY) * geoSize.Height, _
    firstLocation.Longitude + Math.Sign(distanceX) * geoSize.Width)

GetLatitudeLongitudeSize(Location, Double, Double)

Calculates degree size according to base point and zoom.

Declaration

public Size GetLatitudeLongitudeSize(Location basePoint, double width, double height)

Parameters

Location basePoint

Base point.

System.Double width

The width in units according to DistanceUnit property.

System.Double height

The height in units according to DistanceUnit property.

Returns

System.Windows.Size

Size in degree.

GetPixelsDistance(Double)

Calculates horizontal pixel distance according to latitude and zoom.

Declaration

public double GetPixelsDistance(double distance)

Parameters

System.Double distance

The distance in units according to DistanceUnit property.

Returns

System.Double

Horizontal distance in pixels.

GetPixelSize(Location, Double, Double)

Calculates pixel size according to base point and zoom.

Declaration

public Size GetPixelSize(Location basePoint, double width, double height)

Parameters

Location basePoint

Base point.

System.Double width

The width in units according to DistanceUnit property.

System.Double height

The height in units according to DistanceUnit property.

Returns

System.Windows.Size

Size in pixels.

GetPixelSizeAtZoomLevel(LocationRect, Int32)

Gets pixel size of the specified geographic region for the given zoom level.

Declaration

public Size GetPixelSizeAtZoomLevel(LocationRect geoRegion, int zoomLevel)

Parameters

LocationRect geoRegion

Geographical region to get pixel size for.

System.Int32 zoomLevel

Zoom level.

Returns

System.Windows.Size

Pixel size of the region.

GetShiftedLocation(Location, Nullable<Location>)

Gets a Location shifted with offset equal to the offset by which the current center is shifted outside longitude range (-180;180).

Declaration

public Location GetShiftedLocation(Location baseLocation, Location? center = default(Location? ))

Parameters

Location baseLocation

System.Nullable<Location> center

Returns

Location

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate.

Declaration

public override void OnApplyTemplate()

OnCreateAutomationPeer()

Returns class-specific System.Windows.Automation.Peers.AutomationPeer implementations for the Windows Presentation Foundation (WPF) infrastructure.

Declaration

protected override AutomationPeer OnCreateAutomationPeer()

Returns

System.Windows.Automation.Peers.AutomationPeer

The type-specific System.Windows.Automation.Peers.AutomationPeer implementation.

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally.

Declaration

protected override void OnInitialized(EventArgs e)

Parameters

System.EventArgs e

The System.Windows.RoutedEventArgs that contains the event data.

OnMouseDoubleClick(MouseButtonEventArgs)

Handles the System.Windows.Controls.Control.MouseDoubleClick routed event.

Declaration

protected override void OnMouseDoubleClick(MouseButtonEventArgs e)

Parameters

System.Windows.Input.MouseButtonEventArgs e

The event data.

OnMouseWheel(MouseWheelEventArgs)

The MouseWheel event handler.

Declaration

protected override void OnMouseWheel(MouseWheelEventArgs e)

Parameters

System.Windows.Input.MouseWheelEventArgs e

Event arguments.

PrepareContainerForItemOverride(DependencyObject, Object)

Prepares the specified element to display the specified item.

Declaration

protected override void PrepareContainerForItemOverride(DependencyObject element, object item)

Parameters

System.Windows.DependencyObject element

Element used to display the specified item.

System.Object item

Specified item.

RefreshCommandBar()

Refresh default command bar regardless whether map provider has been changed or not.

Declaration

public void RefreshCommandBar()

SetView(LocationRect, Boolean)

Sets ZoomLevel and Center so the given LocationRect object is completely visible.

Declaration

public void SetView(LocationRect view, bool useFractionZoom = false)

Parameters

LocationRect view

The location rect that should be centered in the map viewport.

System.Boolean useFractionZoom

Sets a value indicating whether the zooming of the view should use the fractional part of calculated zoom level.

Sets ZoomLevel and Center so the given LocationRect object, including minimum padding around it is completely visible in viewport. After this operation, zoom property is expected to have non-integer value with fractional digits.

Declaration

public void SetView(LocationRect view, double minimumPadding)

Parameters

LocationRect view

The location rect that should be centered in the map viewport.

System.Double minimumPadding

Sets a value indicating the the minimum padding around the visible view, in pixels.

Events

CenterChanged

Event occurs when the Center property of the map control is changed.

Declaration

public event EventHandler CenterChanged

Event Type

System.EventHandler

CenterChanging

Event occurs when the Center property of the map control starts to change.

Declaration

public event EventHandler<PropertyChangingEventArgs> CenterChanging

Event Type

System.EventHandler<PropertyChangingEventArgs>

InitializeCompleted

Event occurs when initialization of the map control is completed.

Declaration

public event EventHandler InitializeCompleted

Event Type

System.EventHandler

MapMouseClick

Occurs when the user clicks on the map.

Declaration

public event MouseRoutedEventHandler MapMouseClick

Event Type

MouseRoutedEventHandler

MapMouseDoubleClick

Occurs when the user does double click on the map.

Declaration

public event MouseRoutedEventHandler MapMouseDoubleClick

Event Type

MouseRoutedEventHandler

PanningFinished

Event occurs when panning of the map finished (spring animation which started when map center has been changed is finished).

Declaration

public event RoutedEventHandler PanningFinished

Event Type

System.Windows.RoutedEventHandler

SelectionRectangleChanged

Event occurs when new geographical region is selected by mouse (the MouseDragBehavior is "Select" and MouseSelectionMode is "RaiseEvent").

Declaration

public event EventHandler<SelectionRectangleChangedEventArgs> SelectionRectangleChanged

Event Type

System.EventHandler<SelectionRectangleChangedEventArgs>

ZoomChanged

Event occurs when the Zoom property of the map control is changed.

Declaration

public event EventHandler ZoomChanged

Event Type

System.EventHandler

ZoomChanging

Event occurs when the ZoomLevel property of the map control starts to change.

Declaration

public event EventHandler<PropertyChangingEventArgs> ZoomChanging

Event Type

System.EventHandler<PropertyChangingEventArgs>

ZoomingFinished

Event occurs when zooming of the map finished (spring animation which started when map zoom level has been changed is finished).

Declaration

public event RoutedEventHandler ZoomingFinished

Event Type

System.Windows.RoutedEventHandler

Extension Methods

CollectionExtensions.ToEnumerable<T>(T)

EnumerableExtensions.ToEnumerable<T>(T)