Class MapsShapeSettings

Sets and gets the options to customize the shape of the maps.

Inheritance

System.Object

MapsShapeSettings

Namespace: Syncfusion.Blazor.Maps

Assembly: Syncfusion.Blazor.dll

Syntax

public class MapsShapeSettings : OwningComponentBase

Constructors

MapsShapeSettings()

Declaration

public MapsShapeSettings()

Properties

Autofill

Enables or disables automatic color filling for the shapes.

Declaration

public bool Autofill { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value indicating whether automatic color filling is enabled. The default is false.

Remarks

When set to true, the shapes in the map will automatically be filled with color if a color mapping is defined.

BorderColorValuePath

Gets and sets the data source path for the color of the border of the shapes in maps.

Declaration

public string BorderColorValuePath { get; set; }

Property Value

Type	Description
System.String	A string that specifies the data source path for border color values.

Remarks

This property is used to dynamically bind border color values from a data source.

BorderWidthValuePath

Gets and sets the data source path for the width of the border of the shapes in maps.

Declaration

public string BorderWidthValuePath { get; set; }

Property Value

Type	Description
System.String	A string that specifies the data source path for border width values.

Remarks

Use this property to bind border width settings of shapes to specific values from a data source.

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 that represents the content of the UI element for shape settings.

Remarks

This property allows you to specify additional content to be rendered as part of the shape settings.

CircleRadius

Sets and gets the radius of the shape.

Declaration

public double CircleRadius { get; set; }

Property Value

Type	Description
System.Double	A double value representing the radius of circular shapes. The default value is 5.

Remarks

This property is used to define the size of circular shapes on the map.

ColorValuePath

Sets and gets the value path from the data source to set the color for the shapes in maps.

Declaration

public string ColorValuePath { get; set; }

Property Value

Type	Description
System.String	A string that specifies the data source path for color values.

Remarks

This property is used to bind the color of shapes to specific values from a data source.

DashArray

Sets and gets the dash-array for the shapes in maps.

Declaration

public string DashArray { get; set; }

Property Value

Type	Description
System.String	A string value that represents the pattern of dashes and gaps.

Remarks

This property is used for designing the outline of shapes with dashed lines using SVG dash array string format.

Fill

Sets and gets the default fill color for the shapes in maps.

Declaration

public string Fill { get; set; }

Property Value

Type	Description
System.String	A string that represents the fill color for shapes, using HTML color formats like hex or rgb.

Remarks

This property sets the background color for map shapes.

Opacity

Sets and gets the opacity for the shapes in maps.

Declaration

public double Opacity { get; set; }

Property Value

Type	Description
System.Double	A double value between 0 and 1 indicating the opacity level. The default value is 1.

Remarks

This property controls the transparency level of the shapes.

Palette

Sets and gets a set of colors for shapes in maps.

Declaration

public string[] Palette { get; set; }

Property Value

Type	Description
System.String[]	An array of colors that can be used for various shapes on the map.

Remarks

This palette can define a range of colors for shapes based on specific conditions or properties.

ValuePath

Sets and gets the value from the data source based on which the shape gets rendered.

Declaration

public string ValuePath { get; set; }

Property Value

Type	Description
System.String	A string that specifies the path to a data source field for rendering shapes.

Remarks

Use this property to map shape rendering to data values, allowing for dynamic shape adjustments based on data binding.

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.