menu

Blazor

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class MapsMarkerClusterSettings - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    Class MapsMarkerClusterSettings

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

    Inheritance
    System.Object
    MapsMarkerClusterSettings
    Namespace: Syncfusion.Blazor.Maps
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class MapsMarkerClusterSettings : OwningComponentBase

    Constructors

    MapsMarkerClusterSettings()

    Declaration
    public MapsMarkerClusterSettings()

    Properties

    AllowClusterExpand

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

    Declaration
    public bool AllowClusterExpand { get; set; }
    Property Value
    Type Description
    System.Boolean

    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
    public bool AllowClustering { get; set; }
    Property Value
    Type Description
    System.Boolean

    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
    public RenderFragment ChildContent { get; set; }
    Property Value
    Type Description
    Microsoft.AspNetCore.Components.RenderFragment

    A Microsoft.AspNetCore.Components.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
    public string DashArray { get; set; }
    Property Value
    Type Description
    System.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
    public string Fill { get; set; }
    Property Value
    Type Description
    System.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
    public double Height { get; set; }
    Property Value
    Type Description
    System.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
    public string ImageUrl { get; set; }
    Property Value
    Type Description
    System.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.

    Offset

    Sets and gets the offset position for the marker cluster in maps.

    Declaration
    public object Offset { get; set; }
    Property Value
    Type Description
    System.Object

    An object that specifies the offset. This property is deprecated.

    Remarks

    This property is deprecated and no longer used.

    Opacity

    Sets and gets the opacity of the marker cluster.

    Declaration
    public double Opacity { get; set; }
    Property Value
    Type Description
    System.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
    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
    public double Width { get; set; }
    Property Value
    Type Description
    System.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
    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.

    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved