New to Telerik UI for ASP.NET MVC? Start a free 30-day trial

MapLayerBuilder

Class

Defines the fluent API for configuring the MapLayer settings.

Definition

Namespace:Kendo.Mvc.UI.Fluent

Assembly:Kendo.Mvc.dll

Syntax:

public class MapLayerBuilder

Inheritance: objectMapLayerBuilder

Inherited Members object.GetType()object.MemberwiseClone()object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()...

Methods

Attribution(string)

Defines the attribution for the layer. Accepts valid HTML.

public MapLayerBuilder Attribution(string value)

Parameters:valuestring

The value that configures the attribution.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add()
.Type(MapLayerType.Tile)
.UrlTemplate("https://#= subdomain #.tile.openstreetmap.org/#= zoom #/#= x #/#= y #.png")
.Attribution("&lt;a href='https://osm.org/copyright'&gt;OpenStreetMap contributors&lt;/a&gt;");
})
)

If set to "false", the layer will not bind to the DataSource during the initialization. In this case, the data binding will occur when the Change event of the DataSource fires. By default, the Map will bind to its DataSource.

public MapLayerBuilder AutoBind(bool value)

Parameters:valuebool

The value that configures the AutoBind option.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add()
.Type(MapLayerType.Marker)
.AutoBind(false)
.DataSource(dataSource =&gt; dataSource.Read(read =&gt; read.Action("_StoreLocations", "Map")))
);
})
)

Culture(string)

Defines the culture for the Bing map tiles.

public MapLayerBuilder Culture(string value)

Parameters:valuestring

The value that configures the culture.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add()
.Type(MapLayerType.Bing)
.Culture("de-DE");
})
)

DataSource(Action<MapLayerDataSourceBuilder>)

Defines the DataSource of the Map layer.

public MapLayerBuilder DataSource(Action<MapLayerDataSourceBuilder> configurator)

Parameters:configuratorAction<MapLayerDataSourceBuilder>

The action that configures of the DataSource settings.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add()
.Type(MapLayerType.Marker)
.DataSource(dataSource =&gt; dataSource.Read(read =&gt; read.Action("_StoreLocations", "Map")))
);
})
)

Extent(params double[])

Specifies the extent of the region covered by the 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 the: North-West latitude, longitude, South-East latitude, longitude. If not specified, the layer is always visible.

public MapLayerBuilder Extent(params double[] value)

Parameters:valuedouble[]

The value that configures the extent option.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add()
.Type(MapLayerType.Tile)
.Extent(new double[]{43.4350, 22.2556, 42.2265, 27.4850});
})
)

ImagerySet(MapLayersImagerySet)

Sets the type of tiles in the Bing Map.

public MapLayerBuilder ImagerySet(MapLayersImagerySet value)

Parameters:valueMapLayersImagerySet

The value that configures the type of the Bing map tiles.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add().Type(MapLayerType.Bing).ImagerySet(MapLayersImagerySet.AerialWithLabels);
})
)

Key(string)

Sets the API key for the layer. Currently, the option is supported only for Bing (tm) tile layers.

public MapLayerBuilder Key(string value)

Parameters:valuestring

The value that configures the API key.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add()
.Type(MapLayerType.Bing)
.Key("API key value");
})
)

LocationField(string)

Defines the data item field that contains the marker (symbol) location. The field must be an array with two numbers - latitude and longitude in decimal degrees. It is required to define a DataSource for the layer. The option is applicable only to Marker and Bubble layers.

public MapLayerBuilder LocationField(string value)

Parameters:valuestring

The value that configures the location field.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add()
.Type(MapLayerType.Marker)
.LocationField("LatLng")
.DataSource(dataSource =&gt; dataSource.Read(read =&gt; read.Action("_StoreLocations", "Map")))
);
})
)

MaxSize(double)

Sets the maximum symbol size for Bubble layer symbols.

public MapLayerBuilder MaxSize(double value)

Parameters:valuedouble

