Skip to content

Overlay

Namespace: ThinkGeo.UI.Maui

public abstract class Overlay : Microsoft.Maui.Controls.AbsoluteLayout, System.ComponentModel.INotifyPropertyChanged, Microsoft.Maui.Controls.Internals.IDynamicResourceHandler, Microsoft.Maui.Controls.IElementDefinition, Microsoft.Maui.Controls.Internals.INameScope, Microsoft.Maui.Controls.IElementController, Microsoft.Maui.IVisualTreeElement, Microsoft.Maui.IElement, Microsoft.Maui.Controls.IEffectControlProvider, Microsoft.Maui.IToolTipElement, Microsoft.Maui.IContextFlyoutElement, Microsoft.Maui.Controls.IControlsElement, Microsoft.Maui.Controls.StyleSheets.IStyleSelectable, Microsoft.Maui.Controls.Internals.INavigationProxy, Microsoft.Maui.Controls.IAnimatable, Microsoft.Maui.Controls.IVisualElementController, Microsoft.Maui.Controls.IResourcesProvider, Microsoft.Maui.Controls.IStyleElement, Microsoft.Maui.Controls.IFlowDirectionController, Microsoft.Maui.Controls.IPropertyPropagationController, Microsoft.Maui.Controls.IVisualController, Microsoft.Maui.Controls.IWindowController, Microsoft.Maui.IView, Microsoft.Maui.ITransform, Microsoft.Maui.Controls.IControlsVisualElement, Microsoft.Maui.Controls.StyleSheets.IStylable, Microsoft.Maui.Controls.IViewController, Microsoft.Maui.Controls.Internals.IGestureController, Microsoft.Maui.Controls.IGestureRecognizers, Microsoft.Maui.IPropertyMapperView, Microsoft.Maui.HotReload.IHotReloadableView, Microsoft.Maui.IReplaceableView, Microsoft.Maui.Controls.IControlsView, Microsoft.Maui.ILayout, Microsoft.Maui.IContainer, System.Collections.Generic.IList`1[[Microsoft.Maui.IView, Microsoft.Maui, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Collections.Generic.ICollection`1[[Microsoft.Maui.IView, Microsoft.Maui, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Collections.Generic.IEnumerable`1[[Microsoft.Maui.IView, Microsoft.Maui, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null]], System.Collections.IEnumerable, Microsoft.Maui.ISafeAreaView, Microsoft.Maui.IPadding, Microsoft.Maui.ICrossPlatformLayout, Microsoft.Maui.Controls.IBindableLayout, Microsoft.Maui.Controls.IPaddingElement, Microsoft.Maui.Controls.IInputTransparentContainerElement, Microsoft.Maui.IAbsoluteLayout, System.IDisposable

Inheritance Object → BindableObject → Element → NavigableElement → VisualElement → View → Layout → AbsoluteLayout → Overlay
Implements INotifyPropertyChanged, IDynamicResourceHandler, IElementDefinition, INameScope, IElementController, IVisualTreeElement, IElement, IEffectControlProvider, IToolTipElement, IContextFlyoutElement, IControlsElement, IStyleSelectable, INavigationProxy, IAnimatable, IVisualElementController, IResourcesProvider, IStyleElement, IFlowDirectionController, IPropertyPropagationController, IVisualController, IWindowController, IView, ITransform, IControlsVisualElement, IStylable, IViewController, IGestureController, IGestureRecognizers, IPropertyMapperView, IHotReloadableView, IReplaceableView, IControlsView, ILayout, IContainer, IList<IView>, ICollection<IView>, IEnumerable<IView>, IEnumerable, ISafeAreaView, IPadding, ICrossPlatformLayout, IBindableLayout, IPaddingElement, IInputTransparentContainerElement, IAbsoluteLayout, IDisposable

Properties

Name

Gets or sets the name of this overlay.

public string Name { get; set; }

Property Value

String

DrawingExceptionMode

This property gets and sets the DrawingExceptionMode used when an exception occurs during drawing.

public DrawingExceptionMode DrawingExceptionMode { get; set; }

Property Value

DrawingExceptionMode
The drawing exception mode.

IsEmpty

This property gets if this overlay is empty or not.

public bool IsEmpty { get; }

Property Value

Boolean

Remarks:

This property enhances the performance of the overlay while drawing. If is true, we will skip drawing this overlay and continue drawing the next overlay.

Children

public IList<IView> Children { get; }

Property Value

IList<IView>

Count

public int Count { get; }

Property Value

Int32

IsReadOnly

public bool IsReadOnly { get; }

Property Value

Boolean

Item

public IView Item { get; set; }

Property Value

IView

IsClippedToBounds

public bool IsClippedToBounds { get; set; }

Property Value

Boolean

Padding

public Thickness Padding { get; set; }

Property Value

Thickness

IgnoreSafeArea

public bool IgnoreSafeArea { get; set; }

Property Value

Boolean

CascadeInputTransparent

public bool CascadeInputTransparent { get; set; }

Property Value

Boolean

GestureRecognizers

public IList<IGestureRecognizer> GestureRecognizers { get; }

Property Value

IList<IGestureRecognizer>

HorizontalOptions

public LayoutOptions HorizontalOptions { get; set; }

Property Value

LayoutOptions

Margin

public Thickness Margin { get; set; }

Property Value

Thickness

VerticalOptions

public LayoutOptions VerticalOptions { get; set; }

Property Value

LayoutOptions

Visual

public IVisual Visual { get; set; }

Property Value

IVisual

FlowDirection

public FlowDirection FlowDirection { get; set; }

Property Value

FlowDirection

Window

public Window Window { get; }

Property Value

Window

AnchorX

public double AnchorX { get; set; }

Property Value

Double

AnchorY

public double AnchorY { get; set; }

Property Value

Double

BackgroundColor

public Color BackgroundColor { get; set; }

Property Value

Color

Background

public Brush Background { get; set; }

Property Value

Brush

Behaviors

public IList<Behavior> Behaviors { get; }

Property Value

IList<Behavior>

Bounds

public Rect Bounds { get; }

Property Value

Rect

Height

public double Height { get; }

Property Value

Double

HeightRequest

public double HeightRequest { get; set; }

Property Value

Double

InputTransparent

public bool InputTransparent { get; set; }

Property Value

Boolean

IsEnabled

public bool IsEnabled { get; set; }

Property Value

Boolean

IsFocused

public bool IsFocused { get; }

Property Value

Boolean

IsVisible

public bool IsVisible { get; set; }

Property Value

Boolean

MinimumHeightRequest

public double MinimumHeightRequest { get; set; }

Property Value

Double

MinimumWidthRequest

public double MinimumWidthRequest { get; set; }

Property Value

Double

MaximumHeightRequest

public double MaximumHeightRequest { get; set; }

Property Value

Double

MaximumWidthRequest

public double MaximumWidthRequest { get; set; }

Property Value

Double

Opacity

public double Opacity { get; set; }

Property Value

Double

Rotation

public double Rotation { get; set; }

Property Value

Double

RotationX

public double RotationX { get; set; }

Property Value

Double

RotationY

public double RotationY { get; set; }

Property Value

Double

Scale

public double Scale { get; set; }

Property Value

Double

ScaleX

public double ScaleX { get; set; }

Property Value

Double

ScaleY

public double ScaleY { get; set; }

Property Value

Double

TranslationX

public double TranslationX { get; set; }

Property Value

Double

TranslationY

public double TranslationY { get; set; }

Property Value

Double

Triggers

public IList<TriggerBase> Triggers { get; }

Property Value

IList<TriggerBase>

Width

public double Width { get; }

Property Value

Double

WidthRequest

public double WidthRequest { get; set; }

Property Value

Double

X

public double X { get; }

Property Value

Double

Y

public double Y { get; }

Property Value

Double

Clip

public Geometry Clip { get; set; }

Property Value

Geometry

Batched

public bool Batched { get; }

Property Value

Boolean

DisableLayout

public bool DisableLayout { get; set; }

Property Value

Boolean

IsInPlatformLayout

public bool IsInPlatformLayout { get; set; }

Property Value

Boolean

IsPlatformStateConsistent

public bool IsPlatformStateConsistent { get; set; }

Property Value

Boolean

IsPlatformEnabled

public bool IsPlatformEnabled { get; set; }

Property Value

Boolean

Resources

public ResourceDictionary Resources { get; set; }

Property Value

ResourceDictionary

Frame

public Rect Frame { get; set; }

Property Value

Rect

Handler

public IViewHandler Handler { get; set; }

Property Value

IViewHandler

Shadow

public Shadow Shadow { get; set; }

Property Value

Shadow

ZIndex

public int ZIndex { get; set; }

Property Value

Int32

DesiredSize

public Size DesiredSize { get; protected set; }

Property Value

Size

IsLoaded

public bool IsLoaded { get; }

Property Value

Boolean

public INavigation Navigation { get; internal set; }

Property Value

INavigation

Style

public Style Style { get; set; }

Property Value

Style

StyleClass

public IList<string> StyleClass { get; set; }

Property Value

IList<String>

class

public IList<string> class { get; set; }

Property Value

IList<String>

public NavigationProxy NavigationProxy { get; }

Property Value

NavigationProxy

AutomationId

public string AutomationId { get; set; }

Property Value

String

ClassId

public string ClassId { get; set; }

Property Value

String

Effects

public IList<Effect> Effects { get; }

Property Value

IList<Effect>

Id

public Guid Id { get; }

Property Value

Guid

StyleId

public string StyleId { get; set; }

Property Value

String

LogicalChildren

public ReadOnlyCollection<Element> LogicalChildren { get; }

Property Value

ReadOnlyCollection<Element>

RealParent

public Element RealParent { get; }

Property Value

Element

Parent

public Element Parent { get; set; }

Property Value

Element

EffectControlProvider

public IEffectControlProvider EffectControlProvider { get; set; }

Property Value

IEffectControlProvider

Handler

public IElementHandler Handler { get; set; }

Property Value

IElementHandler

Dispatcher

public IDispatcher Dispatcher { get; }

Property Value

IDispatcher

BindingContext

public object BindingContext { get; set; }

Property Value

Object

Methods

RefreshAsync(CancellationToken)

This method refreshes all the content in the Canvas. For example, LayerOverlay with multiple tiles; when the style of one layer is changed, call Refresh to refresh all the tiles to accept new styles.

public Task RefreshAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task

Remarks:

The difference from Draw() method is that Refresh() method refreshes all the elements while Draw() does not.

RefreshAsyncCore(CancellationToken)

This method refreshes all the content in the Canvas. For example, LayerOverlay with multiple tiles; when the style of one layer is changed, call Refresh to refresh all the tiles to accept new styles.

protected Task RefreshAsyncCore(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task

Remarks:

The difference from Draw() method is that Refresh() method refreshes all the elements while Draw() does not.

OpenAsync(IMapView, CancellationToken)

public Task OpenAsync(IMapView mapView, CancellationToken cancellationToken)

Parameters

mapView IMapView

cancellationToken CancellationToken

Returns

Task

OpenAsyncCore(IMapView, CancellationToken)

protected Task OpenAsyncCore(IMapView mapView, CancellationToken cancellationToken)

Parameters

mapView IMapView

cancellationToken CancellationToken

Returns

Task

CloseAsync(CancellationToken)

public Task CloseAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task

CloseAsyncCore(CancellationToken)

protected Task CloseAsyncCore(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task

DrawAsync(OverlayRefreshType, CancellationToken)

This method draws the overlay with the provided extent in world coordinate.

public Task DrawAsync(OverlayRefreshType refreshType, CancellationToken cancellationToken)

Parameters

refreshType OverlayRefreshType

        This parameter indicates whether the elements of this overlay needs to be refreshed.
        For example, TileOverlay is formed by tiles.
        When panning the map around, the existing tile doesn't need to be redrawn,
        the only thing we need to do is modifying the position of these tiles.
        On another hand, when click to change the style of the overlay,
        we need to redraw the tile images to change the appearance. So we need refresh mode.

cancellationToken CancellationToken
The token to monitor the cancellation requests.

Returns

Task

DrawAsyncCore(OverlayRefreshType, CancellationToken)

This method draws the overlay with the provided extent in world coordinate.

protected abstract Task DrawAsyncCore(OverlayRefreshType refreshType, CancellationToken cancellationToken)

Parameters

refreshType OverlayRefreshType

        This parameter indicates whether the elements of this overlay needs to be refreshed.
        For example, TileOverlay is formed by tiles.
        When panning the map around, the existing tile doesn't need to be redrawn,
        the only thing we need to do is modifying the position of these tiles.
        On another hand, when click to change the style of the overlay,
        we need to redraw the tile images to change the appearance. So we need refresh mode.

cancellationToken CancellationToken

        The cancellation token for this Async method.

Returns

Task

DrawWithoutPostingAsync(OverlayRefreshType, CancellationToken)

This method draws the overlay without posting the result to the map, PostAsync needs to be called after it.

public Task DrawWithoutPostingAsync(OverlayRefreshType refreshType, CancellationToken cancellationToken)

Parameters

refreshType OverlayRefreshType

        This parameter indicates whether the elements of this overlay needs to be refreshed.
        For example, TileOverlay is formed by tiles.
        When panning the map around, the existing tile doesn't need to be redrawn,
        the only thing we need to do is modifying the position of these tiles.
        On another hand, when click to change the style of the overlay,
        we need to redraw the tile images to change the appearance. So we need refresh mode.

cancellationToken CancellationToken

        The cancellation token for this Async method.

Returns

Task

DrawWithoutPostingAsyncCore(OverlayRefreshType, CancellationToken)

This method draws the overlay without posting the result to the map, PostAsync needs to be called after it.

protected Task DrawWithoutPostingAsyncCore(OverlayRefreshType refreshType, CancellationToken cancellationToken)

Parameters

refreshType OverlayRefreshType

        This parameter indicates whether the elements of this overlay needs to be refreshed.
        For example, TileOverlay is formed by tiles.
        When panning the map around, the existing tile doesn't need to be redrawn,
        the only thing we need to do is modifying the position of these tiles.
        On another hand, when click to change the style of the overlay,
        we need to redraw the tile images to change the appearance. So we need refresh mode.

cancellationToken CancellationToken

        The cancellation token for this Async method.

Returns

Task

PostAsync(CancellationToken)

internal Task PostAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task

PostAsyncCore(CancellationToken)

Post the drawn image to the overlay

protected Task PostAsyncCore(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken
The token to monitor the cancellation requests.

Returns

Task

Transform(RectangleShape, IMapView)

This method will simulate the PostTransform interaction.

public void Transform(RectangleShape extent, IMapView mapView)

Parameters

extent RectangleShape
This parameter maintains the target extent of the transformation.

mapView IMapView
This parameter maintains current map information for calculating mechanism.

TransformCore(RectangleShape, IMapView)

This protected virtual method is the Core method of PostTransform API.

protected void TransformCore(RectangleShape extent, IMapView mapView)

Parameters

extent RectangleShape
This parameter maintains the target extent of the transformation.

mapView IMapView
The mapView this overlay is added to

GetBoundingBox()

This method gets a bounding box of the Overlay.

public RectangleShape GetBoundingBox()

Returns

RectangleShape
A RectangleShape indicating the bounding box of this overlay

Remarks:

This method is the concrete wrapper for the abstract method GetBoundingBoxCore. This method returns the bounding box of the Overlay.

As this is a concrete public method that wraps a Core method, we reserve the right to add events and other logic to pre- or post-process data returned by the Core version of the method. In this way, we leave our framework open on our end, but also allow you the developer to extend our logic to suit your needs. If you have questions about this, please contact our support team as we would be happy to work with you on extending our framework.

GetBoundingBoxCore()

This method returns the bounding box of the Overlay.

protected RectangleShape GetBoundingBoxCore()

Returns

RectangleShape
This method returns the bounding box of the Overlay.

Remarks:

This method returns the bounding box of the Overlay.

OnDrawing(DrawingOverlayEventArgs)

This method raises before the overlay is drawing.

protected void OnDrawing(DrawingOverlayEventArgs e)

Parameters

e DrawingOverlayEventArgs
This parameter is the event argument for Drawing event.

OnDrawn(DrawnOverlayEventArgs)

This method raises after the overlay is drawn.

protected void OnDrawn(DrawnOverlayEventArgs e)

Parameters

e DrawnOverlayEventArgs
This parameter is the event argument for Drawn event.

Dispose()

public void Dispose()

Dispose(Boolean)

This method dispose unmanaged resource used in this class.

protected void Dispose(bool disposing)

Parameters

disposing Boolean

Finalize()

protected void Finalize()

Events

Drawing

This event raises before the overlay is drawing.

public event EventHandler<DrawingOverlayEventArgs> Drawing;

Drawn

This event raises after the overlay is drawn.

public event EventHandler<DrawnOverlayEventArgs> Drawn;

ChildrenReordered

public event EventHandler ChildrenReordered;

Focused

public event EventHandler<FocusEventArgs> Focused;

MeasureInvalidated

public event EventHandler MeasureInvalidated;

SizeChanged

public event EventHandler SizeChanged;

Unfocused

public event EventHandler<FocusEventArgs> Unfocused;

BatchCommitted

public event EventHandler<EventArg<VisualElement>> BatchCommitted;

FocusChangeRequested

public event EventHandler<FocusRequestArgs> FocusChangeRequested;

Loaded

public event EventHandler Loaded;

Unloaded

public event EventHandler Unloaded;

ChildAdded

public event EventHandler<ElementEventArgs> ChildAdded;

ChildRemoved

public event EventHandler<ElementEventArgs> ChildRemoved;

DescendantAdded

public event EventHandler<ElementEventArgs> DescendantAdded;

DescendantRemoved

public event EventHandler<ElementEventArgs> DescendantRemoved;

ParentChanging

public event EventHandler<ParentChangingEventArgs> ParentChanging;

ParentChanged

public event EventHandler ParentChanged;

HandlerChanging

public event EventHandler<HandlerChangingEventArgs> HandlerChanging;

HandlerChanged

public event EventHandler HandlerChanged;

PropertyChanged

public event PropertyChangedEventHandler PropertyChanged;

PropertyChanging

public event PropertyChangingEventHandler PropertyChanging;

BindingContextChanged

public event EventHandler BindingContextChanged;