Back to all docs
API Reference / Telerik.WinControls.UI / MapLayer
New to Telerik UI for WinForms? Start a free 30-day trial

MapLayer

Class

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.RadMap.dll

Syntax:
C#
public class MapLayer : IEnumerable

Inheritance: objectMapLayer

Implements: IEnumerable

Constructors

MapLayer()

Initializes a new instance of the MapLayer class.

C#
public MapLayer()

MapLayer(string)

Initializes a new instance of the MapLayer class.

C#
public MapLayer(string name)
Parameters:namestring

The name.

Properties

ClusterDistance

Gets or sets the cluster distance.

C#
public long ClusterDistance { get; set; }
Property Value:

The cluster distance.

ClusterStrategy

Gets or sets the cluster strategy.

C#
public IMapClusterStrategy ClusterStrategy { get; set; }
Property Value:

The cluster strategy.

ColorizationStrategy

Gets or sets the colorization strategy.

C#
public IColorizationStrategy ColorizationStrategy { get; set; }
Property Value:

The colorization strategy.

Count

C#
public int Count { get; }

IsReadOnly

C#
public bool IsReadOnly { get; }

IsUpdateSuspended

Gets a value indicating whether updates are suspended.

C#
public bool IsUpdateSuspended { get; }
Property Value:

true if updates are suspended; otherwise, false.

IsVisible

C#
public bool IsVisible { get; set; }

Name

Gets or sets the name.

C#
public string Name { get; set; }
Property Value:

The name.

Overlays

Gets the overlays contained within this layer.

C#
public ReadOnlyCollection<MapVisualElement> Overlays { get; }
Property Value:

The overlays.

Viewport

Gets the viewport.

C#
public IMapViewport Viewport { get; }
Property Value:

The viewport.

VisibleOverlays

Gets the currently visible overlays in this layer. When cluster strategy is applied the visible overlays may differ from the user added ones.

C#
public ReadOnlyCollection<MapVisualElement> VisibleOverlays { get; }

Methods

Add(MapVisualElement)

C#
public void Add(MapVisualElement item)
Parameters:itemMapVisualElement

AddRange(IEnumerable<MapVisualElement>)

Adds the specified overlays to the layer.

C#
public void AddRange(IEnumerable<MapVisualElement> items)
Parameters:itemsIEnumerable<MapVisualElement>

The items.

AddRange(params MapVisualElement[])

Adds the specified overlays to the layer.

C#
public void AddRange(params MapVisualElement[] items)
Parameters:itemsMapVisualElement[]

The items.

BeginUpdate()

Suspends updates.

C#
public void BeginUpdate()

Clear()

C#
public void Clear()

Contains(MapVisualElement)

C#
public bool Contains(MapVisualElement item)
Parameters:itemMapVisualElementReturns:

bool

CopyTo(MapVisualElement[], int)

C#
public void CopyTo(MapVisualElement[] array, int arrayIndex)
Parameters:arrayMapVisualElement[]arrayIndexint

EndUpdate()

Resumes updates and performs an update.

C#
public void EndUpdate()

EndUpdate(bool)

Resumes updates and performs an update based on the provided parameter

C#
public void EndUpdate(bool update)
Parameters:updatebool

if set to true an update is performed.

GetEnumerator()

C#
public IEnumerator<MapVisualElement> GetEnumerator()
Returns:

IEnumerator<MapVisualElement>

HitTest(PointG, PointL)

Hit tests the overlays in the layer.

C#
protected virtual MapVisualElement HitTest(PointG pointG, PointL pointL)
Parameters:pointGPointG

The point g.

pointLPointL

The point l.

Returns:

MapVisualElement

MapVisualElement.

HitTest(PointG)

Hit tests the overlays in the layer.

C#
public MapVisualElement HitTest(PointG point)
Parameters:pointPointG

The point.

Returns:

MapVisualElement

MapVisualElement.

HitTest(PointL)

Hit tests the overlays in the layer.

C#
public MapVisualElement HitTest(PointL point)
Parameters:pointPointL

The point.

Returns:

MapVisualElement

MapVisualElement.

Invalidate()

C#
protected virtual void Invalidate()

OverlayLocationChanged(MapVisualElement)

Called when the location property of an overlay changes.

C#
public virtual void OverlayLocationChanged(MapVisualElement overlay)
Parameters:overlayMapVisualElement

Paint(IGraphics, IMapViewport)

Paints the layer to the specified graphics.

C#
public virtual void Paint(IGraphics graphics, IMapViewport viewport)
Parameters:graphicsIGraphics

The graphics.

viewportIMapViewport

The viewport.

Remove(MapVisualElement)

C#
public bool Remove(MapVisualElement item)
Parameters:itemMapVisualElementReturns:

bool

UpdateOverlaysColorizerColor()

Updates the colorizer color of all overlays.

C#
public virtual void UpdateOverlaysColorizerColor()

ViewportUpdated(IMapViewport, ViewportChangeAction)

Called when the viewport is updated.

C#
public virtual void ViewportUpdated(IMapViewport viewport, ViewportChangeAction action)
Parameters:viewportIMapViewport

The viewport.

actionViewportChangeAction

The action.

In this article
DefinitionConstructorsMapLayer()MapLayer(string)PropertiesClusterDistanceClusterStrategyColorizationStrategyCountIsReadOnlyIsUpdateSuspendedIsVisibleNameOverlaysViewportVisibleOverlaysMethodsAdd(MapVisualElement)AddRange(IEnumerable<MapVisualElement>)AddRange(params MapVisualElement[])BeginUpdate()Clear()Contains(MapVisualElement)CopyTo(MapVisualElement[], int)EndUpdate()EndUpdate(bool)GetEnumerator()HitTest(PointG, PointL)HitTest(PointG)HitTest(PointL)Invalidate()OverlayLocationChanged(MapVisualElement)Paint(IGraphics, IMapViewport)Remove(MapVisualElement)UpdateOverlaysColorizerColor()ViewportUpdated(IMapViewport, ViewportChangeAction)
Not finding the help you need?
Contact Support