The value that configures the maximum symbol size.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add()
.Type(MapLayerType.Bubble)
.MaxSize(50)
.DataSource(dataSource =&gt; dataSource.Read(read =&gt; read.Action("_UrbanAreas", "Map")))
);
})
)

MaxZoom(double)

Sets the maximum zoom level at which to show the layer.

public MapLayerBuilder MaxZoom(double value)

Parameters:valuedouble

The value that configures the maximum zoom level.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add()
.Type(MapLayerType.Tile)
.MaxZoom(13);
})
)

MinSize(double)

Sets the minimum symbol size for the Bubble layer symbols.

public MapLayerBuilder MinSize(double value)

Parameters:valuedouble

The value that configures the minimum symbol size.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add()
.Type(MapLayerType.Bubble)
.MinSize(10)
.DataSource(dataSource =&gt; dataSource.Read(read =&gt; read.Action("_UrbanAreas", "Map")))
);
})
)

MinZoom(double)

Sets the minimum zoom level at which to show the layer.

public MapLayerBuilder MinZoom(double value)

Parameters:valuedouble

The value that configures the minimum zoom level.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add()
.Type(MapLayerType.Tile)
.MinZoom(14);
})
)

Opacity(double)

Defines the opacity for the layer.

public MapLayerBuilder Opacity(double value)

Parameters:valuedouble

The value that configures the opacity.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add()
.Type(MapLayerType.Tile)
.Opacity(1);
})
)

Shape(MapMarkersShape)

Sets the marker shape. The available shapes are "Pin" and "PinTarget".

public MapLayerBuilder Shape(MapMarkersShape value)

Parameters:valueMapMarkersShape

The enum value that configures the shape.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add().Shape(MapMarkersShape.PinTarget);
})
)

Shape(string)

Sets the marker shape. The available shapes are "pin" and "pinTarget".

public MapLayerBuilder Shape(string name)

Parameters:namestring

The name of the marker shape.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add().Shape("pin");
})
)

Style(Action<MapLayerStyleSettingsBuilder>)

Configures the default style for shapes.

public MapLayerBuilder Style(Action<MapLayerStyleSettingsBuilder> configurator)

Parameters:configuratorAction<MapLayerStyleSettingsBuilder>

The action that configures the style settings.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add()
.Type(MapLayerType.Shape)
.Style(style =&gt; style.Fill(fill =&gt; fill.Opacity(0.7)));
})
)

Subdomains(params string[])

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

public MapLayerBuilder Subdomains(params string[] subdomains)

Parameters:subdomainsstring[]

The array of subdomains

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add()
.Type(MapLayerType.Tile)
.UrlTemplate("https://#= subdomain #.tile.openstreetmap.org/#= zoom #/#= x #/#= y #.png")
.Subdomains("a", "b", "c");
})
)

Symbol(MapSymbol)

Defines the Bubble layer symbol type. The possible values are "Circle" and "Square".

public MapLayerBuilder Symbol(MapSymbol value)

Parameters:valueMapSymbol

The enum value that configures the symbol.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add()
.Type(MapLayerType.Bubble)
.Symbol(MapSymbol.Square);
})
)

Symbol(string)

Defines the Bubble layer symbol type. The possible values are "circle" and "square".

public MapLayerBuilder Symbol(string symbol)

Parameters:symbolstring

The value that configures the symbol type.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add()
.Type(MapLayerType.Bubble)
.Symbol("square");
})
)

SymbolHandler(string)

Sets a client-side function that will draw the Bubble layer symbol type.

public MapLayerBuilder SymbolHandler(string handler)

Parameters:handlerstring

The name of the JavaScript function that will draw the symbol.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add()
.Type(MapLayerType.Bubble)
.SymbolHandler("getSymbolType");
})
)
&lt;script&gt;
function getSymbolType(data) {
...//return kendo.drawing.Shape
}
&lt;/script&gt;

TileSize(double)

Sets the size of the image tile in pixels.

public MapLayerBuilder TileSize(double value)

Parameters:valuedouble

