dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components.Layers

MapImageLayer Class

MapImageLayer allows you to display and analyze data from
sublayers defined in a
map service, exporting images
instead of features.
ArcGIS Maps SDK for JavaScript

public class MapImageLayer : dymaptic.GeoBlazor.Core.Components.Layers.Layer,
dymaptic.GeoBlazor.Core.Interfaces.IArcGISMapService,
dymaptic.GeoBlazor.Core.Interfaces.IMapComponent,
dymaptic.GeoBlazor.Core.Interfaces.IBlendLayer,
dymaptic.GeoBlazor.Core.Interfaces.ICustomParametersMixin,
dymaptic.GeoBlazor.Core.Interfaces.IOperationalLayer,
dymaptic.GeoBlazor.Core.Interfaces.IRefreshableLayer,
dymaptic.GeoBlazor.Core.Interfaces.IScaleRangeLayer,
dymaptic.GeoBlazor.Core.Interfaces.ITemporalLayer

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

Implements IArcGISMapService, IMapComponent, IBlendLayer, ICustomParametersMixin, IOperationalLayer, IRefreshableLayer, IScaleRangeLayer, ITemporalLayer

Constructors

MapImageLayer() Constructor

Parameterless constructor for use as a Razor Component.

public MapImageLayer();

MapImageLayer(string, PortalItem, Nullable, Dictionary<string,object>, Nullable, Effect, string, Nullable, Nullable, Nullable, Nullable, Nullable, Nullable, Nullable, Nullable, Nullable, TimeExtent, TimeInfo, Nullable, IReadOnlyList, Nullable, Nullable, Nullable, string, string, Extent, Nullable, IReadOnlyList, TimeInterval, string, TimeExtent) Constructor

Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.

public MapImageLayer(string? url=null, dymaptic.GeoBlazor.Core.Components.PortalItem? portalItem=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.BlendMode> blendMode=null, System.Collections.Generic.Dictionary<string,object>? customParameters=null, System.Nullable<double> dpi=null, dymaptic.GeoBlazor.Core.Model.Effect? effect=null, string? gdbVersion=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.MapImageFormat> imageFormat=null, System.Nullable<int> imageMaxHeight=null, System.Nullable<int> imageMaxWidth=null, System.Nullable<bool> imageTransparency=null, System.Nullable<bool> legendEnabled=null, System.Nullable<double> maxScale=null, System.Nullable<double> minScale=null, System.Nullable<bool> persistenceEnabled=null, System.Nullable<double> refreshInterval=null, dymaptic.GeoBlazor.Core.Components.TimeExtent? timeExtent=null, dymaptic.GeoBlazor.Core.Components.TimeInfo? timeInfo=null, System.Nullable<bool> useViewTime=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Sublayer>? sublayers=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.ListMode> listMode=null, System.Nullable<bool> visible=null, System.Nullable<double> opacity=null, string? arcGISLayerId=null, string? copyright=null, dymaptic.GeoBlazor.Core.Components.Geometries.Extent? fullExtent=null, System.Nullable<bool> isBasemapReferenceLayer=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Sublayer>? subtables=null, dymaptic.GeoBlazor.Core.Components.TimeInterval? timeOffset=null, string? title=null, dymaptic.GeoBlazor.Core.Components.TimeExtent? visibilityTimeExtent=null);

Parameters

url System.String

The URL to the REST endpoint of the map service.
ArcGIS Maps SDK for JavaScript

portalItem PortalItem

The portal item from which the layer is loaded.
ArcGIS Maps SDK for JavaScript

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.
default normal
ArcGIS Maps SDK for JavaScript

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.
ArcGIS Maps SDK for JavaScript

dpi System.Nullable<System.Double>

The output dots per inch (DPI) of the MapImageLayer.
default 96
ArcGIS Maps SDK for JavaScript

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.
default null
ArcGIS Maps SDK for JavaScript

gdbVersion System.String

The version of the geodatabase of the map service data.
ArcGIS Maps SDK for JavaScript

imageFormat System.Nullable<MapImageFormat>

The output image type.
default “png24”
ArcGIS Maps SDK for JavaScript

imageMaxHeight System.Nullable<System.Int32>

