dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components

WebMap Class

Loads a WebMap from ArcGIS Online or ArcGIS Enterprise portal into a MapView.
ArcGIS Maps SDK for JavaScript

public class WebMap : dymaptic.GeoBlazor.Core.Components.Map,
dymaptic.GeoBlazor.Core.Interfaces.IPortalLayer,
dymaptic.GeoBlazor.Core.Interfaces.IMapComponent,
dymaptic.GeoBlazor.Core.Interfaces.ITimeSliderViewModelDocument,
dymaptic.GeoBlazor.Core.Interfaces.ITimeSliderWidgetDocument,
dymaptic.GeoBlazor.Core.Interfaces.ITimeUtilsDocument,
dymaptic.GeoBlazor.Core.Interfaces.IVersionManagementUtilsInput

Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Map 🡒 WebMap

Implements IPortalLayer, IMapComponent, ITimeSliderViewModelDocument, ITimeSliderWidgetDocument, ITimeUtilsDocument, IVersionManagementUtilsInput

Constructors

WebMap() Constructor

Parameterless constructor for use as a Razor Component.

public WebMap();

WebMap(ApplicationProperties, string, string, IReadOnlyList, MapFloorInfo, GeotriggersInfo, InitialViewProperties, PortalItem, object, string, IReadOnlyList, WebMapWidgets) Constructor

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

public WebMap(dymaptic.GeoBlazor.Core.Components.ApplicationProperties? applicationProperties=null, string? authoringApp=null, string? authoringAppVersion=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Bookmark>? bookmarks=null, dymaptic.GeoBlazor.Core.Model.MapFloorInfo? floorInfo=null, dymaptic.GeoBlazor.Core.Model.GeotriggersInfo? geotriggersInfo=null, dymaptic.GeoBlazor.Core.Components.InitialViewProperties? initialViewProperties=null, dymaptic.GeoBlazor.Core.Components.PortalItem? portalItem=null, object? presentation=null, string? thumbnailUrl=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Interfaces.IUtilityNetwork>? utilityNetworks=null, dymaptic.GeoBlazor.Core.Components.WebMapWidgets? widgets=null);

Parameters

applicationProperties ApplicationProperties

The applicationProperties contains the viewing properties of the WebMap.
ArcGIS Maps SDK for JavaScript

authoringApp System.String

The name of the application that authored the WebMap.
ArcGIS Maps SDK for JavaScript

authoringAppVersion System.String

The version of the application that authored the WebMap.
ArcGIS Maps SDK for JavaScript

bookmarks System.Collections.Generic.IReadOnlyList<Bookmark>

An array of saved geographic extents that allow end users to quickly navigate to a particular area of interest.
ArcGIS Maps SDK for JavaScript

floorInfo MapFloorInfo

When a web map is configured as floor-aware, it has a floorInfo property defined.
ArcGIS Maps SDK for JavaScript

geotriggersInfo GeotriggersInfo

Information relating to a list of Geotriggers.
ArcGIS Maps SDK for JavaScript

initialViewProperties InitialViewProperties

The initial view of the WebMap.
ArcGIS Maps SDK for JavaScript

portalItem PortalItem

The portal item from which the WebMap is loaded.
ArcGIS Maps SDK for JavaScript

presentation System.Object

Provides multiple slides.
ArcGIS Maps SDK for JavaScript

thumbnailUrl System.String

The URL to the thumbnail used for the webmap.
ArcGIS Maps SDK for JavaScript

utilityNetworks System.Collections.Generic.IReadOnlyList<IUtilityNetwork>

The utilityNetworks object contains a collection of UtilityNetworks saved on the web map.
ArcGIS Maps SDK for JavaScript

widgets WebMapWidgets

The widgets object contains widgets that are exposed to the user.
ArcGIS Maps SDK for JavaScript

Properties

WebMap.ApplicationProperties Property

The applicationProperties contains the viewing properties of the WebMap.
ArcGIS Maps SDK for JavaScript

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

Property Value

ApplicationProperties

WebMap.AuthoringApp Property

The name of the application that authored the WebMap.
ArcGIS Maps SDK for JavaScript

public string? AuthoringApp { get; set; }

Property Value

System.String

WebMap.AuthoringAppVersion Property

The version of the application that authored the WebMap.
ArcGIS Maps SDK for JavaScript

public string? AuthoringAppVersion { get; set; }

Property Value

System.String

WebMap.Bookmarks Property

An array of saved geographic extents that allow end users to quickly navigate to a particular area of interest.
ArcGIS Maps SDK for JavaScript

