layout: default title: ImageryLayer parent: Core Classes —

dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components.Layers

ImageryLayer Class

Represents a dynamic image service resource as a layer. An ImageryLayer retrieves and displays data from dynamic image services. An image service supports
accessing the mosaicked image, its catalog, and the individual rasters in the catalog. An image service supports dynamic access and tiled access.
ArcGIS Maps SDK for JavaScript

public class ImageryLayer : dymaptic.GeoBlazor.Core.Components.Layers.Layer

Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Layer 🡒 ImageryLayer

Constructors

ImageryLayer() Constructor

Parameterless constructor for use as a razor component

public ImageryLayer();

ImageryLayer(string, PortalItem, IImageryRenderer, IReadOnlyCollection, Nullable, Nullable, Nullable, string, string, Effect, Nullable, Nullable, Nullable, Nullable, Nullable, Nullable, Nullable, Nullable, IReadOnlyCollection, string, string, Nullable, Nullable, Nullable, Nullable, Nullable, TileInfo, TimeExtent, TimeInfo, TimeInterval, string, Nullable, Nullable, Nullable, Dictionary<string,object>, Extent) Constructor

Construct an Imagery Layer in code

public ImageryLayer(string? url=null, dymaptic.GeoBlazor.Core.Components.PortalItem? portalItem=null, dymaptic.GeoBlazor.Core.Components.Renderers.IImageryRenderer? renderer=null, System.Collections.Generic.IReadOnlyCollection<int>? bandIds=null, System.Nullable<dymaptic.GeoBlazor.Core.Components.Layers.BlendMode> blendMode=null, System.Nullable<int> compressionQuality=null, System.Nullable<double> compressionTolerance=null, string? copyright=null, string? definitionExpression=null, dymaptic.GeoBlazor.Core.Components.Layers.Effect? effect=null, System.Nullable<dymaptic.GeoBlazor.Core.Components.Layers.ImageFormat> format=null, System.Nullable<bool> hasMultidimensions=null, System.Nullable<int> imageMaxHeight=null, System.Nullable<int> imageMaxWidth=null, System.Nullable<int> interpolation=null, System.Nullable<bool> legendEnabled=null, System.Nullable<int> maxScale=null, System.Nullable<int> minScale=null, System.Collections.Generic.IReadOnlyCollection<int>? noData=null, string? noDataInterpretation=null, string? objectIdField=null, System.Nullable<bool> persistenceEnabled=null, System.Nullable<dymaptic.GeoBlazor.Core.Components.Layers.PixelType> pixelType=null, System.Nullable<bool> popupEnabled=null, System.Nullable<double> refreshInterval=null, System.Nullable<bool> useViewTime=null, dymaptic.GeoBlazor.Core.Components.Layers.TileInfo? tileInfo=null, dymaptic.GeoBlazor.Core.Objects.TimeExtent? timeExtent=null, dymaptic.GeoBlazor.Core.Components.Layers.TimeInfo? timeInfo=null, dymaptic.GeoBlazor.Core.Objects.TimeInterval? timeOffset=null, string? title=null, System.Nullable<double> opacity=null, System.Nullable<dymaptic.GeoBlazor.Core.Components.Layers.ListMode> listMode=null, System.Nullable<bool> visible=null, System.Collections.Generic.Dictionary<string,object>? customParameters=null, dymaptic.GeoBlazor.Core.Components.Geometries.Extent? fullExtent=null);

Parameters

url System.String

The url for the Imagery Layer source data.

portalItem PortalItem

The portal item for the Imagery Layer source data.

renderer IImageryRenderer

An interface that implements the various imagery renderers.

bandIds System.Collections.Generic.IReadOnlyCollection<System.Int32>

Defines a band combination using 0-based band indexes.

blendMode System.Nullable<BlendMode>

Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer.

compressionQuality System.Nullable<System.Int32>

The compression quality value.

compressionTolerance System.Nullable<System.Double>

Controls the tolerance of the lerc compression algorithm.

copyright System.String

The SQL where clause used to filter rasters.

definitionExpression System.String

The SQL where clause used to filter rasters.

effect Effect

Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to how image filters work.

format System.Nullable<ImageFormat>

The format of the exported image.

hasMultidimensions System.Nullable<System.Boolean>

Indicates if the layer has multidimensionalInfo.

imageMaxHeight System.Nullable<System.Int32>

Indicates the maximum height of the image exported by the service.

imageMaxWidth System.Nullable<System.Int32>

Indicates the maximum width of the image exported by the service.

interpolation System.Nullable<System.Int32>

Defines how to interpolate pixel values.

legendEnabled System.Nullable<System.Boolean>

Indicates whether the layer will be included in the legend.