Indicates the maximum height of the image exported by the service.
default 2048
ArcGIS Maps SDK for JavaScript

imageMaxWidth System.Nullable<System.Int32>

Indicates the maximum width of the image exported by the service.
default 2048
ArcGIS Maps SDK for JavaScript

imageTransparency System.Nullable<System.Boolean>

Indicates whether the background of the image exported by the service is transparent.
default true
ArcGIS Maps SDK for JavaScript

legendEnabled System.Nullable<System.Boolean>

Indicates whether the layer will be included in the legend.
default true
ArcGIS Maps SDK for JavaScript

maxScale System.Nullable<System.Double>

The maximum scale (most zoomed in) at which the layer is visible in the view.
default 0
ArcGIS Maps SDK for JavaScript

minScale System.Nullable<System.Double>

The minimum scale (most zoomed out) at which the layer is visible in the view.
default 0
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

refreshInterval System.Nullable<System.Double>

Refresh interval of the layer in minutes.
default 0
ArcGIS Maps SDK for JavaScript

timeExtent TimeExtent

The layer’s time extent.
default null
ArcGIS Maps SDK for JavaScript

timeInfo TimeInfo

TimeInfo provides information such as date fields that store
start
and end time
for each feature and the fullTimeExtent
for the layer.
default null
ArcGIS Maps SDK for JavaScript

useViewTime System.Nullable<System.Boolean>

Determines if the time enabled layer will update its temporal data based on the view’s timeExtent.
default true
ArcGIS Maps SDK for JavaScript

sublayers System.Collections.Generic.IReadOnlyList<Sublayer>

A Collection of Sublayer objects
that allow you to alter
the properties of one or more sublayers of the MapImageLayer.
ArcGIS Maps SDK for JavaScript

listMode System.Nullable<ListMode>

Indicates how the layer should display in the LayerList widget.
default “show”
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

opacity System.Nullable<System.Double>

The opacity of the layer.
default 1
ArcGIS Maps SDK for JavaScript

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 Extent

The full extent of the layer as defined by the map service.
ArcGIS Maps SDK for JavaScript

isBasemapReferenceLayer System.Nullable<System.Boolean>

Indicates whether the layer is a basemap reference layer. Default value: false.

subtables System.Collections.Generic.IReadOnlyList<Sublayer>

A flat Collection of all the tables
in the layer including the tables of its sublayers.
ArcGIS Maps SDK for JavaScript

timeOffset TimeInterval

A temporary offset of the time data based on a certain TimeInterval.
default null
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

visibilityTimeExtent TimeExtent

Specifies a fixed time extent during which a layer should be visible.
default null
ArcGIS Maps SDK for JavaScript

Properties

MapImageLayer.AllSublayers Property

A flat Collection of all the sublayers
in the MapImageLayer including the sublayers of its sublayers.
ArcGIS Maps SDK for JavaScript

public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Sublayer>? AllSublayers { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<Sublayer>

MapImageLayer.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. Unlike the method of using transparency which can result in a washed-out top layer, blend modes can create a variety of very vibrant and intriguing results by blending a layer with the layer(s) below it.

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

Implements BlendMode

Property Value

System.Nullable<BlendMode>

MapImageLayer.Capabilities Property

Indicates the layer’s supported capabilities.
ArcGIS Maps SDK for JavaScript

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

Implements Capabilities

Property Value

ArcGISMapServiceCapabilities

MapImageLayer.Copyright Property

The copyright text as defined by the service.
ArcGIS Maps SDK for JavaScript

public string? Copyright { get; set; }

Implements Copyright

Property Value

System.String

MapImageLayer.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; }

Implements CustomParameters

Property Value

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

MapImageLayer.DateFieldsTimeZone Property

The time zone that dates are stored in.
ArcGIS Maps SDK for JavaScript

public string? DateFieldsTimeZone { get; set; }

Property Value

System.String

MapImageLayer.DatesInUnknownTimezone Property

This property is set by the service publisher and indicates that dates should be considered without the local timezone.
default false
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Nullable<System.Boolean>

MapImageLayer.Dpi Property

The output dots per inch (DPI) of the MapImageLayer.
default 96
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Nullable<System.Double>

