Class SfMaps

Inheritance

System.Object

Syncfusion.Blazor.BaseComponent

SfMaps

Implements

System.IDisposable

IMaps

Namespace: Syncfusion.Blazor.Maps

Assembly: Syncfusion.Blazor.dll

Syntax

public class SfMaps : BaseComponent, IDisposable, IMaps

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

Annotations

Sets and gets the options for customizing the annotation of maps.

Declaration

public List<MapsAnnotation> Annotations { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<MapsAnnotation>

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 double BaseLayerIndex { get; set; }

Property Value

Type	Description
System.Double

Border

Sets and gets the options for customizing the color and width of the maps border.

Declaration

public MapsBorder Border { get; set; }

Property Value

Type	Description
MapsBorder

CenterPosition

Sets and gets the center position of the maps.

Declaration

public MapsCenterPosition CenterPosition { get; set; }

Property Value

Type	Description
MapsCenterPosition

ChildContent

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

EnablePersistence

Enable or disable persisting component's state between page reloads.

Declaration

public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean

EnableRtl

Enable or disable rendering component in right to left direction.

Declaration

public bool EnableRtl { get; set; }

Property Value

Type	Description
System.Boolean

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

HtmlAttributes

Declaration

public Dictionary<string, object> HtmlAttributes { get; set; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Object>

ID

Declaration

public override string ID { get; set; }

Property Value

Type	Description
System.String

Overrides

Syncfusion.Blazor.BaseComponent.ID

jsProperty

Declaration

protected override string jsProperty { get; set; }

Property Value

Type	Description
System.String

Overrides

Syncfusion.Blazor.BaseComponent.jsProperty

Layers

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

Declaration

public List<MapsLayer> Layers { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<MapsLayer>

LegendSettings

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

Declaration

public MapsLegendSettings LegendSettings { get; set; }

Property Value

Type	Description
MapsLegendSettings

Locale

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration

public string Locale { get; set; }

Property Value

Type	Description
System.String

MapsArea

Sets and gets the options to customize the area around the map.

Declaration

public MapsAreaSettings MapsArea { get; set; }

Property Value

Type	Description
MapsAreaSettings

Margin

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

Declaration

public MapsMargin Margin { get; set; }

Property Value

Type	Description
MapsMargin

ModelType

Declaration

public override Type ModelType { get; set; }

Property Value

Type	Description
System.Type

Overrides

Syncfusion.Blazor.BaseComponent.ModelType

nameSpace

Declaration

protected override string nameSpace { get; set; }

Property Value

Type	Description
System.String

Overrides

Syncfusion.Blazor.BaseComponent.nameSpace

ProjectionType

Sets and gets the projection type for the maps.

Declaration

public ProjectionType ProjectionType { get; set; }

Property Value

Type	Description
ProjectionType

TabIndex

Sets and gets the tab index value for the maps.

Declaration

public double TabIndex { get; set; }

Property Value

Type	Description
System.Double

Theme

Set and gets the theme supported for the maps.

Declaration

public MapsTheme Theme { get; set; }

Property Value

Type	Description
MapsTheme

TitleSettings

Sets and gets the title to be displayed for maps.

Declaration

public MapsTitleSettings TitleSettings { get; set; }

Property Value

Type	Description
MapsTitleSettings

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

ZoomSettings

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

Declaration

public MapsZoomSettings ZoomSettings { get; set; }

Property Value

Type	Description
MapsZoomSettings

Methods

AddLayer(LayerSettingsModel)

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

Declaration

public Task AddLayer(LayerSettingsModel layer)

Parameters

Type	Name	Description
LayerSettingsModel	layer

Returns

Type	Description
System.Threading.Tasks.Task

AddMarker(Double, Object)

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(double layerIndex, object markerCollection)

Parameters

Type	Name	Description
System.Double	layerIndex
System.Object	markerCollection

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, Object, Nullable<Boolean>)

This method handles the export functionality for the maps component.

Declaration

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

Parameters

Type	Name	Description
ExportType	type
System.String	fileName
System.Object	orientation
System.Nullable<System.Boolean>	allowDownload

Returns

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

GetGeoLocation(Double, Object)

This method is used to get the Geo location points.

Declaration

public Task<GeoPosition> GetGeoLocation(double layerIndex, object location)

Parameters

Type	Name	Description
System.Double	layerIndex
System.Object	location

Returns

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

GetJSNamespace()

Declaration

public string GetJSNamespace()

Returns

Type	Description
System.String

GetLocalizedLabel(String)

Gets the localized label by locale keyword.

Declaration

public Task<string> GetLocalizedLabel(string key)

Parameters

Type	Name	Description
System.String	key

Returns

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

GetModuleName()

Gets component name

Declaration

public Task<string> GetModuleName()

Returns

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

GetTileGeoLocation(Object)

This method is used to get the Geo location points when tile maps is rendered in the maps component.

Declaration

public Task<GeoPosition> GetTileGeoLocation(object location)

Parameters

Type	Name	Description
System.Object	location

Returns

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

MapsOnClick(Object)

This method is used to perform the operations when a click operation is performed on maps.

Declaration

public Task MapsOnClick(object e)

Parameters

Type	Name	Description
System.Object	e

Returns

Type	Description
System.Threading.Tasks.Task

MapsOnDoubleClick(Object)

This method is used to perform operations when performing the double click operation on maps.

Declaration

public Task MapsOnDoubleClick(object e)

Parameters

Type	Name	Description
System.Object	e

Returns

Type	Description
System.Threading.Tasks.Task

MapsOnResize(EventArgs)

Declaration

public Task<bool> MapsOnResize(EventArgs e)

Parameters

Type	Name	Description
System.EventArgs	e

Returns

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

MouseDownOnMap(Object)

This method is used to perform operations when mouse is clicked down on maps.

Declaration

public Task MouseDownOnMap(object e)

Parameters

Type	Name	Description
System.Object	e

Returns

Type	Description
System.Threading.Tasks.Task

MouseEndOnMap(Object)

This method is used to perform operations when mouse click on maps.

Declaration

public Task<bool> MouseEndOnMap(object e)

Parameters

Type	Name	Description
System.Object	e

Returns

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

MouseLeaveOnMap(Object)

This method is used to perform operations when mouse pointer leave from maps.

Declaration

public Task MouseLeaveOnMap(object e)

Parameters

Type	Name	Description
System.Object	e

Returns

Type	Description
System.Threading.Tasks.Task

MouseMoveOnMap(Object)

This method is used to perform operations while performing mouse over on maps.

Declaration

public Task MouseMoveOnMap(object e)

Parameters

Type	Name	Description
System.Object	e

Returns

Type	Description
System.Threading.Tasks.Task

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.BaseComponent.OnAfterRenderAsync(System.Boolean)

OnHybridAfterRender(Boolean)

Declaration

protected Task OnHybridAfterRender(bool firstRender)

Parameters

Type	Name	Description
System.Boolean	firstRender

Returns

Type	Description
System.Threading.Tasks.Task

OnHybridInitialized()

Declaration

protected Task OnHybridInitialized()

Returns

Type	Description
System.Threading.Tasks.Task

OnHybridParametersSet()

Declaration

protected Task OnHybridParametersSet()

Returns

Type	Description
System.Threading.Tasks.Task

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

Syncfusion.Blazor.BaseComponent.OnInitializedAsync()

OnMouseMove(Object)

This method is used to perform operations when mouse move event is performed on maps.

Declaration

public Task<bool> OnMouseMove(object e)

Parameters

Type	Name	Description
System.Object	e

Returns

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

OnParametersSetAsync()

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task

PanByDirection(PanDirection, Object)

This method is used to perform panning by specifying the direction.

Declaration

public Task PanByDirection(PanDirection direction, object mouseLocation = null)

Parameters

Type	Name	Description
PanDirection	direction
System.Object	mouseLocation

Returns

Type	Description
System.Threading.Tasks.Task

PointToLatLong(Double, Double)

This method is used to convert the point to latitude and longitude in maps.

Declaration

public Task<object> PointToLatLong(double pageX, double pageY)

Parameters

Type	Name	Description
System.Double	pageX
System.Double	pageY

Returns

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

Print(Object)

This method handles the printing functionality for the maps component.

Declaration

public Task Print(object id = null)

Parameters

Type	Name	Description
System.Object	id

Returns

Type	Description
System.Threading.Tasks.Task

ProcessResponseJsonData(String, Object, Object, String)

This method is used to process the JSON data to render the maps.

Declaration

public Task ProcessResponseJsonData(string processType, object data = null, object layer = null, string dataType = null)

Parameters

Type	Name	Description
System.String	processType
System.Object	data
System.Object	layer
System.String	dataType

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

Returns

Type	Description
System.Threading.Tasks.Task

ShapeSelection(Double, Object, String, Nullable<Boolean>)

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

Declaration

public Task ShapeSelection(double layerIndex, object propertyName, string name, Nullable<bool> enable = null)

Parameters

Type	Name	Description
System.Double	layerIndex
System.Object	propertyName
System.String	name
System.Nullable<System.Boolean>	enable

Returns

Type	Description
System.Threading.Tasks.Task

updateChildProperties(String, Object)

Declaration

public void updateChildProperties(string key, object value)

Parameters

Type	Name	Description
System.String	key
System.Object	value

ZoomByPosition(Object, Double)

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

Declaration

public Task ZoomByPosition(object centerPosition, double zoomFactor)

Parameters

Type	Name	Description
System.Object	centerPosition
System.Double	zoomFactor

Returns

Type	Description
System.Threading.Tasks.Task

ZoomToCoordinates(Double, Double, Double, Double)

This method is used to zoom the maps component based on the provided coordinates.

Declaration

public Task ZoomToCoordinates(double minLatitude, double minLongitude, double maxLatitude, double maxLongitude)

Parameters

Type	Name	Description
System.Double	minLatitude
System.Double	minLongitude
System.Double	maxLatitude
System.Double	maxLongitude

Returns

Type	Description
System.Threading.Tasks.Task

Implements

System.IDisposable

IMaps