maxScale System.Nullable<System.Int32>

The maximum scale (most zoomed in) at which the layer is visible in the view.

minScale System.Nullable<System.Int32>

The minimum scale (most zoomed out) at which the layer is visible in the view.

noData System.Collections.Generic.IReadOnlyCollection<System.Int32>

The pixel value representing no available information.

noDataInterpretation System.String

Interpretation of the noData setting.

objectIdField System.String

The name of an oid field containing a unique value or identifier for each raster in the layer..

persistenceEnabled System.Nullable<System.Boolean>

Enable persistence of the layer in a WebMap or WebScene.

pixelType System.Nullable<PixelType>

Raster source pixel type.

popupEnabled System.Nullable<System.Boolean>

Indicates whether to display popups when features in the layer are clicked.

refreshInterval System.Nullable<System.Double>

Refresh interval of the layer in minutes. Value of 0 indicates no refresh.

useViewTime System.Nullable<System.Boolean>

Determines if the layer will update its temporal data based on the view’s timeExtent.

tileInfo TileInfo

The tiling scheme information for the layer.

timeExtent TimeExtent

The layer’s time extent. When the layer’s useViewTime is false, the layer instructs the view to show data from the layer based on this time extent. If the useViewTime is true, and both layer and view time extents are set, then features that fall within the intersection of the view and layer time extents will be displayed. For example, if the layer’s time extent is set to display features between 1970 and 1975 and the view has a time extent set to 1972-1980, the effective time on the feature layer will be 1972-1975.

timeInfo TimeInfo

TimeInfo provides information such as date fields that store start and end time for each feature and the fullTimeExtent for the layer.

timeOffset TimeInterval

A temporary offset of the time data based on a certain TimeInterval. This allows users to overlay features from two or more time-aware layers with different time extents. For example, if a layer has data recorded for the year 1970, an offset value of 2 years would temporarily shift the data to 1972. You can then overlay this data with data recorded in 1972. A time offset can be used for display purposes only. The query and selection are not affected by the offset.

title System.String

The title of the layer.

opacity System.Nullable<System.Double>

The opacity of the layer.

listMode System.Nullable<ListMode>

The list mode of the layer.

visible System.Nullable<System.Boolean>

The visibility of the layer.

customParameters System.Collections.Generic.Dictionary<System.String,System.Object>

A list of custom parameters appended to the URL of all resources fetched by the layer. It’s an object with key-value pairs where value is a string. The layer’s refresh() method needs to be called if the customParameters are updated at runtime.

fullExtent Extent

The full extent of the layer.

Properties

ImageryLayer.BandIds Property

Defines a band combination using 0-based band indexes.

public System.Collections.Generic.IReadOnlyCollection<int>? BandIds { get; set; }

Property Value

System.Collections.Generic.IReadOnlyCollection<System.Int32>

ImageryLayer.BlendMode Property

Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer.

public System.Nullable<dymaptic.GeoBlazor.Core.Components.Layers.BlendMode> BlendMode { get; set; }

Property Value

System.Nullable<BlendMode>

ImageryLayer.CompressionQuality Property

The compression quality value.

public System.Nullable<int> CompressionQuality { get; set; }

Property Value

System.Nullable<System.Int32>

ImageryLayer.CompressionTolerance Property

Controls the tolerance of the lerc compression algorithm.

public System.Nullable<double> CompressionTolerance { get; set; }

Property Value

System.Nullable<System.Double>

ImageryLayer.Copyright Property

The copyright text as defined by the service.

public string? Copyright { get; set; }

Property Value

System.String

ImageryLayer.CustomParameters Property

A list of custom parameters appended to the URL of all resources fetched by the layer. It’s an object with key-value pairs where value is a string. The layer’s refresh() method needs to be called if the customParameters are updated at runtime.

public System.Collections.Generic.Dictionary<string,object>? CustomParameters { get; set; }

Property Value

System.Collections.Generic.Dictionary<System.String,System.Object>

ImageryLayer.DefinitionExpression Property

The SQL where clause used to filter rasters.

public string? DefinitionExpression { get; set; }

Property Value

System.String

ImageryLayer.Effect Property

Effect provides various filter functions that can be performed on the layer to achieve different visual effects similar to how image filters work.

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

Property Value

Effect

ImageryLayer.Format Property

The format of the exported image.

public System.Nullable<dymaptic.GeoBlazor.Core.Components.Layers.ImageFormat> Format { get; set; }

Property Value

System.Nullable<ImageFormat>

ImageryLayer.HasMultidimensions Property

Indicates if the layer has multidimensionalInfo.

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

Property Value

System.Nullable<System.Boolean>

ImageryLayer.ImageMaxHeight Property