MapImageLayer.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. This powerful capability allows you to apply css filter-like functions to layers to create custom visual effects to enhance the cartographic quality of your maps. This is done by applying the desired effect to the layer’s effect property as a string or an array of objects to set scale dependent effects.

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

Implements Effect

Property Value

Effect

MapImageLayer.GdbVersion Property

The version of the geodatabase of the map service data. Read the Overview of versioning topic for more details about this capability.

public string? GdbVersion { get; set; }

Property Value

System.String

MapImageLayer.HasRefreshListener Property

Used in JavaScript layer to determine if the event listener is registered.

public bool HasRefreshListener { get; }

Property Value

System.Boolean

MapImageLayer.ImageFormat Property

The output image type.
Default Value:Png24

public System.Nullable<dymaptic.GeoBlazor.Core.Enums.MapImageFormat> ImageFormat { get; set; }

Property Value

System.Nullable<MapImageFormat>

MapImageLayer.ImageMaxHeight Property

Indicates the maximum height of the image exported by the service.
Default Value: 2048

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

Property Value

System.Nullable<System.Int32>

MapImageLayer.ImageMaxWidth Property

Indicates the maximum width of the image exported by the service.
Default Value: 2048

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

Property Value

System.Nullable<System.Int32>

MapImageLayer.ImageTransparency Property

Indicates whether the background of the image exported by the service is transparent.
Default Value: true

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

Property Value

System.Nullable<System.Boolean>

MapImageLayer.LegendEnabled Property

Indicates whether the layer will be included in the legend.
Default Value: true

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

Implements LegendEnabled

Property Value

System.Nullable<System.Boolean>

MapImageLayer.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.
Default Value: 0

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

Implements MaxScale

Property Value

System.Nullable<System.Double>

MapImageLayer.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 less than or equal to the service specification.
Default Value: 0

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

Implements MinScale

Property Value

System.Nullable<System.Double>

MapImageLayer.OnRefresh Property

Fires if the layer has the refreshInterval set or when refresh() method is called.
The event payload indicates if the layer’s data has changed.

public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Events.RefreshEvent> OnRefresh { get; set; }

Property Value

Microsoft.AspNetCore.Components.EventCallback<RefreshEvent>

MapImageLayer.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; }

Property Value

PortalItem

MapImageLayer.PreferredTimeZone Property

The IANA time zone the author of the service intended data from date fields to be viewed in.
default null
ArcGIS Maps SDK for JavaScript

public string? PreferredTimeZone { get; set; }

Property Value

System.String

MapImageLayer.RefreshInterval Property

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

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

Implements RefreshInterval

Property Value

System.Nullable<System.Double>

MapImageLayer.SourceJSON Property

The map service’s metadata JSON
exposed by the ArcGIS REST API.
ArcGIS Maps SDK for JavaScript

public string? SourceJSON { get; set; }

Property Value

System.String

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

SpatialReference

MapImageLayer.Sublayers Property

A Collection of Sublayer objects
that allow you to alter
the properties of one or more sublayers of the MapImageLayer.
ArcGIS Maps SDK for JavaScript

