dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components.Layers

BingMapsLayer Class

This layer supports Microsoft’s Bing tiled map content.
ArcGIS Maps SDK for JavaScript

public class BingMapsLayer : dymaptic.GeoBlazor.Core.Components.Layers.BaseTileLayer,
dymaptic.GeoBlazor.Core.Interfaces.IBlendLayer,
dymaptic.GeoBlazor.Core.Interfaces.IMapComponent,
dymaptic.GeoBlazor.Core.Interfaces.IOperationalLayer

Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Layer 🡒 BaseTileLayer 🡒 BingMapsLayer

Implements IBlendLayer, IMapComponent, IOperationalLayer

Constructors

BingMapsLayer() Constructor

Parameterless constructor for use as a Razor Component.

public BingMapsLayer();

BingMapsLayer(string, Nullable, Nullable, Effect, Nullable, Nullable, Nullable, SpatialReference, string, CultureInfo, Extent, Nullable, Nullable, Nullable, Nullable, string, TileInfo, 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 BingMapsLayer(string key, System.Nullable<dymaptic.GeoBlazor.Core.Enums.BingImageryStyle> style=null, System.Nullable<dymaptic.GeoBlazor.Core.Enums.BlendMode> blendMode=null, dymaptic.GeoBlazor.Core.Model.Effect? effect=null, System.Nullable<double> maxScale=null, System.Nullable<double> minScale=null, System.Nullable<double> refreshInterval=null, dymaptic.GeoBlazor.Core.Components.SpatialReference? spatialReference=null, string? arcGISLayerId=null, System.Globalization.CultureInfo? culture=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, string? region=null, dymaptic.GeoBlazor.Core.Components.TileInfo? tileInfo=null, string? title=null, dymaptic.GeoBlazor.Core.Components.TimeExtent? visibilityTimeExtent=null, System.Nullable<bool> visible=null);

Parameters

key System.String

Bing Maps Key.
default null
ArcGIS Maps SDK for JavaScript

style System.Nullable<BingImageryStyle>

For more information on Bing map styles please visit:
https://learn.microsoft.com/en-us/bingmaps/rest-services/imagery/get-imagery-metadata.
default “road”
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

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

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

refreshInterval System.Nullable<System.Double>

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

spatialReference SpatialReference

The spatial reference of the layer.
default SpatialReference.WebMercatorArcGIS Maps SDK for JavaScript

arcGISLayerId System.String

The unique ID assigned to the layer.
ArcGIS Maps SDK for JavaScript

culture System.Globalization.CultureInfo

Provides culture specific map labels.
default “en-US”
ArcGIS Maps SDK for JavaScript

fullExtent 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<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

region System.String

This will alter Geopolitical disputed borders and labels to align with the specified user region.
default null
ArcGIS Maps SDK for JavaScript

tileInfo TileInfo

The tiling scheme information 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

visibilityTimeExtent 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

BingMapsLayer.BingLogo Property

Expose Bing logo url.
ArcGIS Maps SDK for JavaScript

public string? BingLogo { get; set; }

Property Value

System.String

BingMapsLayer.Copyright Property

Copyright information.
ArcGIS Maps SDK for JavaScript

public string? Copyright { get; set; }

Property Value

System.String

BingMapsLayer.Culture Property

Provides culture specific map labels. For more information visit: https://learn.microsoft.com/en-us/bingmaps/rest-services/common-parameters-and-types/culture-parameter.
For a list of supported culture codes please visit: https://learn.microsoft.com/en-us/bingmaps/rest-services/common-parameters-and-types/supported-culture-codes.
Default Value: “en-US”

public System.Globalization.CultureInfo? Culture { get; set; }

Property Value

System.Globalization.CultureInfo

BingMapsLayer.Key Property

Bing Maps Key.
default null
ArcGIS Maps SDK for JavaScript

public string Key { get; set; }

Property Value

System.String

BingMapsLayer.Region Property

This will alter Geopolitical disputed borders and labels to align with the specified user region.
For more information on Bing’s region setting please visit: https://learn.microsoft.com/en-us/bingmaps/rest-services/common-parameters-and-types/user-context-parameters
For a list of supported country codes please visit: see https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

public string? Region { get; set; }

Property Value

System.String

BingMapsLayer.Style Property

For more information on Bing map styles please visit: https://learn.microsoft.com/en-us/bingmaps/rest-services/imagery/get-imagery-metadata.
Default Value: “Road”

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

Property Value

System.Nullable<BingImageryStyle>

BingMapsLayer.Type Property

Used internally to identify the sub type of Layer

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

Property Value

LayerType

Methods

BingMapsLayer.GetBingLogo() Method

Exposes Bing logo url.

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

Returns

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

BingMapsLayer.GetCopyright() Method

Copyright information.

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

Returns

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

BingMapsLayer.GetCulture() Method

Asynchronously retrieve the current value of the Culture property.

public System.Threading.Tasks.Task<System.Globalization.CultureInfo?> GetCulture();

Returns

System.Threading.Tasks.Task<System.Globalization.CultureInfo>

BingMapsLayer.GetRegion() Method

Asynchronously retrieve the current value of the Region property.

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

Returns

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

BingMapsLayer.GetStyle() Method

Asynchronously retrieve the current value of the Style property.

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

Returns

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

BingMapsLayer.HasAttributionData() Method

Indicates if the layer has attribution data.

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

Returns

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

BingMapsLayer.SetCulture(CultureInfo) Method

Asynchronously set the value of the Culture property after render.

public System.Threading.Tasks.Task SetCulture(System.Globalization.CultureInfo? value);

Parameters

value System.Globalization.CultureInfo

The value to set.

Returns

System.Threading.Tasks.Task

BingMapsLayer.SetKey(string) Method

Asynchronously set the value of the Key property after render.

public System.Threading.Tasks.Task SetKey(string value);

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

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

BingMapsLayer.SetRegion(string) Method

Asynchronously set the value of the Region property after render.

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

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

BingMapsLayer.SetStyle(Nullable) Method

Asynchronously set the value of the Style property after render.

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

Parameters

value System.Nullable<BingImageryStyle>

The value to set.

Returns

System.Threading.Tasks.Task

BingMapsLayer.ValidateRequiredGeneratedChildren() Method

Validates source-generated child components.

public override void ValidateRequiredGeneratedChildren();

Implements ValidateRequiredGeneratedChildren()