layout: default title: Layer parent: Core Classes —
dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components.Layers
Layer Class
The layer is the most fundamental component of a Map. It is a collection of spatial data in the form of vector
graphics or raster images that represent real-world phenomena. Layers may contain discrete features that store
vector data or continuous cells/pixels that store raster data.
ArcGIS Maps SDK for JavaScript
public abstract class Layer : dymaptic.GeoBlazor.Core.Components.MapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Layer
Derived
↳ BaseTileLayer
↳ CSVLayer
↳ ElevationLayer
↳ FeatureLayer
↳ GeoJSONLayer
↳ GeoRSSLayer
↳ GraphicsLayer
↳ ImageryLayer
↳ ImageryTileLayer
↳ KMLLayer
↳ MapImageLayer
↳ TileLayer
↳ WCSLayer
↳ WebTileLayer
Fields
Layer.LayerChanged Field
Indicates if the layer has changed since the last render.
public bool LayerChanged;
Field Value
Properties
Layer.AbortManager Property
Handles conversion from .NET CancellationToken to JavaScript AbortController
public dymaptic.GeoBlazor.Core.Objects.AbortManager? AbortManager { get; set; }
Property Value
Layer.FullExtent Property
The full extent of the layer. By default, this is worldwide. This property may be used to set the extent of the
view to match a layer’s extent so that its features appear to fill the view.
public dymaptic.GeoBlazor.Core.Components.Geometries.Extent? FullExtent { get; set; }
Property Value
Layer.Imported Property
Marks an incoming layer loaded from a service or Javascript source.
public bool Imported { get; set; }
Property Value
Layer.IsBasemapReferenceLayer Property
If the layer is added to the Basemap, this flag identifies the layer as a reference layer,
which will sit on top of other layers to add labels.
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> IsBasemapReferenceLayer { get; set; }
Property Value
System.Nullable<System.Boolean>
Layer.JsLayerReference Property
The JavaScript object that represents the layer.
public Microsoft.JSInterop.IJSObjectReference? JsLayerReference { get; set; }
Property Value
Microsoft.JSInterop.IJSObjectReference
Layer.LayerType Property
Used internally to identify the sub type of Layer
public virtual string LayerType { get; }
Property Value
Layer.LayerView Property
Represents the view for a single layer after it has been added to either a MapView or a SceneView.
public dymaptic.GeoBlazor.Core.Components.Layers.LayerView? LayerView { get; set; }
Property Value
Layer.ListMode Property
Indicates how the layer should display in the LayerList widget. The possible values are listed below.
public System.Nullable<dymaptic.GeoBlazor.Core.Components.Layers.ListMode> ListMode { get; set; }
Property Value
Layer.Opacity Property
The opacity of the layer.
public System.Nullable<double> Opacity { get; set; }
Property Value
System.Nullable<System.Double>
Layer.PersistenceEnabled Property
Enable persistence of the layer in a WebMap or WebScene.
Default Value: true
public System.Nullable<bool> PersistenceEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
Layer.Title Property
The title of the layer used to identify it in places such as the Legend and LayerList widgets.
public string? Title { get; set; }
Property Value
Methods
Layer.DisposeAsync() Method
Implements the IAsyncDisposable pattern.
public override System.Threading.Tasks.ValueTask DisposeAsync();
Implements DisposeAsync()
Returns
System.Threading.Tasks.ValueTask
Layer.Load(CancellationToken) Method
Loads the resources referenced by this class. This method automatically executes for a View and all of the
resources it references in Map if the view is constructed with a map instance.
This method must be called by the developer when accessing a resource that will not be loaded in a View.
The load() method only triggers the loading of the resource the first time it is called. The subsequent calls
return the same promise.
public System.Threading.Tasks.Task Load(System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));
Parameters
cancellationToken System.Threading.CancellationToken
Returns
Remarks
It’s possible to provide a signal to stop being interested into a Loadable instance load status. When the signal is
aborted, the instance does not stop its loading process, only cancelLoad can abort it.
Layer.Refresh() Method
Provides a way to externally call StateHasChanged on the component.
public override void Refresh();
Layer.RegisterChildComponent(MapComponent) Method
Called from dymaptic.GeoBlazor.Core.Components.MapComponent.OnInitializedAsync to “Register” the current component with it’s parent.
public override System.Threading.Tasks.Task RegisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);
Parameters
child MapComponent
The calling, child component to register
Returns
Exceptions
InvalidChildElementException
Throws if the current child is not a valid sub-component to the parent.
Remarks
This method is an implementation detail and should not be called directly by consumers. In future versions, this may be changed to an internal method. If you see no other way to register a child component, please open an issue on GitHub.
Layer.SetProperty(string, object) Method
Sets any property to a new value after initial render. Supports all basic types (strings, numbers, booleans, dictionaries) and properties.
public System.Threading.Tasks.Task SetProperty(string propertyName, object? value);
Parameters
propertyName System.String
The name of the property to set.
value System.Object
The new value.
Returns
Layer.UnregisterChildComponent(MapComponent) Method
Undoes the “Registration” of a child with its parent.
public override System.Threading.Tasks.Task UnregisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);
Parameters
child MapComponent
The child to unregister
Returns
Remarks
This method is an implementation detail and should not be called directly by consumers. In future versions, this may be changed to an internal method.