Class MapsZoomSettings

Sets and gets the options to customize the zooming operations in maps.

Inheritance

System.Object

MapsZoomSettings

Namespace: Syncfusion.Blazor.Maps

Assembly: Syncfusion.Blazor.dll

Syntax

public class MapsZoomSettings : OwningComponentBase

Constructors

MapsZoomSettings()

Declaration

public MapsZoomSettings()

Properties

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 allows custom content to be rendered inside the zoom settings panel.

Color

Sets and gets the color for the toolbar in maps.

Declaration

public string Color { get; set; }

Property Value

Type	Description
System.String	A string representing the color used in the map's toolbar. Default is null.

Remarks

Use this property to define a specific color for the toolbar interface in the maps.

DoubleClickZoom

Enables or disables the double click zooming in maps.

Declaration

public bool DoubleClickZoom { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value where true enables double click zooming, and false disables it.

Remarks

This property allows users to zoom in to the map by double-clicking on it.

Enable

Enables or disables the zooming operation in the maps component.

Declaration

public bool Enable { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value where true enables zooming, and false disables it.

Remarks

This property determines whether the map can be zoomed in or out.

EnablePanning

Enables or disables the panning operation in the maps component.

Declaration

public bool EnablePanning { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value where true enables panning, and false disables it. Default is true.

Remarks

This property allows users to move the map around by dragging.

EnableSelectionZooming

Enables or disables the selection zooming operation in the maps component.

Declaration

public bool EnableSelectionZooming { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value where true enables selection zooming, and false disables it. Default is true.

Remarks

This property lets users zoom in by selecting a specific area of the map.

MaxZoom

Sets and gets the maximum zooming value in maps.

Declaration

public double MaxZoom { get; set; }

Property Value

Type	Description
System.Double	A double value representing the maximum zoom level allowed. Default is 10.

Remarks

This property defines how far the user can zoom into the map.

MinZoom

Sets and gets the minimum zooming value in maps.

Declaration

public double MinZoom { get; set; }

Property Value

Type	Description
System.Double	A double value representing the minimum zoom level allowed. Default is 1.

Remarks

This property determines how much the map can be zoomed out.

MouseWheelZoom

Enables or disables the mouse wheel zooming in maps.

Declaration

public bool MouseWheelZoom { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value where true enables mouse wheel zooming, and false disables it. Default is true.

Remarks

This property allows the map to be zoomed in or out using the mouse wheel.

PinchZooming

Enables or disables the pinch zooming in maps.

Declaration

public bool PinchZooming { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value where true enables pinch zooming, and false disables it. Default is true.

Remarks

This property is used to enable zooming via pinch gestures on touch devices.

ResetToInitial

Enables or disables the zoom to set the initial State.

Declaration

public bool ResetToInitial { get; set; }

Property Value

Type	Description
System.Boolean	A boolean indicating whether to reset the zoom to the initial state.

Remarks

This property determines if the map should return to its initial zoom level when reset.

ShouldZoomInitially

Enables or disables the zoom based on the marker position while rendering the maps.

Declaration

public bool ShouldZoomInitially { get; set; }

Property Value

Type	Description
System.Boolean	A boolean indicating whether the map should zoom initially based on marker positions.

Remarks

This property allows the map to automatically zoom to a marker when initially rendered.

ZoomFactor

Sets and gets the factor of zoom to be displayed while rendering the maps.

Declaration

public double ZoomFactor { get; set; }

Property Value

Type	Description
System.Double	A double representing the initial zoom factor for the map. Default is 1.

Remarks

This factor determines the default zoom level when the map is rendered.

ZoomOnClick

Enables or disables the zooming on clicking the shapes in maps.

Declaration

public bool ZoomOnClick { get; set; }

Property Value

Type	Description
System.Boolean	A boolean indicating whether clicking on shapes should trigger a zoom.

Remarks

This property allows interaction with map shapes to initiate zooming.

ZoomOnMarkerClick

Enables or disables zooming of the map when clicking on the markers.

Declaration

public bool ZoomOnMarkerClick { get; set; }

Property Value

Type	Description
System.Boolean	Accepts boolean values. true if the map should zoom in when a marker is clicked. Otherwise, false. Default is true.

Remarks

This property controls whether the map zooms in on markers when they are clicked.

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.