dymaptic.GeoBlazor.Core

dymaptic.GeoBlazor.Core.Components

WMSSublayer Class

Represents a sublayer in a WMSLayer.
ArcGIS Maps SDK for JavaScript

public class WMSSublayer : dymaptic.GeoBlazor.Core.Components.MapComponent

Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 WMSSublayer

Constructors

WMSSublayer() Constructor

Parameterless constructor for use as a Razor Component.

public WMSSublayer();

WMSSublayer(string, Extent, Nullable, string, Nullable, Nullable, string, Nullable, Nullable, IReadOnlyList, string, Nullable, Nullable) Constructor

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

public WMSSublayer(string? description=null, dymaptic.GeoBlazor.Core.Components.Geometries.Extent? fullExtent=null, System.Nullable<bool> legendEnabled=null, string? legendUrl=null, System.Nullable<double> maxScale=null, System.Nullable<double> minScale=null, string? name=null, System.Nullable<bool> popupEnabled=null, System.Nullable<bool> queryable=null, System.Collections.Generic.IReadOnlyList<double>? spatialReferences=null, string? title=null, System.Nullable<bool> visible=null, System.Nullable<long> wMSSublayerId=null);

Parameters

description System.String

Description for the WMS sublayer.
ArcGIS Maps SDK for JavaScript

fullExtent Extent

The full extent of the layer.
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

legendUrl System.String

A string url pointing to a legend image for the layer.
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

name System.String

Name of the WMS sublayer.
ArcGIS Maps SDK for JavaScript

popupEnabled System.Nullable<System.Boolean>

Indicates whether to display popups when features in the layer are clicked.
default false
ArcGIS Maps SDK for JavaScript

queryable System.Nullable<System.Boolean>

Indicates if the layer can be queried, i.e.
default false
ArcGIS Maps SDK for JavaScript

spatialReferences System.Collections.Generic.IReadOnlyList<System.Double>

List of spatialReferences (WKID) derived from the CRS elements of the first layer in the GetCapabilities request.
ArcGIS Maps SDK for JavaScript

title System.String

The title of the WMS sublayer used to identify it in places such as the
LayerList and Legend widgets.
ArcGIS Maps SDK for JavaScript

visible System.Nullable<System.Boolean>

Indicates if the layer is visible in the view.
ArcGIS Maps SDK for JavaScript

wMSSublayerId System.Nullable<System.Int64>

The id for the WMS sublayer.
ArcGIS Maps SDK for JavaScript

Properties

WMSSublayer.Description Property

Description for the WMS sublayer.
ArcGIS Maps SDK for JavaScript

public string? Description { get; set; }

Property Value

System.String

WMSSublayer.Dimensions Property

An array of time, elevation and other dimensions for the sublayer.
ArcGIS Maps SDK for JavaScript

