dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components
Ground Class
GeoBlazor Docs The Ground class contains properties that specify how the ground surface is displayed in a SceneView. ArcGIS Maps SDK for JavaScript
public class Ground : dymaptic.GeoBlazor.Core.Components.MapComponent, dymaptic.GeoBlazor.Core.Interfaces.IIntersectItem, dymaptic.GeoBlazor.Core.Interfaces.ILayerParent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Ground
Implements IIntersectItem, ILayerParent
Constructors
Ground() Constructor
Parameterless constructor for use as a Razor Component.
public Ground();
Ground(IReadOnlyList, GroundNavigationConstraint, Nullable, MapColor, Nullable) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public Ground(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Layer>? layers=null, dymaptic.GeoBlazor.Core.Components.GroundNavigationConstraint? navigationConstraint=null, System.Nullable<double> opacity=null, dymaptic.GeoBlazor.Core.Model.MapColor? surfaceColor=null, System.Nullable<System.Guid> layerId=null);
Parameters
layers System.Collections.Generic.IReadOnlyList<Layer>
A collection of ElevationLayers that define the elevation or terrain that makes up the ground surface. ArcGIS Maps SDK for JavaScript
navigationConstraint GroundNavigationConstraint
Specifies the user navigation constraints relative to the ground surface. ArcGIS Maps SDK for JavaScript
opacity System.Nullable<System.Double>
Opacity of the ground, including surface default color and the basemap (without reference layers). default 1 ArcGIS Maps SDK for JavaScript
surfaceColor MapColor
The color of the ground surface, displayed underneath the basemap. default null ArcGIS Maps SDK for JavaScript
layerId System.Nullable<System.Guid>
The GeoBlazor Id of the relevant Layer for the MapComponent. Not always applicable to every component type.
Properties
Ground.Layers Property
GeoBlazor Docs A collection of ElevationLayers that define the elevation or terrain that makes up the ground surface. ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Layer>? Layers { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<Layer>
Ground.Loaded Property
GeoBlazor Docs Indicates whether the instance has loaded. default false ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> Loaded { get; }
Property Value
System.Nullable<System.Boolean>
Ground.NavigationConstraint Property
GeoBlazor Docs Specifies the user navigation constraints relative to the ground surface. ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.GroundNavigationConstraint? NavigationConstraint { get; set; }
Property Value
Ground.Opacity Property
GeoBlazor Docs Opacity of the ground, including surface default color and the basemap (without reference layers). default 1 ArcGIS Maps SDK for JavaScript
public System.Nullable<double> Opacity { get; set; }
Property Value
System.Nullable<System.Double>
Ground.SurfaceColor Property
GeoBlazor Docs The color of the ground surface, displayed underneath the basemap. default null ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Model.MapColor? SurfaceColor { get; set; }
Property Value
Ground.WorldElevation Property
Specifies a default instance of ground using the Terrain3D Service.
public System.Nullable<bool> WorldElevation { get; set; }
Property Value
System.Nullable<System.Boolean>
Ground.WorldTopoBathymetry Property
Specifies an instance of ground that combines surface elevation and bathymetry using the TopoBathy3D Service.
public System.Nullable<bool> WorldTopoBathymetry { get; set; }
Property Value
System.Nullable<System.Boolean>
Methods
Ground.AddToLayers(Layer[]) Method
Asynchronously adds elements to the Layers property.
public System.Threading.Tasks.Task AddToLayers(params dymaptic.GeoBlazor.Core.Components.Layers.Layer[] values);
Parameters
The elements to add.
Returns
Ground.CancelLoad() Method
GeoBlazor Docs Cancels a load() operation if it is already in progress. ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task CancelLoad();
Returns
Ground.CreateElevationSampler(Extent, GroundCreateElevationSamplerOptions, CancellationToken) Method
GeoBlazor Docs Creates an elevation sampler for the given extent by querying the ground layers for elevation data and caching it so values may be sampled quickly afterwards. param options Additional sampler options. ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Interfaces.IElevationSampler?> CreateElevationSampler(dymaptic.GeoBlazor.Core.Components.Geometries.Extent extent, dymaptic.GeoBlazor.Core.Options.GroundCreateElevationSamplerOptions? options=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));
Parameters
extent Extent
The extent for which to create the sampler.
options GroundCreateElevationSamplerOptions
Additional sampler options.
cancellationToken System.Threading.CancellationToken
The CancellationToken to cancel an asynchronous operation.
Returns
System.Threading.Tasks.Task<IElevationSampler>
Ground.GetLayers() Method
Asynchronously retrieve the current value of the Layers property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Layer>?> GetLayers();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Layer>>
Ground.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>>
Ground.GetNavigationConstraint() Method
Asynchronously retrieve the current value of the NavigationConstraint property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.GroundNavigationConstraint?> GetNavigationConstraint();
Returns
System.Threading.Tasks.Task<GroundNavigationConstraint>
Ground.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>>
Ground.GetSurfaceColor() Method
Asynchronously retrieve the current value of the SurfaceColor property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.MapColor?> GetSurfaceColor();
Returns
System.Threading.Tasks.Task<MapColor>
Ground.IsFulfilled() Method
GeoBlazor Docs `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>>
Ground.IsRejected() Method
GeoBlazor Docs `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>>
Ground.IsResolved() Method
GeoBlazor Docs `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>>
Ground.Load(CancellationToken) Method
GeoBlazor Docs Loads the resources referenced by this class. 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>
Ground.LoadAll() Method
GeoBlazor Docs Loads all the externally loadable resources associated with the ground. ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Ground?> LoadAll();
Returns
System.Threading.Tasks.Task<Ground>
Ground.OnJsCallback(Guid) Method
JS-invokable method that triggers the callback function from the When method. Should not be called by consuming code.
public void OnJsCallback(System.Guid funcId);
Parameters
funcId System.Guid
Ground.OnJsErrback(Guid) Method
JS-invokable method that triggers the errback function from the When method. Should not be called by consuming code.
public void OnJsErrback(System.Guid funcId);
Parameters
funcId System.Guid
Ground.QueryElevation(Geometry) Method
GeoBlazor Docs Query the ground layer services for elevation values for the given geometry. ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Results.ElevationQueryResult?> QueryElevation(dymaptic.GeoBlazor.Core.Components.Geometries.Geometry geometry);
Parameters
geometry Geometry
The geometry to sample.
Returns
System.Threading.Tasks.Task<ElevationQueryResult>
Ground.QueryElevation(Point, GroundQueryElevationOptions, CancellationToken) Method
GeoBlazor Docs Query the ground layer services for elevation values for the given geometry. ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Results.ElevationQueryResult?> QueryElevation(dymaptic.GeoBlazor.Core.Components.Geometries.Point geometry, dymaptic.GeoBlazor.Core.Options.GroundQueryElevationOptions? options=null, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));
Parameters
geometry Point
The geometry to sample.
options GroundQueryElevationOptions
Additional query options.
cancellationToken System.Threading.CancellationToken
The CancellationToken to cancel an asynchronous operation.
Returns
System.Threading.Tasks.Task<ElevationQueryResult>
Ground.QueryElevation(Polyline) Method
GeoBlazor Docs Query the ground layer services for elevation values for the given geometry. ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Results.ElevationQueryResult?> QueryElevation(dymaptic.GeoBlazor.Core.Components.Geometries.Polyline geometry);
Parameters
geometry Polyline
The geometry to sample.
Returns
System.Threading.Tasks.Task<ElevationQueryResult>
Ground.RemoveFromLayers(Layer[]) Method
Asynchronously remove an element from the Layers property.
public System.Threading.Tasks.Task RemoveFromLayers(params dymaptic.GeoBlazor.Core.Components.Layers.Layer[] values);
Parameters
The elements to remove.
Returns
Ground.SetLayers(IReadOnlyList) Method
Asynchronously set the value of the Layers property after render.
public System.Threading.Tasks.Task SetLayers(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Layer>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<Layer>
The value to set.
Returns
Ground.SetNavigationConstraint(GroundNavigationConstraint) Method
Asynchronously set the value of the NavigationConstraint property after render.
public System.Threading.Tasks.Task SetNavigationConstraint(dymaptic.GeoBlazor.Core.Components.GroundNavigationConstraint? value);
Parameters
value GroundNavigationConstraint
The value to set.
Returns
Ground.SetOpacity(Nullable) Method
Asynchronously set the value of the Opacity property after render.
public System.Threading.Tasks.Task SetOpacity(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Returns
Ground.SetSurfaceColor(MapColor) Method
Asynchronously set the value of the SurfaceColor property after render.
public System.Threading.Tasks.Task SetSurfaceColor(dymaptic.GeoBlazor.Core.Model.MapColor? value);
Parameters
value MapColor
The value to set.
Returns
Ground.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()
Ground.When(Action, Action) Method
GeoBlazor Docs `when()` may be leveraged once an instance of the class is created. ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<string?> When(System.Action? callback=null, System.Action? errback=null);
Parameters
callback System.Action
The function to call when the promise resolves.
errback System.Action
The function to execute when the promise fails.
Returns
System.Threading.Tasks.Task<System.String>
Operators
Ground.implicit operator Ground(string) Operator
Implicit conversion from string to Ground
public static dymaptic.GeoBlazor.Core.Components.Ground implicit operator dymaptic.GeoBlazor.Core.Components.Ground(string stringVal);
Parameters
stringVal System.String