GeoBlazor Pro
dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Components.Layers
ElevationLayer Class
ElevationLayer is a tile layer used for rendering elevations in SceneViews.
ArcGIS Maps SDK for JavaScript
public class ElevationLayer : dymaptic.GeoBlazor.Core.Components.Layers.Layer,
dymaptic.GeoBlazor.Core.Interfaces.IArcGISCachedService,
dymaptic.GeoBlazor.Core.Interfaces.IMapComponent,
dymaptic.GeoBlazor.Core.Interfaces.IElevationLayer,
dymaptic.GeoBlazor.Core.Interfaces.IMeshUtilsSource,
dymaptic.GeoBlazor.Core.Interfaces.IOperationalLayer,
dymaptic.GeoBlazor.Core.Interfaces.IPortalLayer
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 dymaptic.GeoBlazor.Core.Components.MapComponent 🡒 dymaptic.GeoBlazor.Core.Components.Layers.Layer 🡒 ElevationLayer
Implements dymaptic.GeoBlazor.Core.Interfaces.IArcGISCachedService, dymaptic.GeoBlazor.Core.Interfaces.IMapComponent, dymaptic.GeoBlazor.Core.Interfaces.IElevationLayer, dymaptic.GeoBlazor.Core.Interfaces.IMeshUtilsSource, dymaptic.GeoBlazor.Core.Interfaces.IOperationalLayer, dymaptic.GeoBlazor.Core.Interfaces.IPortalLayer
Constructors
ElevationLayer() Constructor
Parameterless constructor for use as a Razor Component.
public ElevationLayer();
ElevationLayer(string, string, Extent, Nullable, Nullable, Nullable, Nullable, PortalItem, TileInfo, string, string, TimeExtent, Nullable) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public ElevationLayer(string? arcGISLayerId=null, string? copyright=null, dymaptic.GeoBlazor.Core.Components.Geometries.Extent? fullExtent=null, System.Nullable<bool> isBasemapReferenceLayer=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.ListMode> listMode=null, System.Nullable<double> opacity=null, System.Nullable<bool> persistenceEnabled=null, dymaptic.GeoBlazor.Core.Components.PortalItem? portalItem=null, dymaptic.GeoBlazor.Core.Components.TileInfo? tileInfo=null, string? title=null, string? url=null, dymaptic.GeoBlazor.Core.Components.TimeExtent? visibilityTimeExtent=null, System.Nullable<bool> visible=null);
Parameters
arcGISLayerId System.String
The unique ID assigned to the layer.
ArcGIS Maps SDK for JavaScript
copyright System.String
The copyright text as defined by the service.
ArcGIS Maps SDK for JavaScript
fullExtent dymaptic.GeoBlazor.Core.Components.Geometries.Extent
The full extent of the layer.
ArcGIS Maps SDK for JavaScript
isBasemapReferenceLayer System.Nullable<System.Boolean>
Indicates whether the layer is a basemap reference layer. Default value: false.
listMode System.Nullable<dymaptic.GeoBlazor.Core.Enums.ListMode>
Indicates how the layer should display in the LayerList widget.
default “show”
ArcGIS Maps SDK for JavaScript
opacity System.Nullable<System.Double>
The opacity of the layer.
default 1
ArcGIS Maps SDK for JavaScript
persistenceEnabled System.Nullable<System.Boolean>
Enable persistence of the layer in a WebMap or WebScene.
default true
ArcGIS Maps SDK for JavaScript
portalItem dymaptic.GeoBlazor.Core.Components.PortalItem
The portal item from which the layer is loaded.
ArcGIS Maps SDK for JavaScript
tileInfo dymaptic.GeoBlazor.Core.Components.TileInfo
Contains information about the tiling scheme for the layer.
ArcGIS Maps SDK for JavaScript
title System.String
The title of the layer used to identify it in places such as the LayerList widget.
ArcGIS Maps SDK for JavaScript
url System.String
URL pointing to the Elevation layer resource on an ArcGIS Image Server.
ArcGIS Maps SDK for JavaScript
visibilityTimeExtent dymaptic.GeoBlazor.Core.Components.TimeExtent
Specifies a fixed time extent during which a layer should be visible.
default null
ArcGIS Maps SDK for JavaScript
visible System.Nullable<System.Boolean>
Indicates if the layer is visible in the View.
default true
ArcGIS Maps SDK for JavaScript
Properties
ElevationLayer.Copyright Property
The copyright text as defined by the service.
ArcGIS Maps SDK for JavaScript
public string? Copyright { get; set; }
Implements Copyright
Property Value
ElevationLayer.PortalItem Property
The portal item from which the layer is loaded.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.PortalItem? PortalItem { get; set; }
Implements PortalItem
Property Value
dymaptic.GeoBlazor.Core.Components.PortalItem
ElevationLayer.SourceJSON Property
The image service’s metadata JSON
exposed by the ArcGIS REST API.
ArcGIS Maps SDK for JavaScript
public string? SourceJSON { get; set; }
Property Value
ElevationLayer.SpatialReference Property
The spatial reference of the layer as defined by the service.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.SpatialReference? SpatialReference { get; set; }
Implements SpatialReference
Property Value
dymaptic.GeoBlazor.Core.Components.SpatialReference
ElevationLayer.TileInfo Property
Contains information about the tiling scheme for the layer.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.TileInfo? TileInfo { get; set; }
Implements TileInfo
Property Value
dymaptic.GeoBlazor.Core.Components.TileInfo
ElevationLayer.Type Property
Used internally to identify the sub type of Layer
public override dymaptic.GeoBlazor.Core.Enums.LayerType Type { get; }
Property Value
dymaptic.GeoBlazor.Core.Enums.LayerType
ElevationLayer.Url Property
URL pointing to the Elevation layer resource on an ArcGIS Image Server.
ArcGIS Maps SDK for JavaScript
public string? Url { get; set; }
Property Value
Methods
ElevationLayer.CreateElevationSampler(Extent, ElevationLayerCreateElevationSamplerOptions, CancellationToken) Method
Creates an elevation sampler for the given Extent by querying the service layer
for elevation data and caching it so values may be sampled quickly afterwards.
param options Additional query options. See the table below.
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.Pro.Components.ElevationSampler?> CreateElevationSampler(dymaptic.GeoBlazor.Core.Components.Geometries.Extent extent, dymaptic.GeoBlazor.Pro.Options.ElevationLayerCreateElevationSamplerOptions options, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));
Parameters
extent dymaptic.GeoBlazor.Core.Components.Geometries.Extent
The extent for which to create the sampler.
options ElevationLayerCreateElevationSamplerOptions
- options.demResolution: Controls the horizontal resolution (cell size) in meters from which elevation data is sampled (defaults to
auto). See ElevationLayer 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<ElevationSampler>
ElevationLayer.FetchTile(double, double, double, ElevationLayerFetchTileOptions, CancellationToken) Method
Requests a tile from the service and decodes the data into a linear
array of elevation values.
param row the tile row.
param options Optional settings for the tile request.
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.Pro.Model.ElevationTileData?> FetchTile(double level, double row, double column, dymaptic.GeoBlazor.Pro.Options.ElevationLayerFetchTileOptions options, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));
Parameters
level System.Double
the tile level.
row System.Double
the tile row.
column System.Double
the tile column.
options ElevationLayerFetchTileOptions
- options.noDataValue: The value representing pixels in the tile that don’t contain an elevation value.
cancellationToken System.Threading.CancellationToken
The CancellationToken to cancel an asynchronous operation.
Returns
System.Threading.Tasks.Task<ElevationTileData>
ElevationLayer.GetCopyright() Method
Asynchronously retrieve the current value of the Copyright property.
public System.Threading.Tasks.Task<string?> GetCopyright();
Implements GetCopyright()
Returns
System.Threading.Tasks.Task<System.String>
ElevationLayer.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<dymaptic.GeoBlazor.Core.Components.PortalItem>
ElevationLayer.GetSourceJSON() Method
Asynchronously retrieve the current value of the SourceJSON property.
public System.Threading.Tasks.Task<string?> GetSourceJSON();
Returns
System.Threading.Tasks.Task<System.String>
ElevationLayer.GetSpatialReference() Method
Asynchronously retrieve the current value of the SpatialReference property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.SpatialReference?> GetSpatialReference();
Implements GetSpatialReference()
Returns
System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.SpatialReference>
ElevationLayer.GetTileInfo() Method
Asynchronously retrieve the current value of the TileInfo property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.TileInfo?> GetTileInfo();
Implements GetTileInfo()
Returns
System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.TileInfo>
ElevationLayer.GetTileUrl(double, double, double) Method
This method returns a URL to a tile for a given level, row and column.
param row The requested tile’s row.
ArcGIS Maps SDK for JavaScript
public System.Threading.Tasks.Task<string?> GetTileUrl(double level, double row, double col);
Parameters
level System.Double
The requested tile’s level.
row System.Double
The requested tile’s row.
col System.Double
The requested tile’s column.
Returns
System.Threading.Tasks.Task<System.String>
ElevationLayer.GetUrl() Method
Asynchronously retrieve the current value of the Url property.
public System.Threading.Tasks.Task<string?> GetUrl();
Returns
System.Threading.Tasks.Task<System.String>
ElevationLayer.QueryElevation(Geometry, ElevationLayerQueryElevationOptions, CancellationToken) Method
Queries the service layer for elevation values for the given geometry.
param options Additional query options. See the table below.
param options.returnSampleInfo Indicates whether to return additional sample information for each 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.Pro.Results.ElevationLayerElevationQueryResult?> QueryElevation(dymaptic.GeoBlazor.Core.Components.Geometries.Geometry geometry, dymaptic.GeoBlazor.Pro.Options.ElevationLayerQueryElevationOptions options, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken));
Parameters
geometry dymaptic.GeoBlazor.Core.Components.Geometries.Geometry
The geometry to use for sampling elevation data.
options ElevationLayerQueryElevationOptions
- 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 to use when there is no data available.
cancellationToken System.Threading.CancellationToken
The CancellationToken to cancel an asynchronous operation.
Returns
System.Threading.Tasks.Task<ElevationLayerElevationQueryResult>
ElevationLayer.SetCopyright(string) Method
Asynchronously set the value of the Copyright property after render.
public System.Threading.Tasks.Task SetCopyright(string? value);
Parameters
value System.String
The value to set.
Implements SetCopyright(string)
Returns
ElevationLayer.SetPersistenceEnabled(Nullable) Method
Asynchronously set the value of the PersistenceEnabled property after render.
public System.Threading.Tasks.Task SetPersistenceEnabled(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Implements SetPersistenceEnabled(Nullable<bool>)
Returns
ElevationLayer.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 dymaptic.GeoBlazor.Core.Components.PortalItem
The value to set.
Implements SetPortalItem(PortalItem)
Returns
ElevationLayer.SetTileInfo(TileInfo) Method
Asynchronously set the value of the TileInfo property after render.
public System.Threading.Tasks.Task SetTileInfo(dymaptic.GeoBlazor.Core.Components.TileInfo? value);
Parameters
value dymaptic.GeoBlazor.Core.Components.TileInfo
The value to set.
Implements SetTileInfo(TileInfo)
Returns
ElevationLayer.SetUrl(string) Method
Asynchronously set the value of the Url property after render.
public System.Threading.Tasks.Task SetUrl(string? value);
Parameters
value System.String
The value to set.
Returns
ElevationLayer.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()