GeoBlazor Pro
layout: pro title: GraphicsLegendWidget parent: Pro Classes grand_parent: GeoBlazor Pro —
dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Components.Widgets
GraphicsLegendWidget Class
A custom widget that displays a legend for the graphics in the View and Graphics Layers.
public class GraphicsLegendWidget : dymaptic.GeoBlazor.Core.Components.Widgets.Widget
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 dymaptic.GeoBlazor.Core.Components.MapComponent 🡒 dymaptic.GeoBlazor.Core.Components.Widgets.Widget 🡒 GraphicsLegendWidget
Properties
GraphicsLegendWidget.Class Property
Passes css classes to the underlying HTML components.
public string? Class { get; set; }
Property Value
GraphicsLegendWidget.ConcatenateLabelsByTemplate Property
When true, field values in the GraphicLabelTemplate are either added together (for numeric values)
or concatenated (for string values) for each group of graphics.
public bool ConcatenateLabelsByTemplate { get; set; }
Property Value
GraphicsLegendWidget.GraphicLabelTemplate Property
The template for the label for each graphic or group.
The template is a string with placeholders for the graphic’s attributes in the form of {attributeName}.
You can override this per graphic or group by setting the dymaptic.GeoBlazor.Core.Components.Layers.Graphic.LegendLabel property.
public string GraphicLabelTemplate { get; set; }
Property Value
GraphicsLegendWidget.GroupBySymbol Property
Determines whether to group and show only a single entry for all graphics with the same symbol and color.
public bool GroupBySymbol { get; set; }
Property Value
GraphicsLegendWidget.Label Property
The top-level label for the legend.
public string Label { get; set; }
Property Value
GraphicsLegendWidget.SelectGraphics Property
Sets whether you can select and open a graphic popup via the legend.
public bool SelectGraphics { get; set; }
Property Value
GraphicsLegendWidget.Style Property
Passes css styles to the underlying HTML components.
public string? Style { get; set; }
Property Value
GraphicsLegendWidget.ToggleGraphics Property
Sets whether the legend can control the visibility of the graphics.
public bool ToggleGraphics { get; set; }