Class
TelerikMap

An interactive map component with layers, markers, shapes, and controls. Define content via MapLayers and MapControls; handle user interaction with OnClick (map surface), OnMarkerClick, OnShapeClick, and viewport changes through OnZoomEnd and OnPanEnd. Supports marker tooltips and integrates with SVG or font icons. Children: MapLayers, MapControls.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

cs-api-definition
public class TelerikMap : DataVizComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseBaseComponentDataVizComponentTelerikMap

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members DataVizComponent.Dispose()DataVizComponent.Refresh()DataVizComponent.ChildContentDataVizComponent.WidthDataVizComponent.HeightBaseComponent.ShouldRender()BaseComponent.OnInitializedAsync()BaseComponent.OnAfterRenderAsync(bool)BaseComponent.InitLocalizer()BaseComponent.ThrowIfParameterIsNull(object, string)BaseComponent.HaveOptionsChanged(IDictionary<string, object>, IDictionary<string, object>)BaseComponent.GetClassString(params string[])BaseComponent.InvokeAsync<T>(string, params object[])BaseComponent.InvokeAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidAsync(string, params object[])BaseComponent.InvokeVoidAsyncWithoutAwait(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidComponentMethodAsync(string, params object[])BaseComponent.InvokeComponentVoidMethodAsync(string, object)BaseComponent.InvokeDisposeAsync()BaseComponent.StateHasChanged()BaseComponent.RootComponentBaseComponent.ClassComponentBase.OnParametersSetAsync()ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)ComponentBase.DispatchExceptionAsync(Exception)ComponentBase.SetParametersAsync(ParameterView)

Constructors

TelerikMap()

Declaration

cs-api-definition
public TelerikMap()

Properties

Center

The map center. Coordinates are listed as [Latitude, Longitude].

Declaration

cs-api-definition
[Parameter]
public double[] Center { get; set; }

Property Value

double[]

EnableWebMcpTools

Enables the registration of WebMCP tools for this Map instance. When set to true, the Map operations (set center, set zoom, add marker, clear markers) are exposed as tools discoverable by AI models through the browser. Default value is false.

Declaration

cs-api-definition
[Parameter]
public bool EnableWebMcpTools { get; set; }

Property Value

bool

MapSettings

Provides configuration for WebMCP tools, such as a Name to distinguish this Map from others on the same page.

Declaration

cs-api-definition
[Parameter]
public RenderFragment MapSettings { get; set; }

Property Value

RenderFragment

MaxZoom

The maximum zoom level. Typical web maps use zoom levels from 0 (whole world) to 19 (sub-meter features).

Declaration

cs-api-definition
[Parameter]
public double? MaxZoom { get; set; }

Property Value

double?

MinSize

The size of the map in pixels at zoom level 0.

Declaration

cs-api-definition
[Parameter]
public double? MinSize { get; set; }

Property Value

double?

MinZoom

The minimum zoom level. Typical web maps use zoom levels from 0 (whole world) to 19 (sub-meter features).

Declaration

cs-api-definition
[Parameter]
public double? MinZoom { get; set; }

Property Value

double?

OnClick

Fires when the user clicks on the map surface (not on markers or shapes). Provides location coordinates and mouse event details for implementing custom click behaviors.

Declaration

cs-api-definition
[Parameter]
public EventCallback<MapClickEventArgs> OnClick { get; set; }

Property Value

EventCallback<MapClickEventArgs>

OnMarkerClick

Fires when the user clicks on a marker displayed on the map. Provides access to the clicked marker's data item and mouse event details for handling marker interactions.

Declaration

cs-api-definition
[Parameter]
public EventCallback<MapMarkerClickEventArgs> OnMarkerClick { get; set; }

Property Value

EventCallback<MapMarkerClickEventArgs>

OnPanEnd

Fires when the user completes a pan operation on the map. Use this event to respond to map position changes and update related UI elements or data.

Declaration

cs-api-definition
[Parameter]
public EventCallback<MapPanEndEventArgs> OnPanEnd { get; set; }

Property Value

EventCallback<MapPanEndEventArgs>

OnShapeClick

Fires when the user clicks on a shape (polygon, polyline, or other vector shape) displayed on the map. Provides access to both the shape's data item and GeoJSON data for handling shape interactions.

Declaration

cs-api-definition
[Parameter]
public EventCallback<MapShapeClickEventArgs> OnShapeClick { get; set; }

Property Value

EventCallback<MapShapeClickEventArgs>

OnZoomEnd

Fires when the user completes a zoom operation on the map. Use this event to respond to zoom level changes and update related UI elements or data.

Declaration

cs-api-definition
[Parameter]
public EventCallback<MapZoomEndEventArgs> OnZoomEnd { get; set; }

Property Value

EventCallback<MapZoomEndEventArgs>

Pannable

Controls whether the user can pan the map.

Declaration

cs-api-definition
[Parameter]
public bool? Pannable { get; set; }

Property Value

bool?

WrapAround

Specifies whether the map should wrap around the east-west edges.

Declaration

cs-api-definition
[Parameter]
public bool? WrapAround { get; set; }

Property Value

bool?

Zoom

The initial zoom level.Typical web maps use zoom levels from 0 (whole world) to 19 (sub-meter features).The map size is derived from the zoom level and minScale options: size = (2 ^ zoom) * minSize

Declaration

cs-api-definition
[Parameter]
public double? Zoom { get; set; }

Property Value

double?

Zoomable

Controls whether the map zoom level can be changed by the user.

Declaration

cs-api-definition
[Parameter]
public bool? Zoomable { get; set; }

Property Value

bool?

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

cs-api-definition
protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

OnAfterRender(bool)

Declaration

cs-api-definition
protected override void OnAfterRender(bool firstRender)

Parameters

firstRender

bool

Overrides DataVizComponent.OnAfterRender(bool)

OnInitialized()

Declaration

cs-api-definition
protected override void OnInitialized()

Overrides DataVizComponent.OnInitialized()

OnParametersSet()

Declaration

cs-api-definition
protected override void OnParametersSet()

Overrides DataVizComponent.OnParametersSet()