dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components.Layers

Layer Class

The layer is the most fundamental component of a Map.
ArcGIS Maps SDK for JavaScript

public abstract class Layer : dymaptic.GeoBlazor.Core.Components.MapComponent,
dymaptic.GeoBlazor.Core.Interfaces.IHitTestItem,
dymaptic.GeoBlazor.Core.Interfaces.IMapComponent,
dymaptic.GeoBlazor.Core.Interfaces.IIntersectItem,
dymaptic.GeoBlazor.Core.Interfaces.ISliceViewModelExcludedLayers

Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Layer

Derived
BaseTileLayer
CSVLayer
FeatureLayer
GeoJSONLayer
GeoRSSLayer
GraphicsLayer
ImageryLayer
ImageryTileLayer
KMLLayer
MapImageLayer
TileLayer
UnknownLayer
UnsupportedLayer
VectorTileLayer
WCSLayer
WebTileLayer
WFSLayer
WMSLayer
WMTSLayer

Implements IHitTestItem, IMapComponent, IIntersectItem, ISliceViewModelExcludedLayers

Properties

Layer.ArcGISLayerId Property

The unique ID assigned to the layer.
ArcGIS Maps SDK for JavaScript

public string? ArcGISLayerId { get; set; }

Property Value

System.String

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.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.Geometries.Extent? FullExtent { get; set; }

Property Value

Extent

Layer.HasCreateErrorListener Property

Used in JavaScript layer to determine if the event listener is registered.

public bool HasCreateErrorListener { get; }

Property Value

System.Boolean

Layer.HasCreateListener Property

Used in JavaScript layer to determine if the event listener is registered.

public bool HasCreateListener { get; }

Property Value

System.Boolean

Layer.HasDestroyListener Property

Used in JavaScript layer to determine if the event listener is registered.

public bool HasDestroyListener { get; }

Property Value

System.Boolean

Layer.Imported Property

Marks an incoming layer loaded from a service or Javascript source.

public bool Imported { get; set; }

Property Value

System.Boolean

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.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.LayerView? LayerView { get; set; }

Property Value

LayerView

Layer.ListMode Property

Indicates how the layer should display in the LayerList widget.
default “show”
ArcGIS Maps SDK for JavaScript

public System.Nullable<dymaptic.GeoBlazor.Core.Enums.ListMode> ListMode { get; set; }

Property Value

System.Nullable<ListMode>

Layer.Loaded Property

Indicates whether the layer’s resources have loaded.
default false
ArcGIS Maps SDK for JavaScript

public System.Nullable<bool> Loaded { get; set; }

Property Value

System.Nullable<System.Boolean>

Layer.OnCreate Property

Fires after the layer’s LayerView is created and rendered in a view.

public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Events.LayerViewCreateEvent> OnCreate { get; set; }

Property Value

Microsoft.AspNetCore.Components.EventCallback<LayerViewCreateEvent>

Layer.OnCreateError Property

Fires when an error emits during the creation of a LayerView
after a layer has been added to the map.

public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Events.LayerViewCreateErrorEvent> OnCreateError { get; set; }

Property Value

Microsoft.AspNetCore.Components.EventCallback<LayerViewCreateErrorEvent>

Layer.OnDestroy Property

Fires after the layer’s LayerView is destroyed and no longer renders in a view.

public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Events.LayerViewDestroyEvent> OnDestroy { get; set; }

Property Value

Microsoft.AspNetCore.Components.EventCallback<LayerViewDestroyEvent>

Layer.Opacity Property

The opacity of the layer.
default 1
ArcGIS Maps SDK for JavaScript

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 true
ArcGIS Maps SDK for JavaScript

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.
ArcGIS Maps SDK for JavaScript

public string? Title { get; set; }

Property Value

System.String

Layer.Type Property

Used internally to identify the sub type of Layer

public abstract dymaptic.GeoBlazor.Core.Enums.LayerType Type { get; }

Property Value

LayerType

Layer.VisibilityTimeExtent Property