public System.Collections.Generic.IReadOnlyList<object>? Dimensions { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<System.Object>

WMSSublayer.FullExtent Property

The full extent of the layer.
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Core.Components.Geometries.Extent? FullExtent { get; set; }

Property Value

Extent

WMSSublayer.LegendEnabled Property

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

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

Property Value

System.Nullable<System.Boolean>

WMSSublayer.LegendUrl Property

A string url pointing to a legend image for the layer.
ArcGIS Maps SDK for JavaScript

public string? LegendUrl { get; set; }

Property Value

System.String

WMSSublayer.MaxScale Property

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

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

Property Value

System.Nullable<System.Double>

WMSSublayer.MinScale Property

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

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

Property Value

System.Nullable<System.Double>

WMSSublayer.Name Property

Name of the WMS sublayer.
ArcGIS Maps SDK for JavaScript

public string? Name { get; set; }

Property Value

System.String

WMSSublayer.PopupEnabled Property

Indicates whether to display popups when features in the layer are clicked.
default false
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Nullable<System.Boolean>

WMSSublayer.Queryable Property

Indicates if the layer can be queried, i.e.
default false
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Nullable<System.Boolean>

WMSSublayer.SpatialReferences Property

List of spatialReferences (WKID) derived from the CRS elements of the first layer in the GetCapabilities request.
ArcGIS Maps SDK for JavaScript

public System.Collections.Generic.IReadOnlyList<double>? SpatialReferences { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<System.Double>

WMSSublayer.Sublayers Property

A collection of WMSSublayers.
ArcGIS Maps SDK for JavaScript

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

Property Value

System.Collections.Generic.IReadOnlyList<WMSSublayer>

WMSSublayer.Title Property

The title of the WMS sublayer used to identify it in places such as the
LayerList and Legend widgets.
ArcGIS Maps SDK for JavaScript

public string? Title { get; set; }

Property Value

System.String

WMSSublayer.WMSSublayerId Property

The id for the WMS sublayer.
ArcGIS Maps SDK for JavaScript

public System.Nullable<long> WMSSublayerId { get; set; }

Property Value

System.Nullable<System.Int64>

Methods

WMSSublayer.AddToSpatialReferences(double[]) Method

Asynchronously adds elements to the SpatialReferences property.

public System.Threading.Tasks.Task AddToSpatialReferences(params double[] values);

Parameters

values System.Double[]

The elements to add.

Returns

System.Threading.Tasks.Task

WMSSublayer.GetDescription() Method

Asynchronously retrieve the current value of the Description property.

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

Returns

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

WMSSublayer.GetDimensions() Method

Asynchronously retrieve the current value of the Dimensions property.

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<object>?> GetDimensions();

Returns

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

WMSSublayer.GetFullExtent() Method

Asynchronously retrieve the current value of the FullExtent property.

public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Geometries.Extent?> GetFullExtent();

Returns

System.Threading.Tasks.Task<Extent>

WMSSublayer.GetLegendEnabled() Method

Asynchronously retrieve the current value of the LegendEnabled property.

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

Returns

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

WMSSublayer.GetLegendUrl() Method

Asynchronously retrieve the current value of the LegendUrl property.

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

Returns

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

WMSSublayer.GetMaxScale() Method

Asynchronously retrieve the current value of the MaxScale property.

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

Returns

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

WMSSublayer.GetMinScale() Method

Asynchronously retrieve the current value of the MinScale property.

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

Returns

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

WMSSublayer.GetName() Method

Asynchronously retrieve the current value of the Name property.

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

Returns

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

WMSSublayer.GetPopupEnabled() Method

Asynchronously retrieve the current value of the PopupEnabled property.

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

Returns

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

WMSSublayer.GetQueryable() Method

Asynchronously retrieve the current value of the Queryable property.

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

Returns

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

WMSSublayer.GetSpatialReferences() Method

Asynchronously retrieve the current value of the SpatialReferences property.

public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<double>?> GetSpatialReferences();

Returns

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

WMSSublayer.GetTitle() Method

Asynchronously retrieve the current value of the Title property.

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

Returns

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

WMSSublayer.GetWMSSublayerId() Method

Asynchronously retrieve the current value of the WMSSublayerId property.

public System.Threading.Tasks.Task<System.Nullable<long>> GetWMSSublayerId();

Returns

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

WMSSublayer.RemoveFromSpatialReferences(double[]) Method

Asynchronously remove an element from the SpatialReferences property.

public System.Threading.Tasks.Task RemoveFromSpatialReferences(params double[] values);

Parameters

values System.Double[]

The elements to remove.

Returns

System.Threading.Tasks.Task

WMSSublayer.SetDescription(string) Method

Asynchronously set the value of the Description property after render.

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

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

WMSSublayer.SetFullExtent(Extent) Method

Asynchronously set the value of the FullExtent property after render.

public System.Threading.Tasks.Task SetFullExtent(dymaptic.GeoBlazor.Core.Components.Geometries.Extent? value);

Parameters

value Extent

The value to set.

Returns

System.Threading.Tasks.Task

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

Returns

System.Threading.Tasks.Task

WMSSublayer.SetLegendUrl(string) Method

Asynchronously set the value of the LegendUrl property after render.

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

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

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

Returns

System.Threading.Tasks.Task

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

Returns

System.Threading.Tasks.Task

WMSSublayer.SetName(string) Method

Asynchronously set the value of the Name property after render.

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

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

WMSSublayer.SetPopupEnabled(Nullable) Method

Asynchronously set the value of the PopupEnabled property after render.

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

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

WMSSublayer.SetQueryable(Nullable) Method

Asynchronously set the value of the Queryable property after render.

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

Parameters

value System.Nullable<System.Boolean>

The value to set.

Returns

System.Threading.Tasks.Task

WMSSublayer.SetSpatialReferences(IReadOnlyList) Method

Asynchronously set the value of the SpatialReferences property after render.

public System.Threading.Tasks.Task SetSpatialReferences(System.Collections.Generic.IReadOnlyList<double>? value);

Parameters

value System.Collections.Generic.IReadOnlyList<System.Double>

The value to set.

Returns

System.Threading.Tasks.Task

WMSSublayer.SetTitle(string) Method

Asynchronously set the value of the Title property after render.

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

Parameters

value System.String

The value to set.

Returns

System.Threading.Tasks.Task

WMSSublayer.SetWMSSublayerId(Nullable) Method

Asynchronously set the value of the WMSSublayerId property after render.

public System.Threading.Tasks.Task SetWMSSublayerId(System.Nullable<long> value);

Parameters

value System.Nullable<System.Int64>

The value to set.

Returns

System.Threading.Tasks.Task

WMSSublayer.ValidateRequiredGeneratedChildren() Method

Validates source-generated child components.

public override void ValidateRequiredGeneratedChildren();

Implements ValidateRequiredGeneratedChildren()