public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Sublayer>? Sublayers { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<Sublayer>

MapImageLayer.Subtables Property

A flat Collection of all the tables
in the layer including the tables of its sublayers.
ArcGIS Maps SDK for JavaScript

public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Sublayer>? Subtables { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<Sublayer>

MapImageLayer.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.Components.TimeExtent? TimeExtent { get; set; }

Implements TimeExtent

Property Value

TimeExtent

MapImageLayer.TimeInfo Property

TimeInfo provides information such as date fields that store start and end time for each feature and the fullTimeExtent for the layer. The timeInfo property, along with its startField and endField properties, must be set at the time of layer initialization if it is being set for a CSVLayer, GeoJSONLayer or FeatureLayer initialized from client-side features. The fullTimeExtent for timeInfo is automatically calculated based on its startField and endField properties. The timeInfo parameters cannot be changed after the layer is loaded.
TimeInfo’s startField and endField can be date, date-only or timestamp-offset field type for FeatureLayer and MapImageLayer.
Default Value: null

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

Implements TimeInfo

Property Value

TimeInfo

MapImageLayer.TimeOffset Property

A temporary offset of the time data based on a certain TimeInterval.
default null
ArcGIS Maps SDK for JavaScript

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

Implements TimeOffset

Property Value

TimeInterval

MapImageLayer.Type Property

Used internally to identify the sub type of Layer

public override dymaptic.GeoBlazor.Core.Enums.LayerType Type { get; }

Property Value

LayerType

MapImageLayer.Url Property

The URL to the REST endpoint of the map service.
ArcGIS Maps SDK for JavaScript

public string? Url { get; set; }

Property Value

System.String

MapImageLayer.UseViewTime Property

Determines if the layer will update its temporal data based on the view’s timeExtent. When false, the layer will display its temporal data based on the layer’s timeExtent, regardless of changes to the view. If both view and layer time extents are set while this property is true, then the features that fall within the intersection of the view and layer time extents will be displayed. For example, if a 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: true

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

Implements UseViewTime

Property Value

System.Nullable<System.Boolean>

MapImageLayer.Version Property

The version of ArcGIS Server in which the map service is published.
ArcGIS Maps SDK for JavaScript

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

Implements Version

Property Value

System.Nullable<System.Double>

Methods

MapImageLayer.AddToSublayers(Sublayer[]) Method

Asynchronously adds elements to the Sublayers property.

public System.Threading.Tasks.Task AddToSublayers(params dymaptic.GeoBlazor.Core.Components.Layers.Sublayer[] values);

Parameters

values Sublayer[]

The elements to add.

Returns

System.Threading.Tasks.Task

MapImageLayer.AddToSubtables(Sublayer[]) Method

Asynchronously adds elements to the Subtables property.

public System.Threading.Tasks.Task AddToSubtables(params dymaptic.GeoBlazor.Core.Components.Layers.Sublayer[] values);

Parameters

values Sublayer[]

The elements to add.

Returns

System.Threading.Tasks.Task

MapImageLayer.GetAllSublayers() Method

Asynchronously retrieve the current value of the AllSublayers property.

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Sublayer>?> GetAllSublayers();

Returns

System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Sublayer>>

MapImageLayer.GetBlendMode() Method

Asynchronously retrieve the current value of the BlendMode property.

public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.BlendMode>> GetBlendMode();

Implements GetBlendMode()

Returns

System.Threading.Tasks.Task<System.Nullable<BlendMode>>

MapImageLayer.GetCapabilities() Method

Asynchronously retrieve the current value of the Capabilities property.

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

Implements GetCapabilities()

Returns

System.Threading.Tasks.Task<ArcGISMapServiceCapabilities>

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

MapImageLayer.GetCustomParameters() Method

Asynchronously retrieve the current value of the CustomParameters property.

public System.Threading.Tasks.Task<System.Collections.Generic.Dictionary<string,object>?> GetCustomParameters();

Implements GetCustomParameters()

Returns

System.Threading.Tasks.Task<System.Collections.Generic.Dictionary<System.String,System.Object>>

MapImageLayer.GetDateFieldsTimeZone() Method

Asynchronously retrieve the current value of the DateFieldsTimeZone property.

public System.Threading.Tasks.Task<string?> GetDateFieldsTimeZone();

Returns

System.Threading.Tasks.Task<System.String>

MapImageLayer.GetDatesInUnknownTimezone() Method

Asynchronously retrieve the current value of the DatesInUnknownTimezone property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetDatesInUnknownTimezone();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

MapImageLayer.GetDpi() Method

Asynchronously retrieve the current value of the Dpi property.

public System.Threading.Tasks.Task<System.Nullable<double>> GetDpi();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Double>>

MapImageLayer.GetEffect() Method

Asynchronously retrieve the current value of the Effect property.

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

Implements GetEffect()

Returns

System.Threading.Tasks.Task<Effect>

MapImageLayer.GetGdbVersion() Method

Asynchronously retrieve the current value of the GdbVersion property.

public System.Threading.Tasks.Task<string?> GetGdbVersion();

Returns

System.Threading.Tasks.Task<System.String>

MapImageLayer.GetImageFormat() Method

Asynchronously retrieve the current value of the ImageFormat property.

public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.MapImageFormat>> GetImageFormat();

Returns

System.Threading.Tasks.Task<System.Nullable<MapImageFormat>>

MapImageLayer.GetImageMaxHeight() Method

Asynchronously retrieve the current value of the ImageMaxHeight property.

public System.Threading.Tasks.Task<System.Nullable<int>> GetImageMaxHeight();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Int32>>

MapImageLayer.GetImageMaxWidth() Method

Asynchronously retrieve the current value of the ImageMaxWidth property.

public System.Threading.Tasks.Task<System.Nullable<int>> GetImageMaxWidth();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Int32>>

MapImageLayer.GetImageTransparency() Method

Asynchronously retrieve the current value of the ImageTransparency property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetImageTransparency();

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

MapImageLayer.GetLegendEnabled() Method

Asynchronously retrieve the current value of the LegendEnabled property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetLegendEnabled();

Implements GetLegendEnabled()

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

MapImageLayer.GetMaxScale() Method

Asynchronously retrieve the current value of the MaxScale property.

public System.Threading.Tasks.Task<System.Nullable<double>> GetMaxScale();

Implements GetMaxScale()

Returns

System.Threading.Tasks.Task<System.Nullable<System.Double>>

MapImageLayer.GetMinScale() Method

Asynchronously retrieve the current value of the MinScale property.

public System.Threading.Tasks.Task<System.Nullable<double>> GetMinScale();

Implements GetMinScale()

Returns

System.Threading.Tasks.Task<System.Nullable<System.Double>>

MapImageLayer.GetPortalItem() Method

Asynchronously retrieve the current value of the PortalItem property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.PortalItem?> GetPortalItem();

Returns

System.Threading.Tasks.Task<PortalItem>

MapImageLayer.GetPreferredTimeZone() Method

Asynchronously retrieve the current value of the PreferredTimeZone property.

public System.Threading.Tasks.Task<string?> GetPreferredTimeZone();

Returns

System.Threading.Tasks.Task<System.String>

MapImageLayer.GetRefreshInterval() Method

Asynchronously retrieve the current value of the RefreshInterval property.

public System.Threading.Tasks.Task<System.Nullable<double>> GetRefreshInterval();

Implements GetRefreshInterval()

Returns

System.Threading.Tasks.Task<System.Nullable<System.Double>>

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

MapImageLayer.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<SpatialReference>

MapImageLayer.GetSublayers() Method

Asynchronously retrieve the current value of the Sublayers property.

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Sublayer>?> GetSublayers();

Returns

System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Sublayer>>

MapImageLayer.GetSubtables() Method

Asynchronously retrieve the current value of the Subtables property.

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Sublayer>?> GetSubtables();

Returns

System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<Sublayer>>

MapImageLayer.GetTimeExtent() Method

Asynchronously retrieve the current value of the TimeExtent property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.TimeExtent?> GetTimeExtent();

Implements GetTimeExtent()

Returns

System.Threading.Tasks.Task<TimeExtent>

MapImageLayer.GetTimeInfo() Method

Asynchronously retrieve the current value of the TimeInfo property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.TimeInfo?> GetTimeInfo();

Implements GetTimeInfo()

Returns

System.Threading.Tasks.Task<TimeInfo>

MapImageLayer.GetTimeOffset() Method

Asynchronously retrieve the current value of the TimeOffset property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.TimeInterval?> GetTimeOffset();

Implements GetTimeOffset()

Returns

System.Threading.Tasks.Task<TimeInterval>

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

MapImageLayer.GetUseViewTime() Method

Asynchronously retrieve the current value of the UseViewTime property.

public System.Threading.Tasks.Task<System.Nullable<bool>> GetUseViewTime();

Implements GetUseViewTime()

Returns

System.Threading.Tasks.Task<System.Nullable<System.Boolean>>

MapImageLayer.GetVersion() Method

Asynchronously retrieve the current value of the Version property.

public System.Threading.Tasks.Task<System.Nullable<double>> GetVersion();

Implements GetVersion()

Returns

System.Threading.Tasks.Task<System.Nullable<System.Double>>

MapImageLayer.OnJsRefresh(IJSStreamReference) Method

JavaScript-Invokable Method for internal use only.

public System.Threading.Tasks.Task OnJsRefresh(Microsoft.JSInterop.IJSStreamReference jsStreamRef);

Parameters

jsStreamRef Microsoft.JSInterop.IJSStreamReference

Returns

System.Threading.Tasks.Task

MapImageLayer.Refresh() Method

Fetches all the data for the layer.
ArcGIS Maps SDK for JavaScript

public override System.Threading.Tasks.ValueTask Refresh();

Implements Refresh()

Returns

System.Threading.Tasks.ValueTask

MapImageLayer.RegisterChildComponent(MapComponent) Method

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

MapImageLayer.RemoveFromSublayers(Sublayer[]) Method

Asynchronously remove an element from the Sublayers property.

public System.Threading.Tasks.Task RemoveFromSublayers(params dymaptic.GeoBlazor.Core.Components.Layers.Sublayer[] values);

Parameters

values Sublayer[]

The elements to remove.

Returns

System.Threading.Tasks.Task

MapImageLayer.RemoveFromSubtables(Sublayer[]) Method

Asynchronously remove an element from the Subtables property.

public System.Threading.Tasks.Task RemoveFromSubtables(params dymaptic.GeoBlazor.Core.Components.Layers.Sublayer[] values);

Parameters

values Sublayer[]

The elements to remove.

Returns

System.Threading.Tasks.Task

MapImageLayer.SetBlendMode(Nullable) Method

Asynchronously set the value of the BlendMode property after render.

public System.Threading.Tasks.Task SetBlendMode(System.Nullable<dymaptic.GeoBlazor.Core.Enums.BlendMode> value);

Parameters

value System.Nullable<BlendMode>

The value to set.

Implements SetBlendMode(Nullable<BlendMode>)

Returns

System.Threading.Tasks.Task

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

System.Threading.Tasks.Task

MapImageLayer.SetCustomParameters(Dictionary<string,object>) Method

Asynchronously set the value of the CustomParameters property after render.

public System.Threading.Tasks.Task SetCustomParameters(System.Collections.Generic.Dictionary<string,object>? value);

Parameters

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

The value to set.

Implements SetCustomParameters(Dictionary<string,object>)

Returns

System.Threading.Tasks.Task

MapImageLayer.SetDpi(Nullable) Method

Asynchronously set the value of the Dpi property after render.

public System.Threading.Tasks.Task SetDpi(System.Nullable<double> value);

Parameters

value System.Nullable<System.Double>

The value to set.

Returns

System.Threading.Tasks.Task

MapImageLayer.SetEffect(Effect) Method

Asynchronously set the value of the Effect property after render.

public System.Threading.Tasks.Task SetEffect(dymaptic.GeoBlazor.Core.Model.Effect? value);

Parameters

value Effect

The value to set.

Implements SetEffect(Effect)

Returns

System.Threading.Tasks.Task

MapImageLayer.SetGdbVersion(string) Method

Asynchronously set the value of the GdbVersion property after render.

public System.Threading.Tasks.Task SetGdbVersion(string? value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

MapImageLayer.SetImageFormat(Nullable) Method

Asynchronously set the value of the ImageFormat property after render.

public System.Threading.Tasks.Task SetImageFormat(System.Nullable<dymaptic.GeoBlazor.Core.Enums.MapImageFormat> value);

Parameters

value System.Nullable<MapImageFormat>

The value to set.

Returns

System.Threading.Tasks.Task

MapImageLayer.SetImageMaxHeight(Nullable) Method

Asynchronously set the value of the ImageMaxHeight property after render.

public System.Threading.Tasks.Task SetImageMaxHeight(System.Nullable<int> value);

Parameters

value System.Nullable<System.Int32>

The value to set.

Returns

System.Threading.Tasks.Task

MapImageLayer.SetImageMaxWidth(Nullable) Method

Asynchronously set the value of the ImageMaxWidth property after render.

public System.Threading.Tasks.Task SetImageMaxWidth(System.Nullable<int> value);

Parameters

value System.Nullable<System.Int32>

The value to set.

Returns

System.Threading.Tasks.Task

MapImageLayer.SetImageTransparency(Nullable) Method

Asynchronously set the value of the ImageTransparency property after render.

public System.Threading.Tasks.Task SetImageTransparency(System.Nullable<bool> value);

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

MapImageLayer.SetLegendEnabled(Nullable) Method

Asynchronously set the value of the LegendEnabled property after render.

public System.Threading.Tasks.Task SetLegendEnabled(System.Nullable<bool> value);

Parameters

value System.Nullable<System.Boolean>

The value to set.

Implements SetLegendEnabled(Nullable<bool>)

Returns

System.Threading.Tasks.Task

MapImageLayer.SetMaxScale(Nullable) Method

Asynchronously set the value of the MaxScale property after render.

public System.Threading.Tasks.Task SetMaxScale(System.Nullable<double> value);

Parameters

value System.Nullable<System.Double>

The value to set.

Implements SetMaxScale(Nullable<double>)

Returns

System.Threading.Tasks.Task

MapImageLayer.SetMinScale(Nullable) Method

Asynchronously set the value of the MinScale property after render.

public System.Threading.Tasks.Task SetMinScale(System.Nullable<double> value);

Parameters

value System.Nullable<System.Double>

The value to set.

Implements SetMinScale(Nullable<double>)

Returns

System.Threading.Tasks.Task

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

System.Threading.Tasks.Task

MapImageLayer.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 PortalItem

The value to set.

Returns

System.Threading.Tasks.Task

MapImageLayer.SetRefreshInterval(Nullable) Method

Asynchronously set the value of the RefreshInterval property after render.

public System.Threading.Tasks.Task SetRefreshInterval(System.Nullable<double> value);

Parameters

value System.Nullable<System.Double>

The value to set.

Implements SetRefreshInterval(Nullable<double>)

Returns

System.Threading.Tasks.Task

MapImageLayer.SetSublayers(IReadOnlyList) Method

Asynchronously set the value of the Sublayers property after render.

public System.Threading.Tasks.Task SetSublayers(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Sublayer>? value);

Parameters

value System.Collections.Generic.IReadOnlyList<Sublayer>

The value to set.

Returns

System.Threading.Tasks.Task

MapImageLayer.SetSubtables(IReadOnlyList) Method

Asynchronously set the value of the Subtables property after render.

public System.Threading.Tasks.Task SetSubtables(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Layers.Sublayer>? value);

Parameters

value System.Collections.Generic.IReadOnlyList<Sublayer>

The value to set.

Returns

System.Threading.Tasks.Task

MapImageLayer.SetTimeExtent(TimeExtent) Method

Asynchronously set the value of the TimeExtent property after render.

public System.Threading.Tasks.Task SetTimeExtent(dymaptic.GeoBlazor.Core.Components.TimeExtent? value);

Parameters

value TimeExtent

The value to set.

Implements SetTimeExtent(TimeExtent)

Returns

System.Threading.Tasks.Task

MapImageLayer.SetTimeInfo(TimeInfo) Method

Asynchronously set the value of the TimeInfo property after render.

public System.Threading.Tasks.Task SetTimeInfo(dymaptic.GeoBlazor.Core.Components.TimeInfo? value);

Parameters

value TimeInfo

The value to set.

Implements SetTimeInfo(TimeInfo)

Returns

System.Threading.Tasks.Task

MapImageLayer.SetTimeOffset(TimeInterval) Method

Asynchronously set the value of the TimeOffset property after render.

public System.Threading.Tasks.Task SetTimeOffset(dymaptic.GeoBlazor.Core.Components.TimeInterval? value);

Parameters

value TimeInterval

The value to set.

Implements SetTimeOffset(TimeInterval)

Returns

System.Threading.Tasks.Task

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

System.Threading.Tasks.Task

MapImageLayer.SetUseViewTime(Nullable) Method

Asynchronously set the value of the UseViewTime property after render.

public System.Threading.Tasks.Task SetUseViewTime(System.Nullable<bool> value);

Parameters

value System.Nullable<System.Boolean>

The value to set.

Implements SetUseViewTime(Nullable<bool>)

Returns

System.Threading.Tasks.Task

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

MapImageLayer.ValidateRequiredGeneratedChildren() Method

Validates source-generated child components.

public override void ValidateRequiredGeneratedChildren();

Implements ValidateRequiredGeneratedChildren()