Specifies a fixed time extent during which a layer should be visible.
default null
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.TimeExtent? VisibilityTimeExtent { get; set; }

Property Value

TimeExtent

Methods

Layer.DisposeAsync() Method

Implements the IAsyncDisposable pattern.

public override System.Threading.Tasks.ValueTask DisposeAsync();

Implements DisposeAsync(), DisposeAsync()

Returns

System.Threading.Tasks.ValueTask

Layer.GetArcGISLayerId() Method

Asynchronously retrieve the current value of the ArcGISLayerId property.

public System.Threading.Tasks.Task<string?> GetArcGISLayerId();

Returns

System.Threading.Tasks.Task<System.String>

Layer.GetFullExtent() Method

Asynchronously retrieve the current value of the FullExtent property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Geometries.Extent?> GetFullExtent();

Returns

System.Threading.Tasks.Task<Extent>

Layer.GetListMode() Method

Asynchronously retrieve the current value of the ListMode property.

public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.ListMode>> GetListMode();

Returns

System.Threading.Tasks.Task<System.Nullable<ListMode>>

Layer.GetOpacity() Method

Asynchronously retrieve the current value of the Opacity property.

public System.Threading.Tasks.Task<System.Nullable<double>> GetOpacity();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Double>>

Layer.GetPersistenceEnabled() Method

Asynchronously retrieve the current value of the PersistenceEnabled property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetPersistenceEnabled();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

Layer.GetTitle() Method

Asynchronously retrieve the current value of the Title property.

public System.Threading.Tasks.Task<string?> GetTitle();

Returns

System.Threading.Tasks.Task<System.String>

Layer.GetVisibilityTimeExtent() Method

Asynchronously retrieve the current value of the VisibilityTimeExtent property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.TimeExtent?> GetVisibilityTimeExtent();

Returns

System.Threading.Tasks.Task<TimeExtent>

Layer.Load() 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();

Returns

System.Threading.Tasks.Task

Layer.Load(IJSRuntime, JsModuleManager, 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(Microsoft.JSInterop.IJSRuntime jsRuntime, dymaptic.GeoBlazor.Core.JsModuleManager jsModuleManager, System.Threading.CancellationToken cancellationToken);

Parameters

jsRuntime Microsoft.JSInterop.IJSRuntime

The dependency-injected Blazor IJSRuntime instance to connect to JavaScript.

jsModuleManager JsModuleManager

The dependency-injected GeoBlazor JsModuleManager instance to load JavaScript modules.

cancellationToken System.Threading.CancellationToken

A cancellation token to cancel the operation.

Returns

System.Threading.Tasks.Task

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);

Parameters

cancellationToken System.Threading.CancellationToken

Returns

System.Threading.Tasks.Task

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.OnJsComponentCreated(IJSObjectReference, IJSStreamReference) Method

For internal use, registration from JavaScript.

public override System.Threading.Tasks.ValueTask<dymaptic.GeoBlazor.Core.Components.MapComponent?> OnJsComponentCreated(Microsoft.JSInterop.IJSObjectReference jsComponentReference, Microsoft.JSInterop.IJSStreamReference jsonStreamReference);

Parameters

jsComponentReference Microsoft.JSInterop.IJSObjectReference

jsonStreamReference Microsoft.JSInterop.IJSStreamReference

Returns

System.Threading.Tasks.ValueTask<MapComponent>

Layer.OnJsCreate(IJSStreamReference) Method

JavaScript-Invokable Method for internal use only.

public System.Threading.Tasks.Task OnJsCreate(Microsoft.JSInterop.IJSStreamReference jsStreamRef);

Parameters

jsStreamRef Microsoft.JSInterop.IJSStreamReference

Returns

System.Threading.Tasks.Task

Layer.OnJsCreateError(IJSStreamReference) Method

JavaScript-Invokable Method for internal use only.

public System.Threading.Tasks.Task OnJsCreateError(Microsoft.JSInterop.IJSStreamReference jsStreamRef);

Parameters

jsStreamRef Microsoft.JSInterop.IJSStreamReference

