dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components
LegendLayerInfos Class
Specifies a subset of the layers to display in the legend.
ArcGIS Maps SDK for JavaScript
public class LegendLayerInfos : dymaptic.GeoBlazor.Core.Components.MapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 LegendLayerInfos
Constructors
LegendLayerInfos() Constructor
Parameterless constructor for use as a Razor Component.
public LegendLayerInfos();
LegendLayerInfos(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 LegendLayerInfos(System.Nullable<System.Guid> layerId=null, System.Collections.Generic.IReadOnlyList<long>? sublayerIds=null, string? title=null);
Parameters
layerId
System.Nullable<System.Guid>
A layer to display in the legend.
ArcGIS Maps SDK for JavaScript
sublayerIds
System.Collections.Generic.IReadOnlyList<System.Int64>
Only applicable if the layer
is a MapImageLayer, SubtypeGroupLayer or WMSLayer.
ArcGIS Maps SDK for JavaScript
title
System.String
Specifies a title for the layer to display above its symbols and descriptions.
ArcGIS Maps SDK for JavaScript
Properties
LegendLayerInfos.SublayerIds Property
Only applicable if the layer
is a MapImageLayer, SubtypeGroupLayer or WMSLayer.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<long>? SublayerIds { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<System.Int64>
LegendLayerInfos.Title Property
Specifies a title for the layer to display above its symbols and descriptions.
ArcGIS Maps SDK for JavaScript
public string? Title { get; set; }
Property Value
Methods
LegendLayerInfos.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
LegendLayerInfos.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>
LegendLayerInfos.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>>
LegendLayerInfos.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>
LegendLayerInfos.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
LegendLayerInfos.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
LegendLayerInfos.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
LegendLayerInfos.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.