Class MapControl

Inheritance

object

ComponentBase

MapControl

Implements

IComponent

IHandleEvent

IHandleAfterRender

IMapControl

INotifyPropertyChanged

IDisposable

Inherited Members

ComponentBase.BuildRenderTree(RenderTreeBuilder)

ComponentBase.OnInitializedAsync()

ComponentBase.OnParametersSet()

ComponentBase.OnParametersSetAsync()

ComponentBase.StateHasChanged()

ComponentBase.ShouldRender()

ComponentBase.OnAfterRender(bool)

ComponentBase.InvokeAsync(Action)

ComponentBase.InvokeAsync(Func<Task>)

ComponentBase.DispatchExceptionAsync(Exception)

ComponentBase.SetParametersAsync(ParameterView)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Mapsui.UI.Blazor

Assembly: Mapsui.UI.Blazor.dll

Syntax

public class MapControl : ComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IMapControl, INotifyPropertyChanged, IDisposable

Constructors

MapControl()

Declaration

public MapControl()

Fields

_elementId

Declaration

protected readonly string _elementId

Field Value

Type	Description
string

_viewCpu

Declaration

protected SKCanvasView? _viewCpu

Field Value

Type	Description
SKCanvasView

_viewGpu

Declaration

protected SKGLView? _viewGpu

Field Value

Type	Description
SKGLView

Properties

ContinuousMouseWheelZoomStepSize

The size of the mouse wheel steps used when UseContinuousMouseWheelZoom = true. The default is 0.1. A step size of 1 would doubling or halving the scale of the map on each event.

Declaration

public double ContinuousMouseWheelZoomStepSize { get; set; }

Property Value

Type	Description
double

Cursor

Declaration

public string? Cursor { get; set; }

Property Value

Type	Description
string

ElementId

Declaration

public string ElementId { get; }

Property Value

Type	Description
string

Map

Map holding data for which is shown in this MapControl

Declaration

[Parameter]
public Map Map { get; set; }

Property Value

Type	Description
Map

MaxTapGestureMovement

The movement allowed between a touch down and touch up in a touch gestures in device independent pixels.

Declaration

public int MaxTapGestureMovement { get; set; }

Property Value

Type	Description
int

MoveButton

Declaration

public int MoveButton { get; set; }

Property Value

Type	Description
int

MoveCursor

Declaration

public string MoveCursor { get; set; }

Property Value

Type	Description
string

MoveModifier

Declaration

public int MoveModifier { get; set; }

Property Value

Type	Description
int

UseContinuousMouseWheelZoom

This enables an alternative mouse wheel method where the step size on each mouse wheel event can be configured by setting the ContinuousMouseWheelZoomStepSize.

Declaration

public bool UseContinuousMouseWheelZoom { get; set; }

Property Value

Type	Description
bool

UseFling

Use fling gesture to move the map. Default is true. Fling means that the map will continue to move for a short time after the user has lifted the finger.

Declaration

public bool UseFling { get; set; }

Property Value

Type	Description
bool

UseGPU

Declaration

public static bool UseGPU { get; set; }

Property Value

Type	Description
bool

ZoomButton

Declaration

public int ZoomButton { get; set; }

Property Value

Type	Description
int

ZoomModifier

Declaration

public int ZoomModifier { get; set; }

Property Value

Type	Description
int

Methods

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

public void Dispose()

Dispose(bool)

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

ForceUpdate()

Force a update of control

Declaration

public void ForceUpdate()

Remarks

When this function is called, the control draws itself once

GetMapInfo(ScreenPosition, IEnumerable<ILayer>)

Check, if a feature at a given screen position is hit.

Declaration

public MapInfo GetMapInfo(ScreenPosition screenPosition, IEnumerable<ILayer> layers)

Parameters

Type	Name	Description
ScreenPosition	screenPosition	Screen position to check for widgets and features.
IEnumerable<ILayer>	layers	The layers to query.

Returns

Type	Description
MapInfo

GetPixelDensity()

Returns the number of pixels per device independent unit

Declaration

public float? GetPixelDensity()

Returns

Type	Description
float?

GetRemoteMapInfoAsync(ScreenPosition, Viewport, IEnumerable<ILayer>)

