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
JS API
</a>
public abstract class Layer : dymaptic.GeoBlazor.Core.Components.MapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Layer
Derived
↳ ElevationLayer
↳ FeatureLayer
↳ GeoJSONLayer
↳ GeoRSSLayer
↳ GraphicsLayer
↳ TileLayer
↳ WebTileLayer
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.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.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
Layer.Visible Property
Indicates if the layer is visible in the View. When false, the layer may still be added to a Map instance that is
referenced in a view, but its features will not be visible in the view.
public System.Nullable<bool> Visible { get; set; }
Property Value
System.Nullable<System.Boolean>
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.RegisterChildComponent(MapComponent) Method
Called from dymaptic.GeoBlazor.Core.Components.MapComponent.OnAfterRenderAsync(System.Boolean) 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.
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
Layer.ValidateRequiredChildren() Method
When a MapView is prepared to render, this will check to make sure that all properties with the
RequiredPropertyAttribute are provided.
public override void ValidateRequiredChildren();
Exceptions
MissingRequiredChildElementException
The consumer needs to provide the missing child component
MissingRequiredOptionsChildElementException
The consumer needs to provide ONE of the options of child components