Class MapsDataLabelSettings

Defines the options for customizing the data labels in the map layer.

Inheritance

System.Object

MapsDataLabelSettings

Namespace: Syncfusion.Blazor.Maps

Assembly: Syncfusion.Blazor.dll

Syntax

public class MapsDataLabelSettings : OwningComponentBase

Constructors

MapsDataLabelSettings()

Declaration

public MapsDataLabelSettings()

Properties

AnimationDuration

Gets and sets the duration time for animating the data label.

Declaration

public double AnimationDuration { get; set; }

Property Value

Type	Description
System.Double	Accepts the double value to modify the duration of animation of the label.

Remarks

You can modify this value to enable the animation in the data labels. If the value is set as 0, animation will be disabled.

ChildContent

Gets or sets the content of the UI element.

Declaration

public RenderFragment ChildContent { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment	A Microsoft.AspNetCore.Components.RenderFragment used to specify the content to be rendered inside the component.

Remarks

You can include custom content for rendering within the component using this property.

Fill

Gets or sets the color for the data-labels in maps.

Declaration

public string Fill { get; set; }

Property Value

Type
System.String

IntersectionAction

Gets or sets the intersection action for the data-labels in maps.

Declaration

public IntersectAction IntersectionAction { get; set; }

Property Value

Type
IntersectAction

LabelPath

Gets or sets the path from the data source based on which the data-labels gets rendered.

Declaration

public string LabelPath { get; set; }

Property Value

Type
System.String

LabelTemplate

Gets or sets the template for the data-labels in maps.

Declaration

public RenderFragment<object> LabelTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<System.Object>	A Microsoft.AspNetCore.Components.RenderFragment specifying the custom template for data labels.

Remarks

This property enables the use of custom templates for displaying data labels on the map.

Opacity

Gets or sets the opacity for the color of the data-labels in maps.

Declaration

public double Opacity { get; set; }

Property Value

Type
System.Double

Rx

Gets or sets the x position for the data-labels.

Declaration

public double Rx { get; set; }

Property Value

Type
System.Double

Ry

Gets or sets the y position for the data-labels in maps.

Declaration

public double Ry { get; set; }

Property Value

Type
System.Double

SmartLabelMode

Gets or sets the label mode for the data-labels.

Declaration

public SmartLabelMode SmartLabelMode { get; set; }

Property Value

Type
SmartLabelMode

Visible

Gets or sets a value indicating whether or not to display the data-labels in maps.

Declaration

public bool Visible { get; set; }

Property Value

Type
System.Boolean

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.