Class MapControl
Inheritance
Implements
Inherited Members
Namespace: Mapsui.UI.Avalonia
Assembly: Mapsui.UI.Avalonia.dll
Syntax
public class MapControl : UserControl, IDataContextProvider, ILogical, IThemeVariantHost, IResourceHost, IResourceNode, IStyleHost, ISetLogicalParent, ISetInheritanceParent, ISupportInitialize, IStyleable, IInputElement, IDataTemplateHost, INamed, ISetterValue, IMapControl, IDisposable, INotifyPropertyChanged
Constructors
| Edit this page View SourceMapControl()
Declaration
public MapControl()
Properties
| Edit this page View SourceContinuousMouseWheelZoomStepSize
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 |
Map
Map holding data for which is shown in this MapControl
Declaration
public Map Map { get; set; }
Property Value
Type | Description |
---|---|
Map |
Performance
Object to save performance information about the drawing of the map
Declaration
public Performance? Performance { get; set; }
Property Value
Type | Description |
---|---|
Performance |
Remarks
If this is null, no performance information is saved.
PixelDensity
The number of pixel per device independent unit
Declaration
public float PixelDensity { get; }
Property Value
Type | Description |
---|---|
float |
ReSnapRotationDegrees
With how many degrees from 0 should map snap to 0 degrees
Declaration
public double ReSnapRotationDegrees { get; set; }
Property Value
Type | Description |
---|---|
double |
Renderer
Renderer that is used from this MapControl
Declaration
public IRenderer Renderer { get; set; }
Property Value
Type | Description |
---|---|
IRenderer |
ShiftPressed
Declaration
public bool ShiftPressed { get; set; }
Property Value
Type | Description |
---|---|
bool |
UnSnapRotationDegrees
After how many degrees start rotation to take place
Declaration
public double UnSnapRotationDegrees { get; set; }
Property Value
Type | Description |
---|---|
double |
UpdateInterval
Interval between two redraws of the MapControl in ms
Declaration
public int UpdateInterval { 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 |
Methods
| Edit this page View SourceCallHomeIfNeeded()
Declaration
public void CallHomeIfNeeded()
ClearTouchState()
Clears the Touch State
Declaration
public void ClearTouchState()
Dispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Declaration
public virtual 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(MPoint?, int)
Check, if a feature at a given screen position is hit
Declaration
public MapInfo? GetMapInfo(MPoint? screenPosition, int margin = 0)
Parameters
Type | Name | Description |
---|---|---|
MPoint | screenPosition | Screen position to check for widgets and features |
int | margin | An optional extra margin around the feature to enlarge the hit area. |
Returns
Type | Description |
---|---|
MapInfo |
GetSnapshot(IEnumerable<ILayer>?)
Create a snapshot form map as PNG image
Declaration
public byte[] GetSnapshot(IEnumerable<ILayer>? layers = null)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<ILayer> | layers | Layers that should be included in snapshot |
Returns
Type | Description |
---|---|
byte[] | Byte array with snapshot in png format. If there are any problems than returns null. |
OnPointerMoved(PointerEventArgs)
Called before the Avalonia.Input.InputElement.PointerMoved event occurs.
Declaration
protected override void OnPointerMoved(PointerEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
PointerEventArgs | e | The event args. |
Overrides
OnPropertyChanged(AvaloniaPropertyChangedEventArgs)
Called when a avalonia property changes on the object.
Declaration
protected override void OnPropertyChanged(AvaloniaPropertyChangedEventArgs change)
Parameters
Type | Name | Description |
---|---|---|
AvaloniaPropertyChangedEventArgs | change | The property change details. |
Overrides
OnPropertyChanged(string)
Declaration
protected void OnPropertyChanged(string propertyName = "")
Parameters
Type | Name | Description |
---|---|---|
string | propertyName |
OpenBrowser(string)
Declaration
public void OpenBrowser(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()
Render(DrawingContext)
Renders the visual to a Avalonia.Media.DrawingContext.
Declaration
public override void Render(DrawingContext context)
Parameters
Type | Name | Description |
---|---|---|
DrawingContext | context | The drawing context. |
Overrides
ResetWidgetCache()
Reset the widget cache. It may be necessary to call this explicitly after the widgets have changed.
Declaration
protected void ResetWidgetCache()
StartUpdates(bool)
Start updates for control
Declaration
public void StartUpdates(bool refresh = true)
Parameters
Type | Name | Description |
---|---|---|
bool | refresh |
Remarks
When this function is called, the control is redrawn if needed
StopUpdates()
Stop updates for control
Declaration
public void StopUpdates()
Remarks
When this function is called, the control stops to redraw itself, even if it is needed
ToDeviceIndependentUnits(MPoint)
Converts coordinates in pixels to device independent units (or DIP or DP).
Declaration
public MPoint ToDeviceIndependentUnits(MPoint coordinateInPixels)
Parameters
Type | Name | Description |
---|---|---|
MPoint | coordinateInPixels | Coordinate in pixels |
Returns
Type | Description |
---|---|
MPoint | Coordinate in device independent units (or DIP or DP) |
ToPixels(MPoint)
Converts coordinates in device independent units (or DIP or DP) to pixels.
Declaration
public MPoint ToPixels(MPoint coordinateInDeviceIndependentUnits)
Parameters
Type | Name | Description |
---|---|---|
MPoint | coordinateInDeviceIndependentUnits | Coordinate in device independent units (or DIP or DP) |
Returns
Type | Description |
---|---|
MPoint | Coordinate in pixels |
Unsubscribe()
Unsubscribe from map events
Declaration
public void Unsubscribe()
Events
| Edit this page View SourceFeatureInfo
Declaration
public event EventHandler<FeatureInfoEventArgs>? FeatureInfo
Event Type
Type | Description |
---|---|
EventHandler<FeatureInfoEventArgs> |
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> |
PropertyChanged
Called whenever a property is changed
Declaration
public event PropertyChangedEventHandler? PropertyChanged
Event Type
Type | Description |
---|---|
PropertyChangedEventHandler |