dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components.Layers
WMTSLayer Class
The WMTSLayer is used to create layers based on OGC Web Map Tile Services (WMTS).
ArcGIS Maps SDK for JavaScript
public class WMTSLayer : 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 🡒 WMTSLayer
Implements IBlendLayer, IMapComponent, IOperationalLayer, IPortalLayer, IRefreshableLayer, IScaleRangeLayer
Constructors
WMTSLayer() Constructor
Parameterless constructor for use as a Razor Component.
public WMTSLayer();
WMTSLayer(WMTSSublayer, string, Nullable, string, string, Dictionary<string,object>, Effect, Extent, Nullable, Nullable, Nullable, Nullable, Nullable, Nullable, PortalItem, Nullable, Nullable, IReadOnlyList, string, 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 WMTSLayer(dymaptic.GeoBlazor.Core.Components.WMTSSublayer? activeLayer=null, string? arcGISLayerId=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.BlendMode> blendMode=null, string? copyright=null, string? customLayerParameters=null, System.Collections.Generic.Dictionary<string,object>? customParameters=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.Nullable<dymaptic.GeoBlazor.Core.Enums.ServiceMode> serviceMode=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.WMTSSublayer>? sublayers=null, string? title=null, string? url=null, string? version=null, dymaptic.GeoBlazor.Core.Components.TimeExtent? visibilityTimeExtent=null, System.Nullable<bool> visible=null);
Parameters
activeLayer WMTSSublayer
Currently active sublayer.
ArcGIS Maps SDK for JavaScript
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
Copyright information for the WMTS service.
ArcGIS Maps SDK for JavaScript
customLayerParameters System.String
Use this to append different custom parameters to the WMTS tile requests.
ArcGIS Maps SDK for JavaScript
customParameters System.Collections.Generic.Dictionary<System.String,System.Object>
Use this to append custom parameters to all WMTS requests.
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
serviceMode System.Nullable<ServiceMode>
The service mode for the WMTS layer.
default “RESTful”
ArcGIS Maps SDK for JavaScript
sublayers System.Collections.Generic.IReadOnlyList<WMTSSublayer>
A collection of WMTSSublayer objects.
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
url System.String
The URL of the WMTS service.
ArcGIS Maps SDK for JavaScript
version System.String
Version of the WMTS specification to use.
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
WMTSLayer.ActiveLayer Property
Currently active sublayer.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.WMTSSublayer? ActiveLayer { get; set; }
Property Value
WMTSLayer.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.
default normal
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.BlendMode> BlendMode { get; set; }
Implements BlendMode
Property Value
WMTSLayer.Copyright Property
Copyright information for the WMTS service.
ArcGIS Maps SDK for JavaScript
public string? Copyright { get; set; }
Property Value
WMTSLayer.CustomLayerParameters Property
Use this to append different custom parameters to the WMTS tile requests.
ArcGIS Maps SDK for JavaScript
public string? CustomLayerParameters { get; set; }
Property Value
WMTSLayer.CustomParameters Property
Use this to append custom parameters to all WMTS requests.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.Dictionary<string,object>? CustomParameters { get; set; }
Property Value
System.Collections.Generic.Dictionary<System.String,System.Object>
WMTSLayer.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
WMTSLayer.MaxScale Property
The maximum scale (most zoomed in) at which the layer is visible in the view.
default 0
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> MaxScale { get; set; }
Implements MaxScale
Property Value
System.Nullable<System.Double>
WMTSLayer.MinScale Property
The minimum scale (most zoomed out) at which the layer is visible in the view.
default 0
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> MinScale { get; set; }
Implements MinScale
Property Value
System.Nullable<System.Double>
WMTSLayer.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
WMTSLayer.RefreshInterval Property
Refresh interval of the layer in minutes.
default 0
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> RefreshInterval { get; set; }
Implements RefreshInterval
Property Value
System.Nullable<System.Double>
WMTSLayer.ServiceMode Property
The service mode for the WMTS layer.
default “RESTful”
ArcGIS Maps SDK for JavaScript
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.ServiceMode> ServiceMode { get; set; }
Property Value
WMTSLayer.Sublayers Property
A collection of WMTSSublayer objects.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.WMTSSublayer>? Sublayers { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<WMTSSublayer>
WMTSLayer.Type Property
Used internally to identify the sub type of Layer
public override dymaptic.GeoBlazor.Core.Enums.LayerType Type { get; }
Property Value
WMTSLayer.Url Property
The URL of the WMTS service.
ArcGIS Maps SDK for JavaScript
public string? Url { get; set; }
Property Value
WMTSLayer.Version Property
Version of the WMTS specification to use.
ArcGIS Maps SDK for JavaScript
public string? Version { get; set; }
Property Value
Methods
WMTSLayer.AddToSublayers(WMTSSublayer[]) Method
Asynchronously adds elements to the Sublayers property.
public System.Threading.Tasks.Task AddToSublayers(params dymaptic.GeoBlazor.Core.Components.WMTSSublayer[] values);
Parameters
values WMTSSublayer[]
The elements to add.
Returns
WMTSLayer.GetActiveLayer() Method
Asynchronously retrieve the current value of the ActiveLayer property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.WMTSSublayer?> GetActiveLayer();
Returns
System.Threading.Tasks.Task<WMTSSublayer>
WMTSLayer.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>>
WMTSLayer.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>
WMTSLayer.GetCustomLayerParameters() Method
Asynchronously retrieve the current value of the CustomLayerParameters property.
public System.Threading.Tasks.Task<string?> GetCustomLayerParameters();
Returns
System.Threading.Tasks.Task<System.String>
WMTSLayer.GetCustomParameters() Method
Asynchronously retrieve the current value of the CustomParameters property.
public System.Threading.Tasks.Task<System.Collections.Generic.Dictionary<string,object>?> GetCustomParameters();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.Dictionary<System.String,System.Object>>
WMTSLayer.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>
WMTSLayer.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>>
WMTSLayer.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>>
WMTSLayer.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>
WMTSLayer.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>>
WMTSLayer.GetServiceMode() Method
Asynchronously retrieve the current value of the ServiceMode property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.ServiceMode>> GetServiceMode();
Returns
System.Threading.Tasks.Task<System.Nullable<ServiceMode>>
WMTSLayer.GetSublayers() Method
Asynchronously retrieve the current value of the Sublayers property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.WMTSSublayer>?> GetSublayers();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<WMTSSublayer>>
WMTSLayer.GetUrl() Method
Asynchronously retrieve the current value of the Url property.
public System.Threading.Tasks.Task<string?> GetUrl();
Returns
System.Threading.Tasks.Task<System.String>
WMTSLayer.GetVersion() Method
Asynchronously retrieve the current value of the Version property.
public System.Threading.Tasks.Task<string?> GetVersion();
Returns
System.Threading.Tasks.Task<System.String>
WMTSLayer.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
WMTSLayer.RemoveFromSublayers(WMTSSublayer[]) Method
Asynchronously remove an element from the Sublayers property.
public System.Threading.Tasks.Task RemoveFromSublayers(params dymaptic.GeoBlazor.Core.Components.WMTSSublayer[] values);
Parameters
values WMTSSublayer[]
The elements to remove.
Returns
WMTSLayer.SetActiveLayer(WMTSSublayer) Method
Asynchronously set the value of the ActiveLayer property after render.
public System.Threading.Tasks.Task SetActiveLayer(dymaptic.GeoBlazor.Core.Components.WMTSSublayer? value);
Parameters
value WMTSSublayer
The value to set.
Returns
WMTSLayer.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
WMTSLayer.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
WMTSLayer.SetCustomLayerParameters(string) Method
Asynchronously set the value of the CustomLayerParameters property after render.
public System.Threading.Tasks.Task SetCustomLayerParameters(string? value);
Parameters
value System.String
The value to set.
Returns
WMTSLayer.SetCustomParameters(Dictionary<string,object>) Method
Asynchronously set the value of the CustomParameters property after render.
public System.Threading.Tasks.Task SetCustomParameters(System.Collections.Generic.Dictionary<string,object>? value);
Parameters
value System.Collections.Generic.Dictionary<System.String,System.Object>
The value to set.
Returns
WMTSLayer.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
WMTSLayer.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
WMTSLayer.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
WMTSLayer.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
WMTSLayer.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
WMTSLayer.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
WMTSLayer.SetServiceMode(Nullable) Method
Asynchronously set the value of the ServiceMode property after render.
public System.Threading.Tasks.Task SetServiceMode(System.Nullable<dymaptic.GeoBlazor.Core.Enums.ServiceMode> value);
Parameters
value System.Nullable<ServiceMode>
The value to set.
Returns
WMTSLayer.SetSublayers(IReadOnlyList) Method
Asynchronously set the value of the Sublayers property after render.
public System.Threading.Tasks.Task SetSublayers(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.WMTSSublayer>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<WMTSSublayer>
The value to set.
Returns
WMTSLayer.SetUrl(string) Method
Asynchronously set the value of the Url property after render.
public System.Threading.Tasks.Task SetUrl(string? value);
Parameters
value System.String
The value to set.
Returns
WMTSLayer.SetVersion(string) Method
Asynchronously set the value of the Version property after render.
public System.Threading.Tasks.Task SetVersion(string? value);
Parameters
value System.String
The value to set.
Returns
WMTSLayer.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()