layout: default title: ImageryTileLayer parent: Core Classes —

dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components.Layers

ImageryTileLayer Class

ImageryTileLayer presents raster data from a tiled image service. Binary imagery tiles are projected, processed, and rendered on the client-side. Tiled access is fast and scalable.
ArcGIS Maps SDK for JavaScript

public class ImageryTileLayer : dymaptic.GeoBlazor.Core.Components.Layers.Layer,
dymaptic.GeoBlazor.Core.Components.Layers.IPopupTemplateLayer

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

Implements IPopupTemplateLayer

Constructors

ImageryTileLayer() Constructor

Parameterless constructor for use as a razor component

public ImageryTileLayer();

ImageryTileLayer(string, PortalItem, IImageryRenderer, IReadOnlyCollection, Nullable, string, Effect, Nullable, Nullable, Nullable, Nullable, Nullable, IReadOnlyList, MultidimensionalSubset, Nullable, Nullable, PopupTemplate, Nullable, Dictionary<string,object>, Nullable, string) Constructor

Construct an Imagery Layer in code

public ImageryTileLayer(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, string? copyright=null, dymaptic.GeoBlazor.Core.Components.Layers.Effect? effect=null, System.Nullable<dymaptic.GeoBlazor.Core.Components.Layers.PixelInterpolation> interpolation=null, System.Nullable<bool> legendEnabled=null, System.Nullable<dymaptic.GeoBlazor.Core.Components.Layers.ListMode> listMode=null, System.Nullable<int> maxScale=null, System.Nullable<int> minScale=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Renderers.DimensionalDefinition>? multidimensionalDefinition=null, dymaptic.GeoBlazor.Core.Components.Layers.MultidimensionalSubset? multidimensionalSubset=null, System.Nullable<bool> persistenceEnabled=null, System.Nullable<bool> popupEnabled=null, dymaptic.GeoBlazor.Core.Components.Popups.PopupTemplate? popupTemplate=null, System.Nullable<bool> useViewTime=null, System.Collections.Generic.Dictionary<string,object>? customParameters=null, System.Nullable<double> opacity=null, string? title=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.

copyright System.String

The copyright text as defined by the service.

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.

interpolation System.Nullable<PixelInterpolation>

Defines how to interpolate pixel values.

legendEnabled System.Nullable<System.Boolean>

Indicates whether the layer will be included in the legend.

listMode System.Nullable<ListMode>

Determines how the layer is displayed in the LayerList widget.

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.

multidimensionalDefinition System.Collections.Generic.IReadOnlyList<DimensionalDefinition>

The multidimensional definitions associated with the layer.

multidimensionalSubset MultidimensionalSubset

A subset of multidimensional raster data created by slicing the data along defined variables and dimensions.

persistenceEnabled System.Nullable<System.Boolean>

Enable persistence of the layer in a WebMap or WebScene.

popupEnabled System.Nullable<System.Boolean>

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

popupTemplate PopupTemplate

The PopupTemplate for the layer.

useViewTime System.Nullable<System.Boolean>

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

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.

opacity System.Nullable<System.Double>

The opacity of the layer.

title System.String

The title of the layer.

Properties

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

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

ImageryTileLayer.Copyright Property

The copyright text as defined by the service.

public string? Copyright { get; set; }

Property Value

System.String

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

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

ImageryTileLayer.Interpolation Property

Defines how to interpolate pixel values. By default, this will be set to the service’s resampling method, if it has one. If the service does not have a default resampling method, the bilinear resampling will be used in most cases. However, if the image service’s cacheType is Raster and the data source is thematic (as declared in the service’s keyProperties), and the service does not have a default resampling method, then the nearest interpolation type will be used.

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

Property Value

System.Nullable<PixelInterpolation>

ImageryTileLayer.LayerType Property

Used internally to identify the sub type of Layer

public override string LayerType { get; }

Property Value

System.String

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

ImageryTileLayer.MaxScale Property

The maximum scale (most zoomed in) at which the layer is visible in the view. If the map is zoomed in beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a maximum scale. The maxScale value should always be smaller than the minScale value, and greater than or equal to the service specification.

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

Property Value

System.Nullable<System.Int32>

ImageryTileLayer.MinScale Property

The minimum scale (most zoomed out) at which the layer is visible in the view. If the map is zoomed out beyond this scale, the layer will not be visible. A value of 0 means the layer does not have a minimum scale. The minScale value should always be larger than the maxScale value, and lesser than or equal to the service specification.

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

Property Value

System.Nullable<System.Int32>

ImageryTileLayer.MultidimensionalDefinition Property

The multidimensional definitions associated with the layer. Filters the layer by slicing data along defined variables and dimensions such as time, depth, altitude, etc. For example, you can display a particular variable such as temperature or salinity measured at a fixed dimension (e.g. time, depth).

public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Renderers.DimensionalDefinition> MultidimensionalDefinition { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<DimensionalDefinition>

ImageryTileLayer.MultidimensionalSubset Property

Represents a multidimensional subset of raster data. This includes subsets of both variables and dimensions. When the multidimensionalSubset is defined on a layer, the multidimensionalDefinition must be within the defined multidimensionalSubset, otherwise nothing will be displayed.

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

Property Value

MultidimensionalSubset

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

ImageryTileLayer.PopupTemplate Property

The PopupTemplate for the layer.

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

Implements PopupTemplate

Property Value

PopupTemplate

ImageryTileLayer.PortalItem Property

The portal item for the Imagery Layer source data.

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

Property Value

PortalItem

ImageryTileLayer.Renderer Property

An interface that implements the various imagery renderers.

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

Property Value

IImageryRenderer

ImageryTileLayer.TileInfo Property

The tiling scheme information for the layer.

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

Property Value

TileInfo

ImageryTileLayer.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.
Default Value: null

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

Property Value

TimeExtent

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

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

ImageryTileLayer.Url Property

The url for the Imagery Layer source data.

public string? Url { get; set; }

Property Value

System.String

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

ImageryTileLayer.GetServiceRasterInfo() Method

Retrieves the RasterInfo for the layer from the server.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Layers.RasterInfo?> GetServiceRasterInfo();

Returns

System.Threading.Tasks.Task<RasterInfo>

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

ImageryTileLayer.SetRenderer(IImageryRenderer) Method

Updates the renderer after initial render.

public System.Threading.Tasks.Task SetRenderer(dymaptic.GeoBlazor.Core.Components.Renderers.IImageryRenderer renderer);

Parameters

renderer IImageryRenderer

Returns

System.Threading.Tasks.Task

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