Class MapsZoomToolbarButton

Gets and sets the properties for rendering the buttons in the zoom toolbar.

Inheritance

System.Object

MapsZoomToolbarButton

Namespace: Syncfusion.Blazor.Maps

Assembly: Syncfusion.Blazor.dll

Syntax

public class MapsZoomToolbarButton : OwningComponentBase

Constructors

MapsZoomToolbarButton()

Declaration

public MapsZoomToolbarButton()

Properties

BorderColor

Gets and sets the color of the border of the button in the zoom toolbar.

Declaration

public string BorderColor { get; set; }

Property Value

Type	Description
System.String	A string representing the color of the button's border.

Remarks

This property specifies the border color for individual buttons in the zoom toolbar.

BorderOpacity

Gets and sets the opacity of the border of the button in the zoom toolbar.

Declaration

public double BorderOpacity { get; set; }

Property Value

Type	Description
System.Double	A double value representing the border's opacity, ranging from 0 (completely transparent) to 1 (fully opaque). Default is 1.

Remarks

This property allows customization of border transparency for zoom toolbar buttons.

BorderWidth

Gets and sets the width of the border of the button in the zoom toolbar.

Declaration

public double BorderWidth { get; set; }

Property Value

Type	Description
System.Double	A double value representing the width of the button's border. The default value is 1.

Remarks

Use this property to define how thick the borders of toolbar buttons should appear.

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 the template content of the UI element.

Remarks

This property is used to define custom content within the button elements of the zoom toolbar.

Color

Gets and sets the color of the icons of the button.

Declaration

public string Color { get; set; }

Property Value

Type	Description
System.String	A string representing the color of the button icons.

Remarks

This property is used to set the color for icons displayed on toolbar buttons.

Fill

Gets and sets the fill color of the button.

Declaration

public string Fill { get; set; }

Property Value

Type	Description
System.String	A string representing the button's background fill color. Default is "transparent".

Remarks

Use this property to set a background color for the zoom toolbar buttons.

HighlightColor

Gets and sets the color of the icons of the button when mouseover is performed.

Declaration

public string HighlightColor { get; set; }

Property Value

Type	Description
System.String	A string representing the highlight color for button icons during mouseover.

Remarks

Customize this property to change the icon color when the user hovers over a toolbar button.

Opacity

Gets and sets the opacity of the button.

Declaration

public double Opacity { get; set; }

Property Value

Type	Description
System.Double	A double value indicating the opacity level of the button. Default is 1.

Remarks

This property controls the transparency of the entire button when displayed in the toolbar.

Padding

Gets and sets the padding of the button.

Declaration

public double Padding { get; set; }

Property Value

Type	Description
System.Double	A double value representing padding around the button's content. Default is 5.

Remarks

Use this property to adjust spacing around icons or text within toolbar buttons.

Radius

Gets and sets the height of the button.

Declaration

public double Radius { get; set; }

Property Value

Type	Description
System.Double	A double value representing the button's radius. Default is 0.

Remarks

This property controls the corner roundness of the toolbar buttons.

SelectionColor

Gets and sets the color of the icons of the button when selection is performed.

Declaration

public string SelectionColor { get; set; }

Property Value

Type	Description
System.String	A string representing the color of button icons when selected.

Remarks

This property allows you to specify a color for when a toolbar button is active or selected.

ToolbarItems

Gets and sets the type of buttons to render in the zoom toolbar, such as ZoomIn, ZoomOut, Zoom, Reset, and Pan.

Declaration

public List<ToolbarItem> ToolbarItems { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<ToolbarItem>	A list of ToolbarItem indicating the buttons available in the toolbar. Defaults to ZoomIn, ZoomOut, and Reset.

Remarks

This property defines which zoom actions are represented by buttons within the toolbar.

Methods

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.