dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components.Layers

OpenStreetMapLayer Class

<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Core.Components.Layers.OpenStreetMapLayer.html”>GeoBlazor Docs</a> Allows you to use <a target=”_blank” href=”http://wiki.openstreetmap.org/wiki/List_of_OSM-based_services”>basemaps</a> from <a target=”_blank” href=”http://www.openstreetmap.org/”>OpenStreetMap</a>. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OpenStreetMapLayer.html”>ArcGIS Maps SDK for JavaScript</a>

public class OpenStreetMapLayer : dymaptic.GeoBlazor.Core.Components.Layers.WebTileLayer

Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Layer 🡒 WebTileLayer 🡒 OpenStreetMapLayer

Constructors

OpenStreetMapLayer() Constructor

Parameterless constructor for use as a Razor Component.

public OpenStreetMapLayer();

OpenStreetMapLayer(PortalItem, string, Nullable<BlendMode>, string, Nullable<double>, Nullable<double>, Nullable<double>, IReadOnlyList<string>, TileInfo, Nullable<double>, Nullable<bool>, Nullable<ListMode>, string, Effect, Extent, Nullable<bool>, Nullable<bool>, string, TimeExtent) Constructor

Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.

public OpenStreetMapLayer(dymaptic.GeoBlazor.Core.Components.PortalItem? portalItem=null, string? title=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.BlendMode> blendMode=null, string? copyright=null, System.Nullable<double> maxScale=null, System.Nullable<double> minScale=null, System.Nullable<double> refreshInterval=null, System.Collections.Generic.IReadOnlyList<string>? subDomains=null, dymaptic.GeoBlazor.Core.Components.TileInfo? tileInfo=null, System.Nullable<double> opacity=null, System.Nullable<bool> visible=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.ListMode> listMode=null, string? arcGISLayerId=null, dymaptic.GeoBlazor.Core.Model.Effect? effect=null, dymaptic.GeoBlazor.Core.Components.Geometries.Extent? fullExtent=null, System.Nullable<bool> isBasemapReferenceLayer=null, System.Nullable<bool> persistenceEnabled=null, string? urlTemplate=null, dymaptic.GeoBlazor.Core.Components.TimeExtent? visibilityTimeExtent=null);

Parameters

portalItem PortalItem

The portal item from which the layer is loaded. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#portalItem”>ArcGIS Maps SDK for JavaScript</a>

title System.String

The title of the layer used to identify it in places such as the <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html”>LayerList</a> widget. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#title”>ArcGIS Maps SDK for JavaScript</a>

blendMode System.Nullable<BlendMode>

Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer. default normal <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-BlendLayer.html#blendMode”>ArcGIS Maps SDK for JavaScript</a>

copyright System.String

The attribution information for the layer. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#copyright”>ArcGIS Maps SDK for JavaScript</a>

maxScale System.Nullable<System.Double>

The maximum scale (most zoomed in) at which the layer is visible in the view. default 0 <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ScaleRangeLayer.html#maxScale”>ArcGIS Maps SDK for JavaScript</a>

minScale System.Nullable<System.Double>

The minimum scale (most zoomed out) at which the layer is visible in the view. default 0 <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-ScaleRangeLayer.html#minScale”>ArcGIS Maps SDK for JavaScript</a>

refreshInterval System.Nullable<System.Double>

Refresh interval of the layer in minutes. default 0 <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-RefreshableLayer.html#refreshInterval”>ArcGIS Maps SDK for JavaScript</a>

subDomains System.Collections.Generic.IReadOnlyList<System.String>

A string of subDomain names where tiles are served to speed up tile retrieval. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#subDomains”>ArcGIS Maps SDK for JavaScript</a>

tileInfo TileInfo

The tiling scheme information for the layer. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#tileInfo”>ArcGIS Maps SDK for JavaScript</a>

opacity System.Nullable<System.Double>

The opacity of the layer. default 1 <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#opacity”>ArcGIS Maps SDK for JavaScript</a>

visible System.Nullable<System.Boolean>

Indicates if the layer is visible in the <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html”>View</a>. default true <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#visible”>ArcGIS Maps SDK for JavaScript</a>

listMode System.Nullable<ListMode>

Indicates how the layer should display in the <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html”>LayerList</a> widget. default “show” <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#listMode”>ArcGIS Maps SDK for JavaScript</a>

arcGISLayerId System.String

The unique ID assigned to the layer. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#id”>ArcGIS Maps SDK for JavaScript</a>

effect Effect

Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to how image filters work. default null <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#effect”>ArcGIS Maps SDK for JavaScript</a>

fullExtent Extent

The full extent of the layer. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#fullExtent”>ArcGIS Maps SDK for JavaScript</a>

isBasemapReferenceLayer System.Nullable<System.Boolean>

Indicates whether the layer is a basemap reference layer. Default value: false.

persistenceEnabled System.Nullable<System.Boolean>

Enable persistence of the layer in a <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html”>WebMap</a> or <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html”>WebScene</a>. default true <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-mixins-OperationalLayer.html#persistenceEnabled”>ArcGIS Maps SDK for JavaScript</a>

urlTemplate System.String

The url template is a string that specifies the URL of the hosted tile images to load. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WebTileLayer.html#urlTemplate”>ArcGIS Maps SDK for JavaScript</a>

visibilityTimeExtent TimeExtent

Specifies a fixed <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-time-TimeExtent.html”>time extent</a> during which a layer should be visible. default null <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html#visibilityTimeExtent”>ArcGIS Maps SDK for JavaScript</a>

Properties

OpenStreetMapLayer.Type Property

Used internally to identify the sub type of Layer

public override dymaptic.GeoBlazor.Core.Enums.LayerType Type { get; }

Property Value

LayerType

Methods

OpenStreetMapLayer.SetFullExtent(Extent) Method

SetFullExtent is not supported for OpenStreetMapLayer.

public override System.Threading.Tasks.Task SetFullExtent(dymaptic.GeoBlazor.Core.Components.Geometries.Extent? extent);

Parameters

extent Extent

Returns

System.Threading.Tasks.Task

Exceptions

System.NotSupportedException