dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components
ActiveLayerInfo Class
ActiveLayerInfo is added to or removed from the collection of
activeLayerInfos as layers become visible or
invisible in the view.
ArcGIS Maps SDK for JavaScript
public class ActiveLayerInfo : dymaptic.GeoBlazor.Core.Components.MapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 ActiveLayerInfo
Constructors
ActiveLayerInfo() Constructor
Parameterless constructor for use as a Razor Component.
public ActiveLayerInfo();
ActiveLayerInfo(Nullable, Layer, LayerView, IReadOnlyList, Nullable, IReadOnlyList, string) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public ActiveLayerInfo(System.Nullable<bool> hideLayersNotInCurrentView=null, dymaptic.GeoBlazor.Core.Components.Layers.Layer? layer=null, dymaptic.GeoBlazor.Core.Components.LayerView? layerView=null, System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Interfaces.ILegendElement>? legendElements=null, System.Nullable<bool> respectLayerVisibility=null, System.Collections.Generic.IReadOnlyList<long>? sublayerIds=null, string? title=null);
Parameters
hideLayersNotInCurrentView System.Nullable<System.Boolean>
When true, layers will only be shown in the legend if
they are visible in the view’s extent.
default false
ArcGIS Maps SDK for JavaScript
layer Layer
The layer represented by the ActiveLayerInfo object.
ArcGIS Maps SDK for JavaScript
layerView LayerView
The layerView represented by the ActiveLayerInfo object’s layer.
ArcGIS Maps SDK for JavaScript
legendElements System.Collections.Generic.IReadOnlyList<ILegendElement>
The legendElements is constructed using the layer Renderer.
ArcGIS Maps SDK for JavaScript
respectLayerVisibility System.Nullable<System.Boolean>
Determines whether to respect the properties of the layers in the map that
control the legend’s visibility (minScale, maxScale, legendEnabled).
default true
ArcGIS Maps SDK for JavaScript
sublayerIds System.Collections.Generic.IReadOnlyList<System.Int64>
Only applies if the layer is a MapImageLayer.
ArcGIS Maps SDK for JavaScript
title System.String
The text string that represents the legend’s title.
ArcGIS Maps SDK for JavaScript
Properties
ActiveLayerInfo.Children Property
A collection of child activeLayerInfos.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.ActiveLayerInfo>? Children { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<ActiveLayerInfo>
ActiveLayerInfo.HideLayersNotInCurrentView Property
When true, layers will only be shown in the legend if
they are visible in the view’s extent.
default false
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> HideLayersNotInCurrentView { get; set; }
Property Value
System.Nullable<System.Boolean>
ActiveLayerInfo.IsScaleDriven Property
Indicates if the legend’s display of the layer’s renderer is driven by the scale of the view.
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> IsScaleDriven { get; set; }
Property Value
System.Nullable<System.Boolean>
ActiveLayerInfo.LayerView Property
The layerView represented by the ActiveLayerInfo object’s layer.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Components.LayerView? LayerView { get; set; }
Property Value
ActiveLayerInfo.LegendElements Property
The legendElements is constructed using the layer Renderer.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Interfaces.ILegendElement>? LegendElements { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<ILegendElement>
ActiveLayerInfo.Opacity Property
The opacity of the layer or parent element.
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> Opacity { get; set; }
Property Value
System.Nullable<System.Double>
ActiveLayerInfo.Ready Property
Indicates if the activeLayerInfo is ready.
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> Ready { get; set; }
Property Value
System.Nullable<System.Boolean>
ActiveLayerInfo.RespectLayerVisibility Property
Determines whether to respect the properties of the layers in the map that
control the legend’s visibility (minScale, maxScale, legendEnabled).
default true
ArcGIS Maps SDK for JavaScript
public System.Nullable<bool> RespectLayerVisibility { get; set; }
Property Value
System.Nullable<System.Boolean>
ActiveLayerInfo.Scale Property
The scale of the view instance in which the Legend is rendered.
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> Scale { get; set; }
Property Value
System.Nullable<System.Double>
ActiveLayerInfo.SublayerIds Property
Only applies if the layer is a MapImageLayer.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<long>? SublayerIds { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<System.Int64>
ActiveLayerInfo.Title Property
The text string that represents the legend’s title.
ArcGIS Maps SDK for JavaScript
public string? Title { get; set; }
Property Value
ActiveLayerInfo.Version Property
The version of the ActiveLayerInfo.
ArcGIS Maps SDK for JavaScript
public System.Nullable<double> Version { get; set; }
Property Value
System.Nullable<System.Double>
Methods
ActiveLayerInfo.AddToLegendElements(ILegendElement[]) Method
Asynchronously adds elements to the LegendElements property.
public System.Threading.Tasks.Task AddToLegendElements(params dymaptic.GeoBlazor.Core.Interfaces.ILegendElement[] values);
Parameters
values ILegendElement[]
The elements to add.
Returns
ActiveLayerInfo.AddToSublayerIds(long[]) Method
Asynchronously adds elements to the SublayerIds property.
public System.Threading.Tasks.Task AddToSublayerIds(params long[] values);
Parameters
values System.Int64[]
The elements to add.
Returns
ActiveLayerInfo.GetHideLayersNotInCurrentView() Method
Asynchronously retrieve the current value of the HideLayersNotInCurrentView property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetHideLayersNotInCurrentView();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
ActiveLayerInfo.GetIsScaleDriven() Method
Asynchronously retrieve the current value of the IsScaleDriven property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetIsScaleDriven();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
ActiveLayerInfo.GetLayer() Method
Asynchronously retrieve the current value of the Layer property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Layers.Layer?> GetLayer();
Returns
System.Threading.Tasks.Task<Layer>
ActiveLayerInfo.GetLayerView() Method
Asynchronously retrieve the current value of the LayerView property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.LayerView?> GetLayerView();
Returns
System.Threading.Tasks.Task<LayerView>
ActiveLayerInfo.GetLegendElements() Method
Asynchronously retrieve the current value of the LegendElements property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Interfaces.ILegendElement>?> GetLegendElements();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<ILegendElement>>
ActiveLayerInfo.GetOpacity() Method
Asynchronously retrieve the current value of the Opacity property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetOpacity();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
ActiveLayerInfo.GetReady() Method
Asynchronously retrieve the current value of the Ready property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetReady();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
ActiveLayerInfo.GetRespectLayerVisibility() Method
Asynchronously retrieve the current value of the RespectLayerVisibility property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetRespectLayerVisibility();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
ActiveLayerInfo.GetScale() Method
Asynchronously retrieve the current value of the Scale property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetScale();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
ActiveLayerInfo.GetSublayerIds() Method
Asynchronously retrieve the current value of the SublayerIds property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<long>?> GetSublayerIds();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<System.Int64>>
ActiveLayerInfo.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>
ActiveLayerInfo.GetVersion() Method
Asynchronously retrieve the current value of the Version property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetVersion();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
ActiveLayerInfo.RemoveFromLegendElements(ILegendElement[]) Method
Asynchronously remove an element from the LegendElements property.
public System.Threading.Tasks.Task RemoveFromLegendElements(params dymaptic.GeoBlazor.Core.Interfaces.ILegendElement[] values);
Parameters
values ILegendElement[]
The elements to remove.
Returns
ActiveLayerInfo.RemoveFromSublayerIds(long[]) Method
Asynchronously remove an element from the SublayerIds property.
public System.Threading.Tasks.Task RemoveFromSublayerIds(params long[] values);
Parameters
values System.Int64[]
The elements to remove.
Returns
ActiveLayerInfo.SetHideLayersNotInCurrentView(Nullable) Method
Asynchronously set the value of the HideLayersNotInCurrentView property after render.
public System.Threading.Tasks.Task SetHideLayersNotInCurrentView(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
ActiveLayerInfo.SetLayer(Layer) Method
Asynchronously set the value of the Layer property after render.
public System.Threading.Tasks.Task SetLayer(dymaptic.GeoBlazor.Core.Components.Layers.Layer? value);
Parameters
value Layer
The value to set.
Returns
ActiveLayerInfo.SetLayerView(LayerView) Method
Asynchronously set the value of the LayerView property after render.
public System.Threading.Tasks.Task SetLayerView(dymaptic.GeoBlazor.Core.Components.LayerView? value);
Parameters
value LayerView
The value to set.
Returns
ActiveLayerInfo.SetLegendElements(IReadOnlyList) Method
Asynchronously set the value of the LegendElements property after render.
public System.Threading.Tasks.Task SetLegendElements(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Interfaces.ILegendElement>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<ILegendElement>
The value to set.
Returns
ActiveLayerInfo.SetRespectLayerVisibility(Nullable) Method
Asynchronously set the value of the RespectLayerVisibility property after render.
public System.Threading.Tasks.Task SetRespectLayerVisibility(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
ActiveLayerInfo.SetSublayerIds(IReadOnlyList) Method
Asynchronously set the value of the SublayerIds property after render.
public System.Threading.Tasks.Task SetSublayerIds(System.Collections.Generic.IReadOnlyList<long>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<System.Int64>
The value to set.
Returns
ActiveLayerInfo.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
ActiveLayerInfo.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()