dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components.Layers
BaseTileLayer Class
This class may be extended to create a custom TileLayer.
ArcGIS Maps SDK for JavaScript
public class BaseTileLayer : dymaptic.GeoBlazor.Core.Components.Layers.Layer,
dymaptic.GeoBlazor.Core.Interfaces.IBlendLayer,
dymaptic.GeoBlazor.Core.Interfaces.IMapComponent,
dymaptic.GeoBlazor.Core.Interfaces.IRefreshableLayer,
dymaptic.GeoBlazor.Core.Interfaces.IScaleRangeLayer
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Layer 🡒 BaseTileLayer
Derived
↳ BingMapsLayer
Implements IBlendLayer, IMapComponent, IRefreshableLayer, IScaleRangeLayer
Constructors
BaseTileLayer() Constructor
Parameterless constructor for use as a Razor Component.
public BaseTileLayer();
BaseTileLayer(Nullable, Effect, Nullable, Nullable, Nullable, SpatialReference, string, Extent, Nullable, Nullable, Nullable, TileInfo, 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 BaseTileLayer(System.Nullable<dymaptic.GeoBlazor.Core.Enums.BlendMode> blendMode=null, dymaptic.GeoBlazor.Core.Model.Effect? effect=null, System.Nullable<double> maxScale=null, System.Nullable<double> minScale=null, System.Nullable<double> refreshInterval=null, dymaptic.GeoBlazor.Core.Components.SpatialReference? spatialReference=null, string? arcGISLayerId=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> opacity=null, dymaptic.GeoBlazor.Core.Components.TileInfo? tileInfo=null, string? title=null, dymaptic.GeoBlazor.Core.Components.TimeExtent? visibilityTimeExtent=null, System.Nullable<bool> visible=null);
Parameters
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
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
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
refreshInterval System.Nullable<System.Double>
Refresh interval of the layer in minutes.
default 0
ArcGIS Maps SDK for JavaScript
spatialReference SpatialReference
The spatial reference of the layer.
default SpatialReference.WebMercatorArcGIS Maps SDK for JavaScript
arcGISLayerId System.String
The unique ID assigned to the layer.
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
opacity System.Nullable<System.Double>
The opacity of the layer.
default 1
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
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
BaseTileLayer.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. Unlike the method of using transparency which can result in a washed-out top layer, blend modes can create a variety of very vibrant and intriguing results by blending a layer with the layer(s) below it.
public System.Nullable<dymaptic.GeoBlazor.Core.Enums.BlendMode> BlendMode { get; set; }
Implements BlendMode
Property Value
BaseTileLayer.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. This powerful capability allows you to apply css filter-like functions to layers to create custom visual effects to enhance the cartographic quality of your maps. This is done by applying the desired effect to the layer’s effect property as a string or an array of objects to set scale dependent effects.
public dymaptic.GeoBlazor.Core.Model.Effect? Effect { get; set; }
Implements Effect
Property Value
BaseTileLayer.HasRefreshListener Property
Used in JavaScript layer to determine if the event listener is registered.
public bool HasRefreshListener { get; }
Property Value
BaseTileLayer.MaxScale Property
The maximum scale (most zoomed in) at which the layer is visible in the view. If the map is zoomed in beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a maximum scale. The maxScale value should always be smaller than the minScale value, and greater than or equal to the service specification.
Default Value: 0
public System.Nullable<double> MaxScale { get; set; }
Implements MaxScale
Property Value
System.Nullable<System.Double>
BaseTileLayer.MinScale Property
The minimum scale (most zoomed out) at which the layer is visible in the view. If the map is zoomed out beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a minimum scale. The minScale value should always be larger than the maxScale value, and less than or equal to the service specification.
Default Value: 0
public System.Nullable<double> MinScale { get; set; }
Implements MinScale
Property Value
System.Nullable<System.Double>
BaseTileLayer.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>
BaseTileLayer.RefreshInterval Property
Refresh interval of the layer in minutes. Value of 0 indicates no refresh.
Default Value:0
public System.Nullable<double> RefreshInterval { get; set; }
Implements RefreshInterval
Property Value
System.Nullable<System.Double>
BaseTileLayer.SpatialReference Property
The spatial reference of the layer.
default SpatialReference.WebMercatorArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.SpatialReference? SpatialReference { get; set; }
Property Value
BaseTileLayer.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
BaseTileLayer.Type Property
Used internally to identify the sub type of Layer
public override dymaptic.GeoBlazor.Core.Enums.LayerType Type { get; }
Property Value
Methods
BaseTileLayer.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>>
BaseTileLayer.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>
BaseTileLayer.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>>
BaseTileLayer.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>>
BaseTileLayer.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>>
BaseTileLayer.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>
BaseTileLayer.GetTileBounds(int, int, int) Method
Returns the bounds of the tile as an array of four numbers that be readily converted to an Extent object.
public System.Threading.Tasks.Task<double[]> GetTileBounds(int level, int row, int col);
Parameters
level System.Int32
The level of detail (LOD) of the tile.
row System.Int32
The tile’s row (y) position in the dataset.
col System.Int32
The tile’s column (x) position in the dataset.
Returns
System.Threading.Tasks.Task<System.Double[]>
Returns an array with the following structure: [xmin, ymin, xmax, ymax]
BaseTileLayer.GetTileBoundsAsExtent(int, int, int) Method
Returns the bounds of the tile as an Extent object.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Geometries.Extent> GetTileBoundsAsExtent(int level, int row, int col);
Parameters
level System.Int32
The level of detail (LOD) of the tile.
row System.Int32
The tile’s row (y) position in the dataset.
col System.Int32
The tile’s column (x) position in the dataset.
Returns
System.Threading.Tasks.Task<Extent>
BaseTileLayer.GetTileInfo() Method
Retrieves the tiling scheme information for the layer.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.TileInfo?> GetTileInfo();
Returns
System.Threading.Tasks.Task<TileInfo>
BaseTileLayer.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
BaseTileLayer.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
BaseTileLayer.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
BaseTileLayer.SetEffect(Effect) Method
Changes the current effect on the layer.
public System.Threading.Tasks.Task SetEffect(dymaptic.GeoBlazor.Core.Model.Effect? effect);
Parameters
effect Effect
The effect to apply to the layer.
Implements SetEffect(Effect)
Returns
BaseTileLayer.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
BaseTileLayer.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
BaseTileLayer.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
BaseTileLayer.SetSpatialReference(SpatialReference) Method
Asynchronously set the value of the SpatialReference property after render.
public System.Threading.Tasks.Task SetSpatialReference(dymaptic.GeoBlazor.Core.Components.SpatialReference? value);
Parameters
value SpatialReference
The value to set.
Returns
BaseTileLayer.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
BaseTileLayer.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()