Returns

System.Threading.Tasks.Task

Layer.OnJsDestroy(IJSStreamReference) Method

JavaScript-Invokable Method for internal use only.

public System.Threading.Tasks.Task OnJsDestroy(Microsoft.JSInterop.IJSStreamReference jsStreamRef);

Parameters

jsStreamRef Microsoft.JSInterop.IJSStreamReference

Returns

System.Threading.Tasks.Task

Layer.Refresh() Method

Provides a way to externally call StateHasChanged on the component.

public override System.Threading.Tasks.ValueTask Refresh();

Returns

System.Threading.Tasks.ValueTask

Layer.RegisterChildComponent(MapComponent) Method

Called from dymaptic.GeoBlazor.Core.Components.MapComponent.OnInitializedAsync to “Register” the current component with its parent.

public override System.Threading.Tasks.Task RegisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);

Parameters

child MapComponent

The calling, child component to register

Returns

System.Threading.Tasks.Task

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.SetArcGISLayerId(string) Method

Asynchronously set the value of the ArcGISLayerId property after render.

public System.Threading.Tasks.Task SetArcGISLayerId(string? value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

Layer.SetFullExtent(Extent) Method

Asynchronously set the value of the FullExtent property after render.

public virtual System.Threading.Tasks.Task SetFullExtent(dymaptic.GeoBlazor.Core.Components.Geometries.Extent? value);

Parameters

value Extent

Returns

System.Threading.Tasks.Task

Layer.SetListMode(Nullable) Method

Asynchronously set the value of the ListMode property after render.

public System.Threading.Tasks.Task SetListMode(System.Nullable<dymaptic.GeoBlazor.Core.Enums.ListMode> value);

Parameters

value System.Nullable<ListMode>

The value to set.

Returns

System.Threading.Tasks.Task

Layer.SetOpacity(double) Method

Asynchronously set the value of the Opacity property after render.

public System.Threading.Tasks.Task SetOpacity(double value);

Parameters

value System.Double

Returns

System.Threading.Tasks.Task

Layer.SetParametersAsync(ParameterView) Method

Sets parameters supplied by the component’s parent in the render tree.

public override System.Threading.Tasks.Task SetParametersAsync(Microsoft.AspNetCore.Components.ParameterView parameters);

Parameters

parameters Microsoft.AspNetCore.Components.ParameterView

The parameters.

Implements SetParametersAsync(ParameterView)

Returns

System.Threading.Tasks.Task
A System.Threading.Tasks.Task that completes when the component has finished updating and rendering itself.

Remarks

Parameters are passed when Microsoft.AspNetCore.Components.ComponentBase.SetParametersAsync(Microsoft.AspNetCore.Components.ParameterView) is called. It is not required that
the caller supply a parameter value for all of the parameters that are logically understood by the component.

The default implementation of Microsoft.AspNetCore.Components.ComponentBase.SetParametersAsync(Microsoft.AspNetCore.Components.ParameterView) will set the value of each property
decorated with Microsoft.AspNetCore.Components.ParameterAttribute or Microsoft.AspNetCore.Components.CascadingParameterAttribute that has
a corresponding value in the Microsoft.AspNetCore.Components.ParameterView. Parameters that do not have a corresponding value
will be unchanged.

Layer.SetTitle(string) Method

Asynchronously set the value of the Title property after render.

public System.Threading.Tasks.Task SetTitle(string? value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

Layer.SetVisibilityTimeExtent(TimeExtent) Method

Asynchronously set the value of the VisibilityTimeExtent property after render.

public System.Threading.Tasks.Task SetVisibilityTimeExtent(dymaptic.GeoBlazor.Core.Components.TimeExtent? value);

Parameters

value TimeExtent

The value to set.

Returns

System.Threading.Tasks.Task

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

System.Threading.Tasks.Task

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.

Layer.UpdateLayer() Method

Updates the layer internally. Not intended for public use.

public System.Threading.Tasks.Task UpdateLayer();

Returns

System.Threading.Tasks.Task

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();

Implements 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