The value that configures the tile size.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add()
.Type(MapLayerType.Tile)
.TileSize(200);
})
)

TitleField(string)

Defines the data item field that contains the marker title. It is required to define a DataSource for the layer.

public MapLayerBuilder TitleField(string value)

Parameters:valuestring

The value that configures the title field.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add()
.Type(MapLayerType.Marker)
.TitleField("Name")
.DataSource(dataSource =&gt; dataSource.Read(read =&gt; read.Action("_StoreLocations", "Map")))
);
})
)

Configures the Tooltip component options for data-bound markers.

public MapLayerBuilder Tooltip(Action<MapMarkerTooltipBuilder> configurator)

Parameters:configuratorAction<MapMarkerTooltipBuilder>

The action that configures the tooltip settings.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add()
.Type(MapLayerType.Marker)
.Tooltip(tooltip =&gt; tooltip.Content("City X"));
})
)

Type(MapLayerType)

Defines the layer type.

public MapLayerBuilder Type(MapLayerType value)

Parameters:valueMapLayerType

The enum value that configures the type of the layer.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add().Type(MapLayerType.Tile);
})
)

UrlTemplate(string)

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

public MapLayerBuilder UrlTemplate(string value)

Parameters:valuestring

The value that configures the tile layer URL template.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add()
.Type(MapLayerType.Tile)
.UrlTemplate("https://#= subdomain #.tile.openstreetmap.org/#= zoom #/#= x #/#= y #.png");
})
)

UrlTemplate<TModel>(TemplateBuilder<TModel>)

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

public MapLayerBuilder UrlTemplate<TModel>(TemplateBuilder<TModel> template)

Parameters:templateTemplateBuilder<TModel>

A Template component that configures the urltemplate.

Returns:

MapLayerBuilder

UrlTemplateHandler(string)

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

public MapLayerBuilder UrlTemplateHandler(string value)

Parameters:valuestring

The value that configures the tile layer URL template.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add()
.Type(MapLayerType.Tile)
.UrlTemplateHandler("getUrlTemplate");
})
)
&lt;script&gt;
function getUrlTemplate(data) {
return `http://${data.subdomain}.tile.openstreetmap.org/${data.zoom}/${data.x}/${data.y}.png`;
}
&lt;/script&gt;

UrlTemplateId(string)

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

public MapLayerBuilder UrlTemplateId(string value)

Parameters:valuestring

The value that configures the tile layer URL template.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add()
.Type(MapLayerType.Tile)
.UrlTemplateId("urlMapTemplate");
})
)
&lt;script id="urlMapTemplate" type="text/x-kendo-template"&gt;
http://#= subdomain #.tile.openstreetmap.org/#= zoom #/#= x #/#= y #.png
&lt;/script&gt;

UrlTemplateView(MvcHtmlString)

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

public MapLayerBuilder UrlTemplateView(MvcHtmlString value)

Parameters:valueMvcHtmlString

The value that configures the tile layer URL template.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add()
.Type(MapLayerType.Tile)
.UrlTemplateView(Html.Partial("MapUrlTemplateView"));
})
)

ValueField(string)

Defines the value field for Bubble layer symbols. The data item field must be a number.

public MapLayerBuilder ValueField(string value)

Parameters:valuestring

The value that configures the value field.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add()
.Type(MapLayerType.Bubble)
.ValueField("Val")
.DataSource(dataSource =&gt; dataSource.Read(read =&gt; read.Action("_UrbanAreas", "Map")))
);
})
)

ZIndex(double)

Defines the z-index for the layer. The layers are normally stacked in a declaration order (the last one is on top).

public MapLayerBuilder ZIndex(double value)

Parameters:valuedouble

The value that configures the z-index of the layer.

Returns:

MapLayerBuilder

Example:

@(Html.Kendo().Map()
.Name("map")
.Layers(layers =&gt;
{
layers.Add()
.Type(MapLayerType.Tile)
.ZIndex(1);
})
)

MapLayerBuilder

Definition

Constructors