Class
MapLayer

Represents a data layer on the map that can display markers, shapes, or bubble visualizations. Provides a container for organizing related map content with specific rendering settings and data binding. Children: MapLayerMarkerSettings, MapLayerShapeSettings, MapLayerBubbleSettings.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

cs-api-definition
public class MapLayer : DataVizCollectionItemComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseDataVizChildComponentDataVizCollectionItemComponentMapLayer

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members ComponentBase.OnInitializedAsync()ComponentBase.OnParametersSetAsync()ComponentBase.StateHasChanged()ComponentBase.ShouldRender()ComponentBase.OnAfterRenderAsync(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)ComponentBase.DispatchExceptionAsync(Exception)ComponentBase.SetParametersAsync(ParameterView)

Constructors

MapLayer()

Declaration

cs-api-definition
public MapLayer()

Properties

Attribution

The attribution for the layer. Accepts valid HTML.

Declaration

cs-api-definition
[Parameter]
public string Attribution { get; set; }

Property Value

string

ChildContent

Defines the settings and configuration for how data is displayed on this map layer. Use this to specify marker settings, shape styling, or bubble visualization options for the layer's data. Children: MapLayerMarkerSettings, MapLayerShapeSettings, MapLayerBubbleSettings.

Declaration

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

Property Value

RenderFragment

Data

Specifies the data of the layer.

Declaration

cs-api-definition
[Parameter]
public object Data { get; set; }

Property Value

object

Extent

Specifies the extent of the region covered by this layer. The layer will be hidden when the specified area is out of view.Accepts a four-element array that specifies the extent covered by this layer: North-West lat, longitude, South-East latitude, longitude.If not specified, the layer is always visible.

Declaration

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

Property Value

double[]

LocationField

The data item field which contains the marker (symbol) location. The field should be an array with two numbers - latitude and longitude in decimal degrees.Requires the dataSource option to be set.Only applicable to "marker" and "bubble" layers.

Declaration

cs-api-definition
[Parameter]
public string LocationField { get; set; }

Property Value

string

MaxSize

The maximum symbol size for bubble layer symbols.

Declaration

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

Property Value

double?

MaxZoom

The maximum zoom level at which to show this layer.

Declaration

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

Property Value

double?

MinSize

The minimum symbol size for bubble layer symbols.

Declaration

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

Property Value

double?

MinZoom

The minimum zoom level at which to show this layer.

Declaration

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

Property Value

double?

Opacity

The the opacity for the layer.

Declaration

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

Property Value

double?

Shape

The marker shape for marker layers.

Declaration

cs-api-definition
[Parameter]
public MapMarkersShape? Shape { get; set; }

Property Value

MapMarkersShape?

Subdomains

A list of subdomains to use for loading tiles. Alternating between different subdomains allows more requests to be executed in parallel.

Declaration

cs-api-definition
[Parameter]
public string[] Subdomains { get; set; }

Property Value

string[]

Symbol

The default symbol for bubble layers.

Declaration

cs-api-definition
[Parameter]
public MapLayersSymbol? Symbol { get; set; }

Property Value

MapLayersSymbol?

TileSize

The size of the image tile in pixels.

Declaration

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

Property Value

double?

TitleField

The data item field which contains the marker title. Requires the dataSource option to be set.

Declaration

cs-api-definition
[Parameter]
public string TitleField { get; set; }

Property Value

string

Type

The type of the layer.

Declaration

cs-api-definition
[Parameter]
public MapLayersType? Type { get; set; }

Property Value

MapLayersType?

UrlTemplate

The URL template for tile layers. Template variables: x - X coordinate of the tile; y - Y coordinate of the tile; zoom - zoom level or subdomain - Subdomain for this tile. See subdomains.

Declaration

cs-api-definition
[Parameter]
public string UrlTemplate { get; set; }

Property Value

string

ValueField

The value field for bubble layer symbols. The data item field should be a number.

Declaration

cs-api-definition
[Parameter]
public string ValueField { get; set; }

Property Value

string

ZIndex

The zIndex for this layer.Layers are normally stacked in declaration order (last one is on top).

Declaration

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

Property Value

double?

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

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

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

Dispose(bool)

Declaration

cs-api-definition
protected override void Dispose(bool disposing)

Parameters

disposing

bool

Overrides DataVizChildComponent.Dispose(bool)

OnAfterRender(bool)

Declaration

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

Parameters

firstRender

bool

Overrides ComponentBase.OnAfterRender(bool)

OnInitialized()

Declaration

cs-api-definition
protected override void OnInitialized()

Overrides DataVizChildComponent.OnInitialized()

OnParametersSet()

Declaration

cs-api-definition
protected override void OnParametersSet()

Overrides ComponentBase.OnParametersSet()