Class MapsAnnotation

Defines the options for customizing the annotation of the maps in a Blazor component.

Inheritance

System.Object

MapsAnnotation

Namespace: Syncfusion.Blazor.Maps

Assembly: Syncfusion.Blazor.dll

Syntax

public class MapsAnnotation : OwningComponentBase

Constructors

MapsAnnotation()

Declaration

public MapsAnnotation()

Properties

ChildContent

Gets or sets the child content UI element within the map annotation.

Declaration

public RenderFragment ChildContent { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment	A Microsoft.AspNetCore.Components.RenderFragment representing the content of the UI element.

Remarks

This property allows you to define custom UI elements inside the annotation using a render fragment.

ContentTemplate

Gets or sets the template content for the annotation in the maps component.

Declaration

public RenderFragment ContentTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment	A Microsoft.AspNetCore.Components.RenderFragment that represents the annotation content.

Remarks

Use this property to define complex content as an annotation using the Blazor render fragment.

HorizontalAlignment

Gets or sets the horizontal alignment for the annotation element.

Declaration

public AnnotationAlignment HorizontalAlignment { get; set; }

Property Value

Type	Description
AnnotationAlignment	An AnnotationAlignment value specifying how the annotation is aligned horizontally.

Remarks

Use this property to control the horizontal position of the annotation, like Left, Center, or Right.

VerticalAlignment

Gets or sets the vertical alignment for the annotation element.

Declaration

public AnnotationAlignment VerticalAlignment { get; set; }

Property Value

Type	Description
AnnotationAlignment	An AnnotationAlignment value specifying how the annotation is aligned vertically.

Remarks

This property determines whether the annotation is positioned at the top, middle, or bottom of the map container.

X

Gets or sets the horizontal position (x-coordinate) of the annotation.

Declaration

public string X { get; set; }

Property Value

Type	Description
System.String	A System.String representing the x-coordinate position.

Remarks

The x-coordinate defines the horizontal placement of the annotation within the map component.

Y

Gets or sets the vertical position (y-coordinate) of the annotation.

Declaration

public string Y { get; set; }

Property Value

Type	Description
System.String	A System.String representing the y-coordinate position.

Remarks

The y-coordinate determines the vertical placement of the annotation within the map component.

ZIndex

Gets or sets the z-index of the annotation within the map component.

Declaration

public string ZIndex { get; set; }

Property Value

Type	Description
System.String	A System.String representing the z-index. The default value is "-1".

Remarks

The z-index specifies the stack order of the annotation; higher values appear above lower ones.

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder	__builder

Dispose(Boolean)

Disposes the property values during the destroy of the component that is hold up for the execution of the component.

Declaration

protected override void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

OnInitializedAsync()

OnInitializedAsync method is called when the component has received its initial parameters.

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task representing the asynchronous operation.

OnParametersSetAsync()

OnParametersSetAsync is a lifecycle method that is invoked when the component has received parameters, and the incoming values have been assigned to the properties.

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task representing the asynchronous operation.