dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components.Widgets
LegendWidget Class
The Legend widget describes the symbols used to represent layers in a map. All symbols and text used in this widget
are configured in the Renderer of the layer. The legend will only display layers and sublayers that are visible in
the view.
ArcGIS
JS API
</a>
public class LegendWidget : dymaptic.GeoBlazor.Core.Components.Widgets.Widget
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Widget 🡒 LegendWidget
Properties
LegendWidget.LayerInfos Property
Specifies a subset of the layers to display in the legend. This includes any basemap layers you want to be visible
in the legend. If this property is not set, all layers in the map will display in the legend, including basemap
layers if basemapLegendVisible is true.
public System.Collections.Generic.HashSet<dymaptic.GeoBlazor.Core.Components.Widgets.LayerInfo> LayerInfos { get; set; }
Property Value
System.Collections.Generic.HashSet<LayerInfo>
LegendWidget.WidgetType Property
The type of widget
public override string WidgetType { get; }
Property Value
Methods
LegendWidget.RegisterChildComponent(MapComponent) Method
Called from dymaptic.GeoBlazor.Core.Components.MapComponent.OnAfterRenderAsync(System.Boolean) to “Register” the current component with it’s parent.
public override System.Threading.Tasks.Task RegisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);
Parameters
child MapComponent
The calling, child component to register
Returns
Exceptions
InvalidChildElementException
Throws if the current child is not a valid sub-component to the parent.
LegendWidget.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
LegendWidget.ValidateRequiredChildren() Method
When a MapView is prepared to render, this will check to make sure that all properties with the
RequiredPropertyAttribute are provided.
public override void ValidateRequiredChildren();
Exceptions
MissingRequiredChildElementException
The consumer needs to provide the missing child component
MissingRequiredOptionsChildElementException
The consumer needs to provide ONE of the options of child components