Declaration

protected Task<MapInfo> GetRemoteMapInfoAsync(ScreenPosition screenPosition, Viewport viewport, IEnumerable<ILayer> layers)

Parameters

Type	Name	Description
ScreenPosition	screenPosition
Viewport	viewport
IEnumerable<ILayer>	layers

Returns

Type	Description
Task<MapInfo>

GetSnapshot(IEnumerable<ILayer>?, RenderFormat, int)

Create a snapshot form map as PNG image

Declaration

public byte[] GetSnapshot(IEnumerable<ILayer>? layers = null, RenderFormat renderFormat = RenderFormat.Png, int quality = 100)

Parameters

Type	Name	Description
IEnumerable<ILayer>	layers	Layers that should be included in snapshot
RenderFormat	renderFormat	render format
int	quality	default quality is 90 is applicable for webp and jpg

Returns

Type	Description
byte[]	Byte array with snapshot in png format. If there are any problems than returns null.

InvalidateCanvas()

Declaration

public void InvalidateCanvas()

OnAfterRenderAsync(bool)

Method invoked after each time the component has been rendered interactively and the UI has finished updating (for example, after elements have been added to the browser DOM). Any ElementReference fields will be populated by the time this runs.

This method is not invoked during prerendering or server-side rendering, because those processes are not attached to any live browser DOM and are already complete before the DOM is updated.

Note that the component does not automatically re-render after the completion of any returned Task, because that would cause an infinite render loop.

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
bool	firstRender	Set to true if this is the first time OnAfterRender(bool) has been invoked on this component instance; otherwise false.

Returns

Type	Description
Task	A Task representing any asynchronous operation.

Overrides

ComponentBase.OnAfterRenderAsync(bool)

Remarks

The OnAfterRender(bool) and OnAfterRenderAsync(bool) lifecycle methods are useful for performing interop, or interacting with values received from @ref. Use the firstRender parameter to ensure that initialization work is only performed once.

OnInitialized()

Method invoked when the component is ready to start, having received its initial parameters from its parent in the render tree.

Declaration

protected override void OnInitialized()

Overrides

ComponentBase.OnInitialized()

OnMapInfo(MapInfoEventArgs)

Declaration

protected void OnMapInfo(MapInfoEventArgs mapInfoEventArgs)

Parameters

Type	Name	Description
MapInfoEventArgs	mapInfoEventArgs

OnMapPointerMoved(ScreenPosition, MPoint, GestureType)

Declaration

protected virtual bool OnMapPointerMoved(ScreenPosition screenPosition, MPoint worldPosition, GestureType gestureType)

Parameters

Type	Name	Description
ScreenPosition	screenPosition
MPoint	worldPosition
GestureType	gestureType

Returns

Type	Description
bool

OnMapPointerPressed(ScreenPosition, MPoint)

Declaration

protected virtual bool OnMapPointerPressed(ScreenPosition screenPosition, MPoint worldPosition)

Parameters

Type	Name	Description
ScreenPosition	screenPosition
MPoint	worldPosition

Returns

Type	Description
bool

OnMapPointerReleased(ScreenPosition, MPoint)

Declaration

protected virtual bool OnMapPointerReleased(ScreenPosition screenPosition, MPoint worldPosition)

Parameters

Type	Name	Description
ScreenPosition	screenPosition
MPoint	worldPosition

Returns

Type	Description
bool

OnMapTapped(ScreenPosition, MPoint, GestureType)

Declaration

protected virtual bool OnMapTapped(ScreenPosition screenPosition, MPoint worldPosition, GestureType gestureType)

Parameters

Type	Name	Description
ScreenPosition	screenPosition
MPoint	worldPosition
GestureType	gestureType

Returns

Type	Description
bool

OnMouseDown(MouseEventArgs)

Declaration

protected void OnMouseDown(MouseEventArgs e)

Parameters

Type	Name	Description
MouseEventArgs	e

OnMouseMove(MouseEventArgs)

Declaration

protected void OnMouseMove(MouseEventArgs e)

Parameters

Type	Name	Description
MouseEventArgs	e

OnMouseUp(MouseEventArgs)

Declaration

protected void OnMouseUp(MouseEventArgs e)

Parameters

