dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components

Basemap Class

A basemap is a collection of layers that provide geographic context to a map or scene with data such as topographic features, road networks, buildings, and labels.
ArcGIS Maps SDK for JavaScript

public class Basemap : dymaptic.GeoBlazor.Core.Components.MapComponent,
dymaptic.GeoBlazor.Core.Interfaces.IPortalLayer,
dymaptic.GeoBlazor.Core.Interfaces.IMapComponent,
dymaptic.GeoBlazor.Core.Interfaces.ILayerParent

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

Implements IPortalLayer, IMapComponent, ILayerParent

Constructors

Basemap() Constructor

Parameterless constructor for use as a Razor Component.

public Basemap();

Basemap(IReadOnlyList, string, PortalItem, IReadOnlyList, SpatialReference, BasemapStyle, string, string) Constructor

Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.

public Basemap(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Layer>? baseLayers=null, string? basemapId=null, dymaptic.GeoBlazor.Core.Components.PortalItem? portalItem=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Layer>? referenceLayers=null, dymaptic.GeoBlazor.Core.Components.SpatialReference? spatialReference=null, dymaptic.GeoBlazor.Core.Components.BasemapStyle? style=null, string? thumbnailUrl=null, string? title=null);

Parameters

baseLayers System.Collections.Generic.IReadOnlyList<Layer>

A collection of tile layers that make up the basemap’s features.
ArcGIS Maps SDK for JavaScript

basemapId System.String

An identifier used to refer to the basemap when referencing it elsewhere.
ArcGIS Maps SDK for JavaScript

portalItem PortalItem

The portal item.
ArcGIS Maps SDK for JavaScript

referenceLayers System.Collections.Generic.IReadOnlyList<Layer>

A collection of reference layers which are displayed over the base layers and all other layers in the map.
ArcGIS Maps SDK for JavaScript

spatialReference SpatialReference

The spatial reference of the Basemap.
ArcGIS Maps SDK for JavaScript

style BasemapStyle

The style of the basemap from the basemap styles service (v2).
ArcGIS Maps SDK for JavaScript

thumbnailUrl System.String

The URL pointing to an image that represents the basemap.
ArcGIS Maps SDK for JavaScript

title System.String

The title of the basemap.
ArcGIS Maps SDK for JavaScript

Properties

Basemap.BaseLayers Property

A collection of tile layers that make up the basemap’s features.
ArcGIS Maps SDK for JavaScript

