dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components.Layers
WebTileLayer Class
WebTileLayer provides a simple way to add non-ArcGIS Server map tiles as a layer to a map.
ArcGIS Maps SDK for JavaScript
public class WebTileLayer : dymaptic.GeoBlazor.Core.Components.Layers.Layer,
dymaptic.GeoBlazor.Core.Interfaces.IBlendLayer,
dymaptic.GeoBlazor.Core.Interfaces.IMapComponent,
dymaptic.GeoBlazor.Core.Interfaces.IOperationalLayer,
dymaptic.GeoBlazor.Core.Interfaces.IPortalLayer,
dymaptic.GeoBlazor.Core.Interfaces.IRefreshableLayer,
dymaptic.GeoBlazor.Core.Interfaces.IScaleRangeLayer
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Layer 🡒 WebTileLayer
Derived
↳ OpenStreetMapLayer
Implements IBlendLayer, IMapComponent, IOperationalLayer, IPortalLayer, IRefreshableLayer, IScaleRangeLayer
Constructors
WebTileLayer() Constructor
Parameterless constructor for use as a Razor Component.
public WebTileLayer();
WebTileLayer(string, Nullable, string, Effect, Extent, Nullable, Nullable, Nullable, Nullable, Nullable, Nullable, PortalItem, Nullable, IReadOnlyList, TileInfo, string, string, TimeExtent, Nullable) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public WebTileLayer(string? arcGISLayerId=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.BlendMode> blendMode=null, string? copyright=null, dymaptic.GeoBlazor.Core.Model.Effect? effect=null, dymaptic.GeoBlazor.Core.Components.Geometries.Extent? fullExtent=null, System.Nullable<bool> isBasemapReferenceLayer=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.ListMode> listMode=null, System.Nullable<double> maxScale=null, System.Nullable<double> minScale=null, System.Nullable<double> opacity=null, System.Nullable<bool> persistenceEnabled=null, dymaptic.GeoBlazor.Core.Components.PortalItem? portalItem=null, System.Nullable<double> refreshInterval=null, System.Collections.Generic.IReadOnlyList<string>? subDomains=null, dymaptic.GeoBlazor.Core.Components.TileInfo? tileInfo=null, string? title=null, string? urlTemplate=null, dymaptic.GeoBlazor.Core.Components.TimeExtent? visibilityTimeExtent=null, System.Nullable<bool> visible=null);
Parameters
arcGISLayerId System.String
The unique ID assigned to the layer.
ArcGIS Maps SDK for JavaScript
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
ArcGIS Maps SDK for JavaScript
copyright System.String
The attribution information for the layer.
ArcGIS Maps SDK for JavaScript
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
ArcGIS Maps SDK for JavaScript
fullExtent Extent
The full extent of the layer.
ArcGIS Maps SDK for JavaScript
isBasemapReferenceLayer System.Nullable<System.Boolean>
Indicates whether the layer is a basemap reference layer. Default value: false.
listMode System.Nullable<ListMode>
Indicates how the layer should display in the LayerList widget.
default “show”
ArcGIS Maps SDK for JavaScript
maxScale System.Nullable<System.Double>
The maximum scale (most zoomed in) at which the layer is visible in the view.
default 0
ArcGIS Maps SDK for JavaScript
minScale System.Nullable<System.Double>
The minimum scale (most zoomed out) at which the layer is visible in the view.
default 0
ArcGIS Maps SDK for JavaScript
opacity System.Nullable<System.Double>
The opacity of the layer.
default 1
ArcGIS Maps SDK for JavaScript
persistenceEnabled System.Nullable<System.Boolean>
Enable persistence of the layer in a WebMap or WebScene.
default true
ArcGIS Maps SDK for JavaScript
portalItem PortalItem
The portal item from which the layer is loaded.
ArcGIS Maps SDK for JavaScript
refreshInterval System.Nullable<System.Double>
Refresh interval of the layer in minutes.
default 0
ArcGIS Maps SDK for JavaScript
subDomains System.Collections.Generic.IReadOnlyList<System.String>
A string of subDomain names where tiles are served to speed up tile retrieval.
ArcGIS Maps SDK for JavaScript
tileInfo TileInfo
The tiling scheme information for the layer.
ArcGIS Maps SDK for JavaScript
title System.String
The title of the layer used to identify it in places such as the LayerList widget.
ArcGIS Maps SDK for JavaScript
urlTemplate System.String
The url template is a string that specifies the URL of the hosted tile images to load.
ArcGIS Maps SDK for JavaScript
visibilityTimeExtent TimeExtent
Specifies a fixed time extent during which a layer should be visible.
default null
ArcGIS Maps SDK for JavaScript
visible System.Nullable<System.Boolean>
Indicates if the layer is visible in the View.
default true
ArcGIS Maps SDK for JavaScript
Properties
WebTileLayer.BlendMode Property
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.
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.BlendMode> BlendMode { get; set; }
Implements BlendMode
Property Value
WebTileLayer.Copyright Property
The attribution information for the layer.
public string? Copyright { get; set; }
Property Value
WebTileLayer.Effect Property
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
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Model.Effect? Effect { get; set; }
Implements Effect
Property Value
WebTileLayer.HasRefreshListener Property
Used in JavaScript layer to determine if the event listener is registered.
public bool HasRefreshListener { get; }
Property Value
WebTileLayer.MaxScale Property
The maximum scale (most zoomed in) at which the layer is visible in the view.
public System.Nullable<double> MaxScale { get; set; }
Implements MaxScale
Property Value
System.Nullable<System.Double>
WebTileLayer.MinScale Property
The minimum scale (most zoomed out) at which the layer is visible in the view.
public System.Nullable<double> MinScale { get; set; }
Implements MinScale
Property Value
System.Nullable<System.Double>
WebTileLayer.OnRefresh Property
Fires if the layer has the refreshInterval set or when refresh() method is called.
The event payload indicates if the layer’s data has changed.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Events.RefreshEvent> OnRefresh { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<RefreshEvent>
WebTileLayer.PortalItem Property
The portal item from which the layer is loaded.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.PortalItem? PortalItem { get; set; }
Implements PortalItem
Property Value
WebTileLayer.RefreshInterval Property
Refresh interval of the layer in minutes.
public System.Nullable<double> RefreshInterval { get; set; }
Implements RefreshInterval
Property Value
System.Nullable<System.Double>
WebTileLayer.SpatialReference Property
The spatial reference of the layer.
default SpatialReference.WebMercator // wkid: 3857
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.SpatialReference? SpatialReference { get; set; }
Property Value
WebTileLayer.SubDomains Property
A string of subDomain names where tiles are served to speed up tile retrieval. If subDomains are specified, the UrlTemplate should include a {subDomain} place holder.
public System.Collections.Generic.IReadOnlyList<string>? SubDomains { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<System.String>
WebTileLayer.TileInfo Property
The tiling scheme information for the layer.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.TileInfo? TileInfo { get; set; }
Property Value
WebTileLayer.TileServers Property
The list of tile server urls for the layer.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<string>? TileServers { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<System.String>
WebTileLayer.Type Property
Used internally to identify the sub type of Layer
public override dymaptic.GeoBlazor.Core.Enums.LayerType Type { get; }
Property Value
WebTileLayer.UrlTemplate Property
The url template is a string that specifies the URL of the hosted tile images to load. The url template resembles an absolute URL but with a number of placeholder strings that the source evaluates to decide which tiles to load.
public string? UrlTemplate { get; set; }
Property Value
Remarks
The url template can follow a pattern of https://some.domain.com/{level}/{col}/{row}/ where level corresponds to a zoom level, and column and row represent a tile column and row, respectively. It can also follow a pattern of https://some.domain.com/{z}/{x}/{y}/ where z corresponds to a zoom level, and x and y represent a tile location along x and y axis. The urlTemplate should contain a {subDomain} place holder if subDomains are specified.
Methods
WebTileLayer.AddToSubDomains(string[]) Method
Asynchronously adds elements to the SubDomains property.
public System.Threading.Tasks.Task AddToSubDomains(params string[] values);
Parameters
values System.String[]
The elements to add.
Returns
WebTileLayer.GetBlendMode() Method
Asynchronously retrieve the current value of the BlendMode property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.BlendMode>> GetBlendMode();
Implements GetBlendMode()
Returns
System.Threading.Tasks.Task<System.Nullable<BlendMode>>
WebTileLayer.GetCopyright() Method
Asynchronously retrieve the current value of the Copyright property.
public System.Threading.Tasks.Task<string?> GetCopyright();
Returns
System.Threading.Tasks.Task<System.String>
WebTileLayer.GetEffect() Method
Asynchronously retrieve the current value of the Effect property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.Effect?> GetEffect();
Implements GetEffect()
Returns
System.Threading.Tasks.Task<Effect>
WebTileLayer.GetMaxScale() Method
Asynchronously retrieve the current value of the MaxScale property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetMaxScale();
Implements GetMaxScale()
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
WebTileLayer.GetMinScale() Method
Asynchronously retrieve the current value of the MinScale property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetMinScale();
Implements GetMinScale()
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
WebTileLayer.GetPortalItem() Method
Asynchronously retrieve the current value of the PortalItem property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.PortalItem?> GetPortalItem();
Implements GetPortalItem()
Returns
System.Threading.Tasks.Task<PortalItem>
WebTileLayer.GetRefreshInterval() Method
Asynchronously retrieve the current value of the RefreshInterval property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetRefreshInterval();
Implements GetRefreshInterval()
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
WebTileLayer.GetSpatialReference() Method
Asynchronously retrieve the current value of the SpatialReference property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.SpatialReference?> GetSpatialReference();
Returns
System.Threading.Tasks.Task<SpatialReference>
WebTileLayer.GetSubDomains() Method
Asynchronously retrieve the current value of the SubDomains property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<string>?> GetSubDomains();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<System.String>>
WebTileLayer.GetTileInfo() Method
Asynchronously retrieve the current value of the TileInfo property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.TileInfo?> GetTileInfo();
Returns
System.Threading.Tasks.Task<TileInfo>
WebTileLayer.GetTileServers() Method
Asynchronously retrieve the current value of the TileServers property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<string>?> GetTileServers();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<System.String>>
WebTileLayer.GetUrlTemplate() Method
Asynchronously retrieve the current value of the UrlTemplate property.
public System.Threading.Tasks.Task<string?> GetUrlTemplate();
Returns
System.Threading.Tasks.Task<System.String>
WebTileLayer.OnJsRefresh(IJSStreamReference) Method
JavaScript-Invokable Method for internal use only.
public System.Threading.Tasks.Task OnJsRefresh(Microsoft.JSInterop.IJSStreamReference jsStreamRef);
Parameters
jsStreamRef Microsoft.JSInterop.IJSStreamReference
Returns
WebTileLayer.Refresh() Method
Fetches all the data for the layer.
ArcGIS Maps SDK for JavaScript
public override System.Threading.Tasks.ValueTask Refresh();
Implements Refresh()
Returns
System.Threading.Tasks.ValueTask
WebTileLayer.RemoveFromSubDomains(string[]) Method
Asynchronously remove an element from the SubDomains property.
public System.Threading.Tasks.Task RemoveFromSubDomains(params string[] values);
Parameters
values System.String[]
The elements to remove.
Returns
WebTileLayer.SetBlendMode(Nullable) Method
Asynchronously set the value of the BlendMode property after render.
public System.Threading.Tasks.Task SetBlendMode(System.Nullable<dymaptic.GeoBlazor.Core.Enums.BlendMode> value);
Parameters
value System.Nullable<BlendMode>
The value to set.
Implements SetBlendMode(Nullable<BlendMode>)
Returns
WebTileLayer.SetCopyright(string) Method
Asynchronously set the value of the Copyright property after render.
public System.Threading.Tasks.Task SetCopyright(string? value);
Parameters
value System.String
The value to set.
Returns
WebTileLayer.SetEffect(Effect) Method
Asynchronously set the value of the Effect property after render.
public System.Threading.Tasks.Task SetEffect(dymaptic.GeoBlazor.Core.Model.Effect? value);
Parameters
value Effect
The value to set.
Implements SetEffect(Effect)
Returns
WebTileLayer.SetMaxScale(Nullable) Method
Asynchronously set the value of the MaxScale property after render.
public System.Threading.Tasks.Task SetMaxScale(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Implements SetMaxScale(Nullable<double>)
Returns
WebTileLayer.SetMinScale(Nullable) Method
Asynchronously set the value of the MinScale property after render.
public System.Threading.Tasks.Task SetMinScale(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Implements SetMinScale(Nullable<double>)
Returns
WebTileLayer.SetPersistenceEnabled(Nullable) Method
Asynchronously set the value of the PersistenceEnabled property after render.
public System.Threading.Tasks.Task SetPersistenceEnabled(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Implements SetPersistenceEnabled(Nullable<bool>)
Returns
WebTileLayer.SetPortalItem(PortalItem) Method
Asynchronously set the value of the PortalItem property after render.
public System.Threading.Tasks.Task SetPortalItem(dymaptic.GeoBlazor.Core.Components.PortalItem? value);
Parameters
value PortalItem
The value to set.
Implements SetPortalItem(PortalItem)
Returns
WebTileLayer.SetRefreshInterval(Nullable) Method
Asynchronously set the value of the RefreshInterval property after render.
public System.Threading.Tasks.Task SetRefreshInterval(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Implements SetRefreshInterval(Nullable<double>)
Returns
WebTileLayer.SetSubDomains(IReadOnlyList) Method
Asynchronously set the value of the SubDomains property after render.
public System.Threading.Tasks.Task SetSubDomains(System.Collections.Generic.IReadOnlyList<string>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<System.String>
The value to set.
Returns
WebTileLayer.SetTileInfo(TileInfo) Method
Asynchronously set the value of the TileInfo property after render.
public System.Threading.Tasks.Task SetTileInfo(dymaptic.GeoBlazor.Core.Components.TileInfo? value);
Parameters
value TileInfo
The value to set.
Returns
WebTileLayer.SetUrlTemplate(string) Method
Asynchronously set the value of the UrlTemplate property after render.
public System.Threading.Tasks.Task SetUrlTemplate(string? value);
Parameters
value System.String
The value to set.
Returns
WebTileLayer.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()