Class SfMaps

The Maps component is ideal for rendering maps from GeoJSON data or other map providers like OpenStreetMap, Google maps and Bing maps. Its rich feature set includes markers, labels, bubbles, navigation lines, legends, tooltips, zooming, panning, and much more.

Inheritance

System.Object

Syncfusion.Blazor.SfBaseComponent

SfMaps

Namespace: Syncfusion.Blazor.Maps

Assembly: Syncfusion.Blazor.dll

Syntax

public class SfMaps : SfBaseComponent

Constructors

SfMaps()

Declaration

public SfMaps()

Properties

AllowImageExport

Enables or disables the export to image functionality in map.

Declaration

public bool AllowImageExport { get; set; }

Property Value

Type	Description
System.Boolean

AllowPdfExport

Enables or disables the export to PDF functionality in map.

Declaration

public bool AllowPdfExport { get; set; }

Property Value

Type	Description
System.Boolean

AllowPrint

Enables or disables the print functionality in map.

Declaration

public bool AllowPrint { get; set; }

Property Value

Type	Description
System.Boolean

Background

Sets and gets the background color of the maps container.

Declaration

public string Background { get; set; }

Property Value

Type	Description
System.String

BaseLayerIndex

Sets and gets the base map index of maps. It provides the option to select which layer to be visible in the maps.

Declaration

public int BaseLayerIndex { get; set; }

Property Value

Type	Description
System.Int32

ChildContent

Sets and gets the content of the UI element.

Declaration

public RenderFragment ChildContent { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment

Description

Sets and gets the description for maps.

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String

Format

Sets and gets the format in which the text in the maps are to be rendered.

Declaration

public string Format { get; set; }

Property Value

Type	Description
System.String

Height

Sets and gets the height in which the maps is to be rendered.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String

ID

Set the ID string for the map component.

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String

ProjectionType

Sets and gets the projection type for the maps.

Declaration

public ProjectionType ProjectionType { get; set; }

Property Value

Type	Description
ProjectionType

theme

Declaration

public Theme theme { get; set; }

Property Value

Type	Description
Theme

Theme

Set and gets the theme supported for the maps.

Declaration

public Theme Theme { get; set; }

Property Value

Type	Description
Theme

TooltipDisplayMode

Sets and gets the mode in which the tooltip is to be displayed. The tooltip can be rendered on mouse move, click or double clicking on the element on the map.

Declaration

public TooltipGesture TooltipDisplayMode { get; set; }

Property Value

Type	Description
TooltipGesture

UseGroupingSeparator

Enables or disables the visibility state of the separator for grouping.

Declaration

public bool UseGroupingSeparator { get; set; }

Property Value

Type	Description
System.Boolean

Width

Sets and gets the width in which the maps is to be rendered.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String

Methods

AddLayer(ILayer)

This method is used to add the layers dynamically to the maps.

Declaration

public Task AddLayer(ILayer layer)

Parameters

Type	Name	Description
ILayer	layer	Specifies to add the layers dynamically to the maps.

Returns

Type	Description
System.Threading.Tasks.Task

AddMarker(Int32, List<IMarker>)

This method is used to add markers dynamically in the maps. If we provide the index value of the layer in which the marker to be added and the coordinates of the marker as parameters, the marker will be added in the location.

Declaration

public Task AddMarker(int layerIndex, List<IMarker> markerCollection)

Parameters

Type	Name	Description
System.Int32	layerIndex	Specifies the layer index of maps.
System.Collections.Generic.List<IMarker>	markerCollection	Specifies to add the marker dynamically.

Returns

Type	Description
System.Threading.Tasks.Task

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder	__builder

Export(ExportType, String, Nullable<PdfPageOrientation>, Boolean)

This method handles the export functionality for the maps component.

Declaration

public Task<string> Export(ExportType type, string fileName, Nullable<PdfPageOrientation> orientation = null, bool allowDownload = true)

Parameters

Type	Name	Description
ExportType	type	Specifies the extension type of the exported map.
System.String	fileName	Specifes the file name to be used for the exported map.
System.Nullable<Syncfusion.PdfExport.PdfPageOrientation>	orientation	Specifies the ortientation of the PDF document.
System.Boolean	allowDownload	Specifies whether to download or return base64 string of the exported document.

Returns

Type	Description
System.Threading.Tasks.Task<System.String>

OnAfterRenderAsync(Boolean)

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
System.Boolean	firstRender

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

Syncfusion.Blazor.SfBaseComponent.OnAfterRenderAsync(System.Boolean)

OnComponentParametersSet()

Declaration

protected Task OnComponentParametersSet()

Returns

Type	Description
System.Threading.Tasks.Task

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

Syncfusion.Blazor.SfBaseComponent.OnInitializedAsync()

OnParametersSetAsync()

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Print()

This method handles the printing functionality for the maps component.

Declaration

public Task Print()

Returns

Type	Description
System.Threading.Tasks.Task

Refresh()

The method is used to render the maps again.

Declaration

public Task Refresh()

Returns

Type	Description
System.Threading.Tasks.Task

RemoveLayer(Int32)

This method is used to remove a layer from map.

Declaration

public Task RemoveLayer(int index)

Parameters

Type	Name	Description
System.Int32	index	Specifies to remove the layer.

Returns

Type	Description
System.Threading.Tasks.Task

ShapeSelection(Int32, String, String, Boolean)

This method is used to select the geometric shape element in the maps component.

Declaration

public Task ShapeSelection(int layerIndex, string propertyName, string name, bool enable = true)

Parameters

Type	Name	Description
System.Int32	layerIndex	Specifies the index number of layer.
System.String	propertyName	Specifies the property path for map shape data to select the shape.
System.String	name	Specifies the shape data path for the data source of the layer.
System.Boolean	enable	Specifies whether to select or unselect the shape.

Returns

Type	Description
System.Threading.Tasks.Task

ZoomByPosition(MapsCenterPosition, Double)

This method is used to zoom the map by specifying the center position.

Declaration

public Task ZoomByPosition(MapsCenterPosition centerPosition, double zoomFactor)

Parameters

Type	Name	Description
MapsCenterPosition	centerPosition	Specifies the position of the maps.
System.Double	zoomFactor	Specifies the zoom level of maps.

Returns

Type	Description
System.Threading.Tasks.Task