public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Layer>? BaseLayers { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<Layer>

Basemap.BasemapId Property

An identifier used to refer to the basemap when referencing it elsewhere.
ArcGIS Maps SDK for JavaScript

public string? BasemapId { get; set; }

Property Value

System.String

Basemap.Layers Property

A collection of tile layers that make of the basemap’s features.

public System.Collections.Generic.List<dymaptic.GeoBlazor.Core.Components.Layers.Layer> Layers { get; set; }

Property Value

System.Collections.Generic.List<Layer>

Basemap.Loaded Property

Indicates whether the basemap instance has loaded.
default false
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Nullable<System.Boolean>

Basemap.PortalItem Property

The portal item.
ArcGIS Maps SDK for JavaScript

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

Implements PortalItem

Property Value

PortalItem

Basemap.ReferenceLayers Property

A collection of reference layers which are displayed over the base layers and all other layers in the map.
ArcGIS Maps SDK for JavaScript

public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Layer>? ReferenceLayers { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<Layer>

Basemap.SpatialReference Property

The spatial reference of the Basemap.
ArcGIS Maps SDK for JavaScript

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

Property Value

SpatialReference

Basemap.Style Property

The style of the basemap from the basemap styles service (v2).
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.BasemapStyle? Style { get; set; }

Property Value

BasemapStyle

Basemap.ThumbnailUrl Property

The URL pointing to an image that represents the basemap.
ArcGIS Maps SDK for JavaScript

public string? ThumbnailUrl { get; set; }

Property Value

System.String

Basemap.Title Property

The title of the basemap.
ArcGIS Maps SDK for JavaScript

public string? Title { get; set; }

Property Value

System.String

Methods

Basemap.AddToBaseLayers(Layer[]) Method

Asynchronously adds elements to the BaseLayers property.

public System.Threading.Tasks.Task AddToBaseLayers(params dymaptic.GeoBlazor.Core.Components.Layers.Layer[] values);

Parameters

values Layer[]

The elements to add.

Returns

System.Threading.Tasks.Task

Basemap.AddToReferenceLayers(Layer[]) Method

Asynchronously adds elements to the ReferenceLayers property.

public System.Threading.Tasks.Task AddToReferenceLayers(params dymaptic.GeoBlazor.Core.Components.Layers.Layer[] values);

Parameters

values Layer[]

The elements to add.

Returns

System.Threading.Tasks.Task

Basemap.CancelLoad() Method

Cancels a load() operation if it is already in progress.
ArcGIS Maps SDK for JavaScript

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

Returns

System.Threading.Tasks.Task

Basemap.GetBaseLayers() Method

Asynchronously retrieve the current value of the BaseLayers property.

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Layer>?> GetBaseLayers();

Returns

System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Layer>>

Basemap.GetBasemapId() Method

Asynchronously retrieve the current value of the BasemapId property.

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

Returns

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

Basemap.GetLoaded() Method

Asynchronously retrieve the current value of the Loaded property.

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

Returns

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

Basemap.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>

Basemap.GetReferenceLayers() Method

Asynchronously retrieve the current value of the ReferenceLayers property.

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Layer>?> GetReferenceLayers();

Returns

System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Layer>>

Basemap.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>

Basemap.GetStyle() Method

Asynchronously retrieve the current value of the Style property.

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

Returns

System.Threading.Tasks.Task<BasemapStyle>

Basemap.GetThumbnailUrl() Method

Asynchronously retrieve the current value of the ThumbnailUrl property.

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

Returns

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

Basemap.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>

Basemap.IsFulfilled() Method

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).
ArcGIS Maps SDK for JavaScript

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

Returns

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

Basemap.IsRejected() Method

isRejected() may be used to verify if creating an instance of the class is rejected.
ArcGIS Maps SDK for JavaScript

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

Returns

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

Basemap.IsResolved() Method

isResolved() may be used to verify if creating an instance of the class is resolved.
ArcGIS Maps SDK for JavaScript

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

Returns

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

Basemap.Load(CancellationToken) Method

Loads the resources referenced by this class.
param options.signal Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<string?> Load(System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

Parameters

cancellationToken System.Threading.CancellationToken

The CancellationToken to cancel an asynchronous operation.

Returns

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

Basemap.LoadAll() Method

Loads all the externally loadable resources associated with the basemap.
ArcGIS Maps SDK for JavaScript

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

Returns

System.Threading.Tasks.Task<Basemap>

Basemap.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.

Basemap.RemoveFromBaseLayers(Layer[]) Method

Asynchronously remove an element from the BaseLayers property.

public System.Threading.Tasks.Task RemoveFromBaseLayers(params dymaptic.GeoBlazor.Core.Components.Layers.Layer[] values);

Parameters

values Layer[]

The elements to remove.

Returns

System.Threading.Tasks.Task

Basemap.RemoveFromReferenceLayers(Layer[]) Method

Asynchronously remove an element from the ReferenceLayers property.

public System.Threading.Tasks.Task RemoveFromReferenceLayers(params dymaptic.GeoBlazor.Core.Components.Layers.Layer[] values);

Parameters

values Layer[]

The elements to remove.

Returns

System.Threading.Tasks.Task

Basemap.SetBaseLayers(IReadOnlyList) Method

Asynchronously set the value of the BaseLayers property after render.

public System.Threading.Tasks.Task SetBaseLayers(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Layer>? value);

Parameters

value System.Collections.Generic.IReadOnlyList<Layer>

The value to set.

Returns

System.Threading.Tasks.Task

Basemap.SetBasemapId(string) Method

Asynchronously set the value of the BasemapId property after render.

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

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

Basemap.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.

Basemap.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

System.Threading.Tasks.Task

Basemap.SetReferenceLayers(IReadOnlyList) Method

Asynchronously set the value of the ReferenceLayers property after render.

public System.Threading.Tasks.Task SetReferenceLayers(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Layer>? value);

Parameters

value System.Collections.Generic.IReadOnlyList<Layer>

The value to set.

Returns

System.Threading.Tasks.Task

Basemap.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

System.Threading.Tasks.Task

Basemap.SetStyle(BasemapStyle) Method

Asynchronously set the value of the Style property after render.

public System.Threading.Tasks.Task SetStyle(dymaptic.GeoBlazor.Core.Components.BasemapStyle? value);

Parameters

value BasemapStyle

The value to set.

Returns

System.Threading.Tasks.Task

Basemap.SetThumbnailUrl(string) Method

Asynchronously set the value of the ThumbnailUrl property after render.

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

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

Basemap.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

Basemap.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.

Basemap.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

Basemap.ValidateRequiredGeneratedChildren() Method

Validates source-generated child components.

public override void ValidateRequiredGeneratedChildren();

Implements ValidateRequiredGeneratedChildren()

Basemap.When(Func, Func) Method

when() may be leveraged once an instance of the class is created.
param errback The function to execute when the promise fails.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<string?> When(System.Func<System.Threading.Tasks.Task> callback, System.Func<System.Threading.Tasks.Task> errback);

Parameters

callback System.Func<System.Threading.Tasks.Task>

The function to call when the promise resolves.

errback System.Func<System.Threading.Tasks.Task>

The function to execute when the promise fails.

Returns

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