Class MapsMarkerClusterSettings

Sets and gets the option for the customization of marker cluster for the maps.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
MapsMarkerClusterSettings
Implements
Inherited Members
Namespace: Syncfusion.Blazor.Maps
Assembly: Syncfusion.Blazor.dll
Syntax
public class MapsMarkerClusterSettings : SfOwningComponentBase, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Constructors

MapsMarkerClusterSettings()

Declaration
public MapsMarkerClusterSettings()

Properties

AllowClusterExpand

Enables or disables the cluster expand when many markers are in same location.

Declaration
[Parameter]
public bool AllowClusterExpand { get; set; }
Property Value
Type Description
bool

A bool to determine expandability. Default is false.
Remarks

When enabled, clusters can be expanded to display individual markers.

AllowClustering

Enables or disables the visibility state of the clustering of markers in the maps component.

Declaration
[Parameter]
public bool AllowClustering { get; set; }
Property Value
Type Description
bool

A bool indicating whether clustering is allowed. Default is false.
Remarks

Clustering groups overlapping markers to improve map readability.

ChildContent

Sets and gets the content of the UI element.

Declaration
[Parameter]
public RenderFragment ChildContent { get; set; }
Property Value
Type Description
RenderFragment

A RenderFragment representing UI content.
Remarks

This property allows you to include additional structured content inside the marker cluster settings.

DashArray

Sets and gets the dash array for the marker cluster in maps. @default ''.

Declaration
[Parameter]
public string DashArray { get; set; }
Property Value
Type Description
string

A string representing dash style. Default is string.Empty.
Remarks

This defines the stroke pattern for the cluster borders.

Fill

Sets and gets the fill color of the cluster.

Declaration
[Parameter]
public string Fill { get; set; }
Property Value
Type Description
string

A string representing the fill color. Default is "#D2691E".
Remarks

This property sets the background color for the marker clusters.

Height

Sets and gets the height of the marker cluster in maps.

Declaration
[Parameter]
public double Height { get; set; }
Property Value
Type Description
double

A double representing the height in pixels. Default is 12.
Remarks

This determines the vertical size of marker clusters.

ImageUrl

Sets and gets the URL path for the marker cluster when the cluster shape is set as image in maps.

Declaration
[Parameter]
public string ImageUrl { get; set; }
Property Value
Type Description
string

A string representing the URL of the image.
Remarks

Use this property to specify an image for the cluster when Shape is set to MarkerType.Image.

Opacity

Sets and gets the opacity of the marker cluster.

Declaration
[Parameter]
public double Opacity { get; set; }
Property Value
Type Description
double

A double representing the opacity, with a default of 1.
Remarks

This property controls the transparency level of marker clusters.

Shape

Sets and gets shape for the cluster of markers.

Declaration
[Parameter]
public MarkerType Shape { get; set; }
Property Value
Type Description
MarkerType

A MarkerType that represents the shape. The default is Rectangle.
Remarks

This property defines the geometric shape used for clustering markers.

Width

Sets and gets the width of the marker cluster in maps.

Declaration
[Parameter]
public double Width { get; set; }
Property Value
Type Description
double

A double representing the width in pixels. Default is 12.
Remarks

This controls the horizontal size of marker clusters.

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
RenderTreeBuilder __builder
Overrides

Dispose(bool)

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
bool disposing
Overrides

OnInitializedAsync()

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

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
Task

Task representing the asynchronous operation.
Overrides

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
Task

Task representing the asynchronous operation.
Overrides

Implements