public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Bookmark>? Bookmarks { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<Bookmark>

WebMap.FloorInfo Property

When a web map is configured as floor-aware, it has a floorInfo property defined.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Model.MapFloorInfo? FloorInfo { get; set; }

Property Value

MapFloorInfo

WebMap.GeotriggersInfo Property

Information relating to a list of Geotriggers.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Model.GeotriggersInfo? GeotriggersInfo { get; set; }

Property Value

GeotriggersInfo

WebMap.InitialViewProperties Property

The initial view of the WebMap.
ArcGIS Maps SDK for JavaScript

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

Property Value

InitialViewProperties

WebMap.Loaded Property

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

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

Property Value

System.Nullable<System.Boolean>

WebMap.LoadError Property

The Error object returned if an error occurred while loading.
default null
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Model.Error? LoadError { get; set; }

Property Value

Error

WebMap.LoadStatus Property

Represents the status of a load operation.
default not-loaded
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Nullable<LoadStatus>

WebMap.PortalItem Property

The portal item from which the WebMap is loaded.

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

Implements PortalItem

Property Value

PortalItem

WebMap.Presentation Property

Provides multiple slides.
ArcGIS Maps SDK for JavaScript

public object? Presentation { get; set; }

Property Value

System.Object

WebMap.SourceVersion Property

The version of the source document from which the WebMap was read.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Model.WebMapSourceVersion? SourceVersion { get; set; }

Property Value

WebMapSourceVersion

WebMap.ThumbnailUrl Property

The URL to the thumbnail used for the webmap.
ArcGIS Maps SDK for JavaScript

public string? ThumbnailUrl { get; set; }

Property Value

System.String

WebMap.UtilityNetworks Property

The utilityNetworks object contains a collection of UtilityNetworks saved on the web map.
ArcGIS Maps SDK for JavaScript

public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Interfaces.IUtilityNetwork>? UtilityNetworks { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<IUtilityNetwork>

WebMap.Widgets Property

The widgets object contains widgets that are exposed to the user.
ArcGIS Maps SDK for JavaScript

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

Property Value

WebMapWidgets

Methods

WebMap.AddToBookmarks(Bookmark[]) Method

Asynchronously adds elements to the Bookmarks property.

public System.Threading.Tasks.Task AddToBookmarks(params dymaptic.GeoBlazor.Core.Components.Bookmark[] values);

Parameters

values Bookmark[]

The elements to add.

Returns

System.Threading.Tasks.Task

WebMap.AddToUtilityNetworks(IUtilityNetwork[]) Method

Asynchronously adds elements to the UtilityNetworks property.

public System.Threading.Tasks.Task AddToUtilityNetworks(params dymaptic.GeoBlazor.Core.Interfaces.IUtilityNetwork[] values);

Parameters

values IUtilityNetwork[]

The elements to add.

Returns

System.Threading.Tasks.Task

WebMap.GetApplicationProperties() Method

Asynchronously retrieve the current value of the ApplicationProperties property.

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

Returns

System.Threading.Tasks.Task<ApplicationProperties>

WebMap.GetAuthoringApp() Method

Asynchronously retrieve the current value of the AuthoringApp property.

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

Returns

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

WebMap.GetAuthoringAppVersion() Method

Asynchronously retrieve the current value of the AuthoringAppVersion property.

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

Returns

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

WebMap.GetBookmarks() Method

Asynchronously retrieve the current value of the Bookmarks property.

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Bookmark>?> GetBookmarks();

Returns

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

WebMap.GetFloorInfo() Method

Asynchronously retrieve the current value of the FloorInfo property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.MapFloorInfo?> GetFloorInfo();

Returns

System.Threading.Tasks.Task<MapFloorInfo>

WebMap.GetGeotriggersInfo() Method

Asynchronously retrieve the current value of the GeotriggersInfo property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.GeotriggersInfo?> GetGeotriggersInfo();

Returns

System.Threading.Tasks.Task<GeotriggersInfo>

WebMap.GetInitialViewProperties() Method

Asynchronously retrieve the current value of the InitialViewProperties property.

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

Returns

System.Threading.Tasks.Task<InitialViewProperties>

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

WebMap.GetLoadError() Method

Asynchronously retrieve the current value of the LoadError property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.Error?> GetLoadError();

Returns

System.Threading.Tasks.Task<Error>

WebMap.GetLoadStatus() Method

Asynchronously retrieve the current value of the LoadStatus property.

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

Returns

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

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

WebMap.GetPresentation() Method

Asynchronously retrieve the current value of the Presentation property.

public System.Threading.Tasks.Task<object?> GetPresentation();

Returns

System.Threading.Tasks.Task<System.Object>

WebMap.GetSourceVersion() Method

Asynchronously retrieve the current value of the SourceVersion property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.WebMapSourceVersion?> GetSourceVersion();

Returns

System.Threading.Tasks.Task<WebMapSourceVersion>

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

WebMap.GetUtilityNetworks() Method

Asynchronously retrieve the current value of the UtilityNetworks property.

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Interfaces.IUtilityNetwork>?> GetUtilityNetworks();

Returns

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

WebMap.GetWidgets() Method

Asynchronously retrieve the current value of the Widgets property.

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

Returns

System.Threading.Tasks.Task<WebMapWidgets>

WebMap.Load() Method

Triggers the loading of the WebMap instance.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<object?> Load();

Returns

System.Threading.Tasks.Task<System.Object>

WebMap.LoadAll() Method

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

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

Returns

System.Threading.Tasks.Task<WebMap>

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

WebMap.RemoveFromBookmarks(Bookmark[]) Method

Asynchronously remove an element from the Bookmarks property.

public System.Threading.Tasks.Task RemoveFromBookmarks(params dymaptic.GeoBlazor.Core.Components.Bookmark[] values);

Parameters

values Bookmark[]

The elements to remove.

Returns

System.Threading.Tasks.Task

WebMap.RemoveFromUtilityNetworks(IUtilityNetwork[]) Method

Asynchronously remove an element from the UtilityNetworks property.

public System.Threading.Tasks.Task RemoveFromUtilityNetworks(params dymaptic.GeoBlazor.Core.Interfaces.IUtilityNetwork[] values);

Parameters

values IUtilityNetwork[]

The elements to remove.

Returns

System.Threading.Tasks.Task

WebMap.Save(WebMapSaveOptions) Method

Saves the webmap to its associated portal item.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.PortalItem?> Save(dymaptic.GeoBlazor.Core.Options.WebMapSaveOptions options);

Parameters

options WebMapSaveOptions

Additional options.

Returns

System.Threading.Tasks.Task<PortalItem>

WebMap.SaveAs(PortalItem, WebMapSaveAsOptions) Method

Saves the webmap to a new portal item.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.PortalItem?> SaveAs(dymaptic.GeoBlazor.Core.Components.PortalItem portalItem, dymaptic.GeoBlazor.Core.Options.WebMapSaveAsOptions options);

Parameters

portalItem PortalItem

The new portal item to which the webmap will be saved.

options WebMapSaveAsOptions

Additional save options.

Returns

System.Threading.Tasks.Task<PortalItem>

WebMap.SetApplicationProperties(ApplicationProperties) Method

Asynchronously set the value of the ApplicationProperties property after render.

public System.Threading.Tasks.Task SetApplicationProperties(dymaptic.GeoBlazor.Core.Components.ApplicationProperties? value);

Parameters

value ApplicationProperties

The value to set.

Returns

System.Threading.Tasks.Task

WebMap.SetAuthoringApp(string) Method

Asynchronously set the value of the AuthoringApp property after render.

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

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

WebMap.SetAuthoringAppVersion(string) Method

Asynchronously set the value of the AuthoringAppVersion property after render.

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

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

WebMap.SetBookmarks(IReadOnlyList) Method

Asynchronously set the value of the Bookmarks property after render.

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

Parameters

value System.Collections.Generic.IReadOnlyList<Bookmark>

The value to set.

Returns

System.Threading.Tasks.Task

WebMap.SetFloorInfo(MapFloorInfo) Method

Asynchronously set the value of the FloorInfo property after render.

public System.Threading.Tasks.Task SetFloorInfo(dymaptic.GeoBlazor.Core.Model.MapFloorInfo? value);

Parameters

value MapFloorInfo

The value to set.

Returns

System.Threading.Tasks.Task

WebMap.SetGeotriggersInfo(GeotriggersInfo) Method

Asynchronously set the value of the GeotriggersInfo property after render.

public System.Threading.Tasks.Task SetGeotriggersInfo(dymaptic.GeoBlazor.Core.Model.GeotriggersInfo? value);

Parameters

value GeotriggersInfo

The value to set.

Returns

System.Threading.Tasks.Task

WebMap.SetInitialViewProperties(InitialViewProperties) Method

Asynchronously set the value of the InitialViewProperties property after render.

public System.Threading.Tasks.Task SetInitialViewProperties(dymaptic.GeoBlazor.Core.Components.InitialViewProperties? value);

Parameters

value InitialViewProperties

The value to set.

Returns

System.Threading.Tasks.Task

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

WebMap.SetPresentation(object) Method

Asynchronously set the value of the Presentation property after render.

public System.Threading.Tasks.Task SetPresentation(object? value);

Parameters

value System.Object

The value to set.

Returns

System.Threading.Tasks.Task

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

WebMap.SetUtilityNetworks(IReadOnlyList) Method

Asynchronously set the value of the UtilityNetworks property after render.

public System.Threading.Tasks.Task SetUtilityNetworks(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Interfaces.IUtilityNetwork>? value);

Parameters

value System.Collections.Generic.IReadOnlyList<IUtilityNetwork>

The value to set.

Returns

System.Threading.Tasks.Task

WebMap.SetWidgets(WebMapWidgets) Method

Asynchronously set the value of the Widgets property after render.

public System.Threading.Tasks.Task SetWidgets(dymaptic.GeoBlazor.Core.Components.WebMapWidgets? value);

Parameters

value WebMapWidgets

The value to set.

Returns

System.Threading.Tasks.Task

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

WebMap.UpdateFrom(MapView, WebMapUpdateFromOptions) Method

Update properties of the WebMap related to the view.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<object?> UpdateFrom(dymaptic.GeoBlazor.Core.Components.Views.MapView view, dymaptic.GeoBlazor.Core.Options.WebMapUpdateFromOptions options);

Parameters

view MapView

The view to update from.

options WebMapUpdateFromOptions

Update options.

Returns

System.Threading.Tasks.Task<System.Object>

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

WebMap.ValidateRequiredGeneratedChildren() Method

Validates source-generated child components.

public override void ValidateRequiredGeneratedChildren();

Implements ValidateRequiredGeneratedChildren()