dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components
WebScene Class
The web scene is the core element of 3D mapping across ArcGIS.
ArcGIS Maps SDK for JavaScript
public class WebScene : 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
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Map 🡒 WebScene
Implements IPortalLayer, IMapComponent, ITimeSliderViewModelDocument, ITimeSliderWidgetDocument, ITimeUtilsDocument
Constructors
WebScene() Constructor
Parameterless constructor for use as a Razor Component.
public WebScene();
WebScene(WebsceneApplicationProperties, string, string, Extent, Nullable, MapFloorInfo, HeightModelInfo, WebsceneInitialViewProperties, PortalItem, Presentation, string, WebSceneWidgets) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public WebScene(dymaptic.GeoBlazor.Core.Components.WebsceneApplicationProperties? applicationProperties=null, string? authoringApp=null, string? authoringAppVersion=null, dymaptic.GeoBlazor.Core.Components.Geometries.Extent? clippingArea=null, System.Nullable<bool> clippingEnabled=null, dymaptic.GeoBlazor.Core.Model.MapFloorInfo? floorInfo=null, dymaptic.GeoBlazor.Core.Model.HeightModelInfo? heightModelInfo=null, dymaptic.GeoBlazor.Core.Components.WebsceneInitialViewProperties? initialViewProperties=null, dymaptic.GeoBlazor.Core.Components.PortalItem? portalItem=null, dymaptic.GeoBlazor.Core.Model.Presentation? presentation=null, string? thumbnailUrl=null, dymaptic.GeoBlazor.Core.Components.WebSceneWidgets? widgets=null);
Parameters
applicationProperties WebsceneApplicationProperties
Configuration of application and UI elements.
ArcGIS Maps SDK for JavaScript
authoringApp System.String
The name of the application that authored the WebScene.
ArcGIS Maps SDK for JavaScript
authoringAppVersion System.String
The version of the application that authored the WebScene.
ArcGIS Maps SDK for JavaScript
clippingArea Extent
This property only applies to local scenes. Represents an optional clipping area used to define the bounds or Extent of a local scene.
ArcGIS Maps SDK for JavaScript
clippingEnabled System.Nullable<System.Boolean>
This property only applies to local scenes. Determines whether clipping using the clippingArea is enabled.
default false
ArcGIS Maps SDK for JavaScript
floorInfo MapFloorInfo
When a web scene is configured as floor-aware, it has a floorInfo property defined.
default null
ArcGIS Maps SDK for JavaScript
heightModelInfo HeightModelInfo
The height model info of the WebScene.
ArcGIS Maps SDK for JavaScript
initialViewProperties WebsceneInitialViewProperties
The initial view of the WebScene.
ArcGIS Maps SDK for JavaScript
portalItem PortalItem
The portal item from which the WebScene is loaded.
ArcGIS Maps SDK for JavaScript
presentation Presentation
Provides a Collection of slides that act as bookmarks for saving predefined viewpoints and visible layers.
ArcGIS Maps SDK for JavaScript
thumbnailUrl System.String
The URL to the thumbnail used for the web scene.
ArcGIS Maps SDK for JavaScript
widgets WebSceneWidgets
The widgets object contains widgets that are exposed to the user.
ArcGIS Maps SDK for JavaScript
Properties
WebScene.ApplicationProperties Property
Configuration of application and UI elements.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.WebsceneApplicationProperties? ApplicationProperties { get; set; }
Property Value
WebScene.AuthoringApp Property
The name of the application that authored the WebScene.
ArcGIS Maps SDK for JavaScript
public string? AuthoringApp { get; set; }
Property Value
WebScene.AuthoringAppVersion Property
The version of the application that authored the WebScene.
ArcGIS Maps SDK for JavaScript
public string? AuthoringAppVersion { get; set; }
Property Value
WebScene.ClippingArea Property
This property only applies to local scenes. Represents an optional clipping area used to define the bounds or Extent of a local scene.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.Geometries.Extent? ClippingArea { get; set; }
Property Value
WebScene.ClippingEnabled Property
This property only applies to local scenes. Determines whether clipping using the clippingArea is enabled.
default false
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> ClippingEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
WebScene.FloorInfo Property
When a web scene is configured as floor-aware, it has a floorInfo property defined.
default null
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Model.MapFloorInfo? FloorInfo { get; set; }
Property Value
WebScene.HeightModelInfo Property
The height model info of the WebScene.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Model.HeightModelInfo? HeightModelInfo { get; set; }
Property Value
WebScene.InitialViewProperties Property
The initial view of the WebScene.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.WebsceneInitialViewProperties? InitialViewProperties { get; set; }
Property Value
WebScene.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>
WebScene.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
WebScene.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
WebScene.PortalItem Property
The portal item from which the WebScene is loaded.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.PortalItem? PortalItem { get; set; }
Implements PortalItem
Property Value
WebScene.Presentation Property
Provides a Collection of slides that act as bookmarks for saving predefined viewpoints and visible layers.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Model.Presentation? Presentation { get; set; }
Property Value
WebScene.SourceVersion Property
The version of the source document from which the WebScene was read.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Model.WebSceneSourceVersion? SourceVersion { get; set; }
Property Value
WebScene.ThumbnailUrl Property
The URL to the thumbnail used for the web scene.
ArcGIS Maps SDK for JavaScript
public string? ThumbnailUrl { get; set; }
Property Value
WebScene.Widgets Property
The widgets object contains widgets that are exposed to the user.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.WebSceneWidgets? Widgets { get; set; }
Property Value
Methods
WebScene.GetApplicationProperties() Method
Asynchronously retrieve the current value of the ApplicationProperties property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.WebsceneApplicationProperties?> GetApplicationProperties();
Returns
System.Threading.Tasks.Task<WebsceneApplicationProperties>
WebScene.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>
WebScene.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>
WebScene.GetClippingArea() Method
Asynchronously retrieve the current value of the ClippingArea property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Geometries.Extent?> GetClippingArea();
Returns
System.Threading.Tasks.Task<Extent>
WebScene.GetClippingEnabled() Method
Asynchronously retrieve the current value of the ClippingEnabled property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetClippingEnabled();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
WebScene.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>
WebScene.GetHeightModelInfo() Method
Asynchronously retrieve the current value of the HeightModelInfo property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.HeightModelInfo?> GetHeightModelInfo();
Returns
System.Threading.Tasks.Task<HeightModelInfo>
WebScene.GetInitialViewProperties() Method
Asynchronously retrieve the current value of the InitialViewProperties property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.WebsceneInitialViewProperties?> GetInitialViewProperties();
Returns
System.Threading.Tasks.Task<WebsceneInitialViewProperties>
WebScene.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>>
WebScene.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>
WebScene.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>>
WebScene.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>
WebScene.GetPresentation() Method
Asynchronously retrieve the current value of the Presentation property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.Presentation?> GetPresentation();
Returns
System.Threading.Tasks.Task<Presentation>
WebScene.GetSourceVersion() Method
Asynchronously retrieve the current value of the SourceVersion property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.WebSceneSourceVersion?> GetSourceVersion();
Returns
System.Threading.Tasks.Task<WebSceneSourceVersion>
WebScene.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>
WebScene.GetWidgets() Method
Asynchronously retrieve the current value of the Widgets property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.WebSceneWidgets?> GetWidgets();
Returns
System.Threading.Tasks.Task<WebSceneWidgets>
WebScene.Load() Method
Triggers the loading of the WebScene instance.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<object?> Load();
Returns
System.Threading.Tasks.Task<System.Object>
WebScene.LoadAll() Method
Loads all the externally loadable resources associated with the webscene.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.WebScene?> LoadAll();
Returns
System.Threading.Tasks.Task<WebScene>
WebScene.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
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.
WebScene.Save(WebSceneSaveOptions) Method
Saves the webscene 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.WebSceneSaveOptions options);
Parameters
options WebSceneSaveOptions
Additional options.
Returns
System.Threading.Tasks.Task<PortalItem>
WebScene.SaveAs(PortalItem, WebSceneSaveAsOptions) Method
Saves the webscene 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.WebSceneSaveAsOptions options);
Parameters
portalItem PortalItem
The new portal item to which the scene will be saved.
options WebSceneSaveAsOptions
additional save options.
Returns
System.Threading.Tasks.Task<PortalItem>
WebScene.SetApplicationProperties(WebsceneApplicationProperties) Method
Asynchronously set the value of the ApplicationProperties property after render.
public System.Threading.Tasks.Task SetApplicationProperties(dymaptic.GeoBlazor.Core.Components.WebsceneApplicationProperties? value);
Parameters
value WebsceneApplicationProperties
The value to set.
Returns
WebScene.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
WebScene.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
WebScene.SetClippingArea(Extent) Method
Asynchronously set the value of the ClippingArea property after render.
public System.Threading.Tasks.Task SetClippingArea(dymaptic.GeoBlazor.Core.Components.Geometries.Extent? value);
Parameters
value Extent
The value to set.
Returns
WebScene.SetClippingEnabled(Nullable) Method
Asynchronously set the value of the ClippingEnabled property after render.
public System.Threading.Tasks.Task SetClippingEnabled(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
WebScene.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
WebScene.SetHeightModelInfo(HeightModelInfo) Method
Asynchronously set the value of the HeightModelInfo property after render.
public System.Threading.Tasks.Task SetHeightModelInfo(dymaptic.GeoBlazor.Core.Model.HeightModelInfo? value);
Parameters
value HeightModelInfo
The value to set.
Returns
WebScene.SetInitialViewProperties(WebsceneInitialViewProperties) Method
Asynchronously set the value of the InitialViewProperties property after render.
public System.Threading.Tasks.Task SetInitialViewProperties(dymaptic.GeoBlazor.Core.Components.WebsceneInitialViewProperties? value);
Parameters
value WebsceneInitialViewProperties
The value to set.
Returns
WebScene.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
WebScene.SetPresentation(Presentation) Method
Asynchronously set the value of the Presentation property after render.
public System.Threading.Tasks.Task SetPresentation(dymaptic.GeoBlazor.Core.Model.Presentation? value);
Parameters
value Presentation
The value to set.
Returns
WebScene.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
WebScene.SetWidgets(WebSceneWidgets) Method
Asynchronously set the value of the Widgets property after render.
public System.Threading.Tasks.Task SetWidgets(dymaptic.GeoBlazor.Core.Components.WebSceneWidgets? value);
Parameters
value WebSceneWidgets
The value to set.
Returns
WebScene.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.
WebScene.UpdateFrom(SceneView, WebSceneUpdateFromOptions) Method
Update properties of the WebScene related to the view.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<object?> UpdateFrom(dymaptic.GeoBlazor.Core.Components.Views.SceneView view, dymaptic.GeoBlazor.Core.Options.WebSceneUpdateFromOptions options);
Parameters
view SceneView
The view to update from.
options WebSceneUpdateFromOptions
Options for updating.
Returns
System.Threading.Tasks.Task<System.Object>
WebScene.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
WebScene.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()