Indicates the maximum height of the image exported by the service.

public System.Nullable<int> ImageMaxHeight { get; set; }

Property Value

System.Nullable<System.Int32>

ImageryLayer.ImageMaxWidth Property

Indicates the maximum width of the image exported by the service.

public System.Nullable<int> ImageMaxWidth { get; set; }

Property Value

System.Nullable<System.Int32>

ImageryLayer.Interpolation Property

Defines how to interpolate pixel values.

public System.Nullable<int> Interpolation { get; set; }

Property Value

System.Nullable<System.Int32>

ImageryLayer.LayerType Property

Used internally to identify the sub type of Layer

public override string LayerType { get; }

Property Value

System.String

ImageryLayer.LegendEnabled Property

Indicates whether the layer will be included in the legend.

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

Property Value

System.Nullable<System.Boolean>

ImageryLayer.MaxScale Property

The maximum scale (most zoomed in) at which the layer is visible in the view.

public System.Nullable<int> MaxScale { get; set; }

Property Value

System.Nullable<System.Int32>

ImageryLayer.MinScale Property

The minimum scale (most zoomed out) at which the layer is visible in the view.

public System.Nullable<int> MinScale { get; set; }

Property Value

System.Nullable<System.Int32>

ImageryLayer.NoData Property

The pixel value representing no available information.

public System.Collections.Generic.IReadOnlyCollection<int>? NoData { get; set; }

Property Value

System.Collections.Generic.IReadOnlyCollection<System.Int32>

ImageryLayer.NoDataInterpretation Property

Interpretation of the noData setting.

public string? NoDataInterpretation { get; set; }

Property Value

System.String

ImageryLayer.ObjectIdField Property

The name of an oid field containing a unique value or identifier for each raster in the layer..

public string? ObjectIdField { get; set; }

Property Value

System.String

ImageryLayer.PixelType Property

Raster source pixel type.

public System.Nullable<dymaptic.GeoBlazor.Core.Components.Layers.PixelType> PixelType { get; set; }

Property Value

System.Nullable<PixelType>

ImageryLayer.PopupEnabled Property

Indicates whether to display popups when features in the layer are clicked.

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

Property Value

System.Nullable<System.Boolean>

ImageryLayer.PortalItem Property

The portal item for the Imagery Layer source data.

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

Property Value

PortalItem

ImageryLayer.RefreshInterval Property

Refresh interval of the layer in minutes. Value of 0 indicates no refresh.

public System.Nullable<double> RefreshInterval { get; set; }

Property Value

System.Nullable<System.Double>

ImageryLayer.Renderer Property

An interface that implements the various imagery renderers.

public dymaptic.GeoBlazor.Core.Components.Renderers.IImageryRenderer? Renderer { get; set; }

Property Value

IImageryRenderer

ImageryLayer.TileInfo Property

The tiling scheme information for the layer.

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

Property Value

TileInfo

ImageryLayer.TimeExtent Property

The layer’s time extent. When the layer’s useViewTime is false, the layer instructs the view to show data from the layer based on this time extent. If the useViewTime is true, and both layer and view time extents are set, then features that fall within the intersection of the view and layer time extents will be displayed. For example, if the layer’s time extent is set to display features between 1970 and 1975 and the view has a time extent set to 1972-1980, the effective time on the feature layer will be 1972-1975.

public dymaptic.GeoBlazor.Core.Objects.TimeExtent? TimeExtent { get; set; }

Property Value

TimeExtent

ImageryLayer.TimeInfo Property

TimeInfo provides information such as date fields that store start and end time for each feature and the fullTimeExtent for the layer.
Default Value:null

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

Property Value

TimeInfo

ImageryLayer.TimeOffset Property

A temporary offset of the time data based on a certain TimeInterval. This allows users to overlay features from two or more time-aware layers with different time extents. For example, if a layer has data recorded for the year 1970, an offset value of 2 years would temporarily shift the data to 1972. You can then overlay this data with data recorded in 1972. A time offset can be used for display purposes only. The query and selection are not affected by the offset.
Default Value:null

public dymaptic.GeoBlazor.Core.Objects.TimeInterval? TimeOffset { get; set; }

Property Value

TimeInterval

ImageryLayer.Url Property

The url for the Imagery Layer source data.

public string? Url { get; set; }

Property Value

System.String

ImageryLayer.UseViewTime Property

Determines if the layer will update its temporal data based on the view’s timeExtent.

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

Property Value

System.Nullable<System.Boolean>

Methods

ImageryLayer.RegisterChildComponent(MapComponent) Method

Called from dymaptic.GeoBlazor.Core.Components.MapComponent.OnInitializedAsync to “Register” the current component with it’s 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.

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