Skip to content

Overlay

Namespace: ThinkGeo.UI.Blazor

Provides the base functionality shared by all overlays rendered inside a .

public abstract class Overlay : Microsoft.AspNetCore.Components.ComponentBase, Microsoft.AspNetCore.Components.IComponent, Microsoft.AspNetCore.Components.IHandleEvent, Microsoft.AspNetCore.Components.IHandleAfterRender

Inheritance Object → ComponentBase → Overlay
Implements IComponent, IHandleEvent, IHandleAfterRender

Properties

Id

Gets or sets the unique identifier used to register this overlay with the map. Defaults to a new GUID.

public string Id { get; set; }

Property Value

String

IsVisible

Gets or sets a value indicating whether this overlay participates in draw requests. Defaults to true.

public bool IsVisible { get; set; }

Property Value

Boolean

Methods

RedrawAsync()

Requests that the overlay redraw itself. The base implementation is a no-op and returns a completed task.

public Task RedrawAsync()

Returns

Task
A completed task that callers can await.

InitAsync()

Initializes the overlay once it has been connected to a . The base implementation performs no work.

protected internal Task InitAsync()

Returns

Task
A task that completes when initialization finishes.

ReleaseAsync()

Releases any resources associated with the overlay. The base implementation detaches the overlay from the current .

protected internal Task ReleaseAsync()

Returns

Task
A task that completes when cleanup is finished.

OnAfterRenderAsync(Boolean)

Ensures the overlay is initialized after rendering and then defers to the base Blazor lifecycle implementation.

protected Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender Boolean
Indicates whether this is the first time the component has been rendered.

Returns

Task
A task that completes when initialization and base processing are finished.