dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Model

Ground Class

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.Interfaces.IIntersectItem,
dymaptic.GeoBlazor.Core.Interfaces.ILayerParent,
dymaptic.GeoBlazor.Core.Interfaces.IMeshUtilsSource,
dymaptic.GeoBlazor.Core.Interfaces.IInteractiveRecord,
System.IEquatable<dymaptic.GeoBlazor.Core.Model.Ground>

Inheritance System.Object 🡒 Ground

Implements IIntersectItem, ILayerParent, IMeshUtilsSource, IInteractiveRecord, System.IEquatable<Ground>

Constructors

Ground(IReadOnlyCollection, GroundNavigationConstraint, Nullable, MapColor) Constructor

The Ground class contains properties that specify how the ground surface is
displayed in a SceneView.
ArcGIS Maps SDK for JavaScript

public Ground(System.Collections.Generic.IReadOnlyCollection<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);

Parameters

Layers System.Collections.Generic.IReadOnlyCollection<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

Properties

Ground.AbortManager Property

Allows for transmitting CancellationToken cancel signals to JavaScript.

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

Implements AbortManager

Property Value

AbortManager

Ground.CoreJsModule Property

Reference to the Core JavaScript module.

public Microsoft.JSInterop.IJSObjectReference? CoreJsModule { get; set; }

Implements CoreJsModule

Property Value

Microsoft.JSInterop.IJSObjectReference

Ground.Id Property

A unique Id to identify this record in JavaScript.

public System.Guid Id { get; set; }

Implements Id

Property Value

System.Guid

Ground.JsComponentReference Property

Represents the JavaScript component reference.

public Microsoft.JSInterop.IJSObjectReference? JsComponentReference { get; set; }

Implements JsComponentReference

Property Value

Microsoft.JSInterop.IJSObjectReference

Ground.Layers Property

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.IReadOnlyCollection<dymaptic.GeoBlazor.Core.Components.Layers.Layer>? Layers { get; set; }

Property Value

System.Collections.Generic.IReadOnlyCollection<Layer>

Ground.NavigationConstraint Property

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

GroundNavigationConstraint

Ground.Opacity Property

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

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

MapColor

Methods

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

Ground.CreateElevationSampler(Extent, GroundCreateElevationSamplerOptions, CancellationToken) Method

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.
param options.noDataValue The value to use when there is no data available.
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, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

Parameters

extent Extent

The extent for which to create the sampler.

options GroundCreateElevationSamplerOptions

  • options.demResolution: Controls the horizontal resolution (cell size) in meters from which elevation data is sampled (defaults to auto). See Ground for more details.
  • options.signal: An AbortSignal to abort the request. If canceled, the promise will be rejected with an error named AbortError. See also AbortController.

cancellationToken System.Threading.CancellationToken

The CancellationToken to cancel an asynchronous operation.

Returns

System.Threading.Tasks.Task<IElevationSampler>

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

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

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

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

Ground.LoadAll() Method

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

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

Returns

System.Threading.Tasks.Task<Ground>

Ground.QueryElevation(Geometry, GroundQueryElevationOptions, CancellationToken) Method

Query the ground layer services for elevation values for the given geometry.
param options Additional query options.
param options.returnSampleInfo Indicates whether to return additional sample information for each sampled coordinate.
param options.signal An AbortSignal to abort the request. If canceled, the promise will be rejected with an error named AbortError. See also AbortController.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Results.ElevationQueryResult?> QueryElevation(dymaptic.GeoBlazor.Core.Components.Geometries.Geometry geometry, dymaptic.GeoBlazor.Core.Options.GroundQueryElevationOptions options, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));

Parameters

geometry Geometry

The geometry to sample.

options GroundQueryElevationOptions

  • options.demResolution: Controls the horizontal resolution (cell size) in meters from which elevation data is sampled (defaults to auto). See the table below for more details on the different settings.
    demResolution | Description
    ———————–|————-
    auto | Automatically chooses an appropriate resolution for each coordinate of the input geometry. The current implementation will try to use the finest available resolution given that the total required number of tile requests does not exceed a certain maximum amount (currently 20). Note that this may result in values being sampled from different resolutions.
    finest-contiguous | Sample elevation from the finest available resolution (cell size) across the entire geometry.
    {number} | Sample elevation from the resolution closest to the specified resolution (in meters).
  • options.noDataValue: The value that appears in the resulting geometry when there is no data available.

cancellationToken System.Threading.CancellationToken

The CancellationToken to cancel an asynchronous operation.

Returns

System.Threading.Tasks.Task<ElevationQueryResult>

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