Type	Name	Description
MouseEventArgs	e

OnMouseWheel(WheelEventArgs)

Declaration

protected void OnMouseWheel(WheelEventArgs e)

Parameters

Type	Name	Description
WheelEventArgs	e

OnPaintSurface(SKCanvas, SKImageInfo)

Declaration

protected void OnPaintSurface(SKCanvas canvas, SKImageInfo info)

Parameters

Type	Name	Description
SKCanvas	canvas
SKImageInfo	info

OnPaintSurfaceCPU(SKPaintSurfaceEventArgs)

Declaration

protected void OnPaintSurfaceCPU(SKPaintSurfaceEventArgs e)

Parameters

Type	Name	Description
SKPaintSurfaceEventArgs	e

OnPaintSurfaceGPU(SKPaintGLSurfaceEventArgs)

Declaration

protected void OnPaintSurfaceGPU(SKPaintGLSurfaceEventArgs e)

Parameters

Type	Name	Description
SKPaintGLSurfaceEventArgs	e

OnPropertyChanged(string)

Declaration

protected void OnPropertyChanged(string propertyName = "")

Parameters

Type	Name	Description
string	propertyName

OnTouchEnd(TouchEventArgs)

Declaration

public void OnTouchEnd(TouchEventArgs e)

Parameters

Type	Name	Description
TouchEventArgs	e

OnTouchMove(TouchEventArgs)

Declaration

public void OnTouchMove(TouchEventArgs e)

Parameters

Type	Name	Description
TouchEventArgs	e

OnTouchStart(TouchEventArgs)

Declaration

public void OnTouchStart(TouchEventArgs e)

Parameters

Type	Name	Description
TouchEventArgs	e

OpenInBrowser(string)

Declaration

public void OpenInBrowser(string url)

Parameters

Type	Name	Description
string	url

Refresh(ChangeType)

Declaration

public void Refresh(ChangeType changeType = ChangeType.Discrete)

Parameters

Type	Name	Description
ChangeType	changeType

RefreshData(ChangeType)

Refresh data of Map, but don't paint it

Declaration

public void RefreshData(ChangeType changeType = ChangeType.Discrete)

Parameters

Type	Name	Description
ChangeType	changeType

RefreshGraphics()

Declaration

public void RefreshGraphics()

SetMapRenderer(IMapRenderer)

Declaration

public void SetMapRenderer(IMapRenderer mapRenderer)

Parameters

Type	Name	Description
IMapRenderer	mapRenderer

Unsubscribe()

Unsubscribe from map events

Declaration

public void Unsubscribe()

Events

Info

Called whenever the map is clicked. The MapInfoEventArgs contain the features that were hit in the layers that have IsMapInfoLayer set to true.

Declaration

public event EventHandler<MapInfoEventArgs>? Info

Event Type

Type	Description
EventHandler<MapInfoEventArgs>

Remarks

The Map.Tapped event is preferred over the Info event. This event is kept for backwards compatibility.

MapPointerMoved

Event that is triggered when on pointer move. Can be a drag or hover.

Declaration

public event EventHandler<MapEventArgs>? MapPointerMoved

Event Type

Type	Description
EventHandler<MapEventArgs>

MapPointerPressed

Event that is triggered when on pointer down.

Declaration

public event EventHandler<MapEventArgs>? MapPointerPressed

Event Type

Type	Description
EventHandler<MapEventArgs>

MapPointerReleased

Event that is triggered when on pointer up.

Declaration

public event EventHandler<MapEventArgs>? MapPointerReleased

Event Type

Type	Description
EventHandler<MapEventArgs>

MapTapped

Event that is triggered when the map is tapped. Can be a single tap, double tap or long press.

Declaration

public event EventHandler<MapEventArgs>? MapTapped

Event Type

Type	Description
EventHandler<MapEventArgs>

PropertyChanged

Called whenever a property is changed

Declaration

public event PropertyChangedEventHandler? PropertyChanged

Event Type

Type	Description
PropertyChangedEventHandler

Implements

IComponent

IHandleEvent

IHandleAfterRender

IMapControl

INotifyPropertyChanged

IDisposable

Extension Methods

DisposableExtension.DisposeIfDisposable(object?)