Skip to main content

MapLayer Class

Definition

Assembly:Avalonia.Controls.Charts
Package:Avalonia.Controls.Charts

Base class for all map layers that can be added to a shape map.

public class MapLayer

Methods

NameDescription
GetLayerBoundsGets the geographic bounds (in 0-200, 0-100 viewport units) of the content in this layer. Used for auto-scaling the map to fit content.
GetPointDataGets the data item at the specified screen point.
OnPointerExitedHandles pointer exited events. Override this method to handle interactions (e.g. clearing hover effects).
OnPointerMovedHandles pointer moved events. Override this method to handle interactions (e.g. hover effects).
OnPointerPressedHandles pointer pressed events. Override this method to handle interactions (e.g. selection).
RenderRenders this layer to the drawing context.
Bind (8 overloads)Binds a Avalonia.AvaloniaProperty to an Avalonia.Data.BindingBase. Inherited from AvaloniaObject.
CheckAccessReturns a value indicating whether the current thread is the UI thread. Inherited from AvaloniaObject.
ClearValue (4 overloads)Clears a Avalonia.AvaloniaProperty's local value. Inherited from AvaloniaObject.
CoerceValueCoerces the specified Avalonia.AvaloniaProperty. Inherited from AvaloniaObject.
EqualsCompares two objects using reference equality. Inherited from AvaloniaObject.
GetBaseValueInherited from AvaloniaObject.
GetHashCodeGets the hash code for the object. Inherited from AvaloniaObject.
GetValue (3 overloads)Gets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
IsAnimatingChecks whether a Avalonia.AvaloniaProperty is animating. Inherited from AvaloniaObject.
IsSetChecks whether a Avalonia.AvaloniaProperty is set on this object. Inherited from AvaloniaObject.
SetCurrentValue (2 overloads)Sets the value of a dependency property without changing its value source. Inherited from AvaloniaObject.
SetValue (3 overloads)Sets a Avalonia.AvaloniaProperty value. Inherited from AvaloniaObject.
VerifyAccessChecks that the current thread is the UI thread and throws if not. Inherited from AvaloniaObject.

GetLayerBounds Method

Gets the geographic bounds (in 0-200, 0-100 viewport units) of the content in this layer. Used for auto-scaling the map to fit content.

public Nullable<Avalonia.Rect> GetLayerBounds()

Returns

Nullable<Avalonia.Rect>

GetPointData Method

Gets the data item at the specified screen point.

public object GetPointData(Avalonia.Point point, Avalonia.Rect chartArea)

Parameters

point Avalonia.Point

The screen point to test.

chartArea Avalonia.Rect

The chart area rectangle.

Returns

object

The data item if hit; otherwise, null.

OnPointerExited Method

Handles pointer exited events. Override this method to handle interactions (e.g. clearing hover effects).

public void OnPointerExited()

OnPointerMoved Method

Handles pointer moved events. Override this method to handle interactions (e.g. hover effects).

public bool OnPointerMoved(Avalonia.Point point, Avalonia.Rect chartArea)

Parameters

point Avalonia.Point

chartArea Avalonia.Rect

Returns

bool

True if handled.

OnPointerPressed Method

Handles pointer pressed events. Override this method to handle interactions (e.g. selection).

public bool OnPointerPressed(Avalonia.Point point, Avalonia.Rect chartArea)

Parameters

point Avalonia.Point

chartArea Avalonia.Rect

Returns

bool

True if handled.

Render Method

Renders this layer to the drawing context.

public void Render(Avalonia.Media.DrawingContext context, Avalonia.Rect chartArea, double animationProgress)

Parameters

context Avalonia.Media.DrawingContext

The drawing context.

chartArea Avalonia.Rect

The chart area rectangle.

animationProgress double

Animation progress from 0 to 1.

Properties

NameDescription
IsVisibleGets or sets whether this layer is visible.
OpacityGets or sets the opacity of this layer.
TooltipTemplateGets or sets the data template used for tooltips.
DispatcherReturns the Avalonia.AvaloniaObject.Dispatcher that this Avalonia.AvaloniaObject is associated with. Inherited from AvaloniaObject.
ItemInherited from AvaloniaObject.

IsVisible Property

Gets or sets whether this layer is visible.

public bool IsVisible { get; set; }

Opacity Property

Gets or sets the opacity of this layer.

public double Opacity { get; set; }

TooltipTemplate Property

Gets or sets the data template used for tooltips.

public Avalonia.Controls.Templates.IDataTemplate TooltipTemplate { get; set; }

Fields

IsVisibleProperty Field

Identifies the Avalonia.Controls.Charts.MapLayer.IsVisible Avalonia property.

public Avalonia.StyledProperty<bool> IsVisibleProperty

OpacityProperty Field

Identifies the Avalonia.Controls.Charts.MapLayer.Opacity Avalonia property.

public Avalonia.StyledProperty<double> OpacityProperty

TooltipTemplateProperty Field

Identifies the Avalonia.Controls.Charts.MapLayer.TooltipTemplate Avalonia property.

public Avalonia.StyledProperty<Avalonia.Controls.Templates.IDataTemplate> TooltipTemplateProperty

Events

NameDescription
InvalidatedEvent raised when the layer needs to be redrawn.
PropertyChangedRaised when a Avalonia.AvaloniaProperty value changes on this object. Inherited from AvaloniaObject.

Invalidated Event

Event raised when the layer needs to be redrawn.

public event EventHandler Invalidated