Class MapsShapeSettings

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

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

Constructors

MapsShapeSettings()

Declaration
public MapsShapeSettings()

Properties

Autofill

Enables or disables automatic color filling for the shapes.

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

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
[Parameter]
public string BorderColorValuePath { get; set; }
Property Value
Type Description
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
[Parameter]
public string BorderWidthValuePath { get; set; }
Property Value
Type Description
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
[Parameter]
public RenderFragment ChildContent { get; set; }
Property Value
Type Description
RenderFragment

A 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
[Parameter]
public double CircleRadius { get; set; }
Property Value
Type Description
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
[Parameter]
public string ColorValuePath { get; set; }
Property Value
Type Description
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
[Parameter]
public string DashArray { get; set; }
Property Value
Type Description
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
[Parameter]
public string Fill { get; set; }
Property Value
Type Description
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
[Parameter]
public double Opacity { get; set; }
Property Value
Type Description
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
[Parameter]
public string[] Palette { get; set; }
Property Value
Type Description
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
[Parameter]
public string ValuePath { get; set; }
Property Value
Type Description
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
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