Class MapLegend

Represents the map legend to show legend for the bubbles or shapes.

Information provided in the legend helps to identify the data rendered in the map shapes or bubbles.

Inheritance

System.Object

MapLegend

Namespace: Syncfusion.Maui.Maps

Assembly: Syncfusion.Maui.Maps.dll

Syntax

public class MapLegend : BindableObject, ILegend

Examples

• XAML
• C#

<map:SfMaps>
   <map:SfMaps.BindingContext>
       <local:BubbleViewModel/>
   </map:SfMaps.BindingContext>

   <map:SfMaps.Layer>
      <map:MapShapeLayer x:Name="layer"
                         DataSource="{Binding Details}"
                         ShapeDataField="name"
                         PrimaryValuePath="CountryName"
                         ShowBubbles="True">

         <maps:MapShapeLayer.BubbleSettings>
             <maps:MapBubbleSettings SizeValuePath="UsersCount"
                                     ColorValuePath="UserCount">

                <maps:MapBubbleSettings.ColorMappings>
                    <maps:RangeColorMapping Color="#809fff" From="0" To="100" Text="0-100" />
                    <maps:RangeColorMapping Color="#3366ff" From="100" To="200" Text="100-200" />
                    <maps:RangeColorMapping Color="#0039e6" From="200" To="300" Text="200-300" />
                </maps:MapBubbleSettings.ColorMappings>

         </maps:MapShapeLayer.BubbleSettings>

         <map:MapShapeLayer.Legend>
             <map:MapLegend Placement="Bottom" 
                            SourceType="Bubble">

                <map:MapLegend.TextStyle>
                    <map:MapLabelStyle TextColor="Green" 
                                       FontSize="12" 
                                       FontAttributes="Bold" />
                </map:MapLegend.TextStyle>

             </map:MapLegend>
         </map:MapShapeLayer.Legend>

      </maps:MapShapeLayer>
   </map:SfMaps.Layer>
</map:SfMaps>

Constructors

MapLegend()

Initializes a new instance of the MapLegend class.

Declaration

public MapLegend()

Fields

PlacementProperty

Identifies the Placement dependency property.

Declaration

public static readonly BindableProperty PlacementProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	The identifier for Placement dependency property.

SourceTypeProperty

Identifies the SourceType dependency property.

Declaration

public static readonly BindableProperty SourceTypeProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	The identifier for SourceType dependency property.

TextStyleProperty

Identifies the TextStyle dependency property.

Declaration

public static readonly BindableProperty TextStyleProperty

Field Value

Type	Description
Microsoft.Maui.Controls.BindableProperty	The identifier for TextStyle dependency property.

Properties

Placement

Gets or sets the placement position of the legend.

Declaration

public LegendPlacement Placement { get; set; }

Property Value

Type	Description
LegendPlacement	One of the enumeration values that specifies the placement of legend. The default is Top.

Examples

• XAML
• C#

<map:SfMaps>
   <map:SfMaps.Layer>
      <map:MapShapeLayer x:Name="layer"
                         DataSource="{Binding Details}"
                         ShapeDataField="name"
                         PrimaryValuePath="CountryName"
                         ShowBubbles="True">

         <maps:MapShapeLayer.BubbleSettings>
             <maps:MapBubbleSettings SizeValuePath="UsersCount"
                                     ColorValuePath="UserCount">

                <maps:MapBubbleSettings.ColorMappings>
                    <maps:RangeColorMapping Color="#809fff" From="0" To="100" Text="0-100" />
                    <maps:RangeColorMapping Color="#3366ff" From="100" To="200" Text="100-200" />
                    <maps:RangeColorMapping Color="#0039e6" From="200" To="300" Text="200-300" />
                </maps:MapBubbleSettings.ColorMappings>

         </maps:MapShapeLayer.BubbleSettings>

         <map:MapShapeLayer.Legend>
             <map:MapLegend Placement="Bottom" 
                            SourceType="Bubble" />
         </map:MapShapeLayer.Legend>

      </maps:MapShapeLayer>
   </map:SfMaps.Layer>
</map:SfMaps>

SourceType

Gets or sets the source type of the legend that determines for which map element the legend need to be render.

Declaration

public LegendSourceType SourceType { get; set; }

Property Value

Type	Description
LegendSourceType	One of the enumeration values that specifies the source type of map legend. The default is Shape.

Examples

• XAML
• C#

<map:SfMaps>
   <map:SfMaps.Layer>
      <map:MapShapeLayer x:Name="layer"
                         DataSource="{Binding Details}"
                         ShapeDataField="name"
                         PrimaryValuePath="CountryName"
                         ShowBubbles="True">

         <maps:MapShapeLayer.BubbleSettings>
             <maps:MapBubbleSettings SizeValuePath="UsersCount"
                                     ColorValuePath="UserCount">

                <maps:MapBubbleSettings.ColorMappings>
                    <maps:RangeColorMapping Color="#809fff" From="0" To="100" Text="0-100" />
                    <maps:RangeColorMapping Color="#3366ff" From="100" To="200" Text="100-200" />
                    <maps:RangeColorMapping Color="#0039e6" From="200" To="300" Text="200-300" />
                </maps:MapBubbleSettings.ColorMappings>

         </maps:MapShapeLayer.BubbleSettings>

         <map:MapShapeLayer.Legend>
             <map:MapLegend Placement="Bottom" 
                            SourceType="Bubble" />
         </map:MapShapeLayer.Legend>

      </maps:MapShapeLayer>
   </map:SfMaps.Layer>
</map:SfMaps>

TextStyle

Gets or sets the label style to customize the appearance of the legend labels.

Declaration

public MapLabelStyle TextStyle { get; set; }

Property Value

Type	Description
MapLabelStyle	Apply when customization required for legend labels.

Examples

• XAML
• C#

<map:SfMaps>
   <map:SfMaps.Layer>
      <map:MapShapeLayer x:Name="layer"
                         DataSource="{Binding Details}"
                         ShapeDataField="name"
                         PrimaryValuePath="CountryName"
                         ShowBubbles="True">

         <maps:MapShapeLayer.BubbleSettings>
             <maps:MapBubbleSettings SizeValuePath="UsersCount"
                                     ColorValuePath="UserCount">

                <maps:MapBubbleSettings.ColorMappings>
                    <maps:RangeColorMapping Color="#809fff" From="0" To="100" Text="0-100" />
                    <maps:RangeColorMapping Color="#3366ff" From="100" To="200" Text="100-200" />
                    <maps:RangeColorMapping Color="#0039e6" From="200" To="300" Text="200-300" />
                </maps:MapBubbleSettings.ColorMappings>
         </maps:MapShapeLayer.BubbleSettings>

         <map:MapShapeLayer.Legend>
             <map:MapLegend Placement="Bottom" 
                            SourceType="Bubble">
                <map:MapLegend.TextStyle>
                    <map:MapLabelStyle TextColor="Green" 
                                       FontSize="12" 
                                       FontAttributes="Bold" />
                </map:MapLegend.TextStyle>
             </map:MapLegend>
         </map:MapShapeLayer.Legend>

      </maps:MapShapeLayer>
   </map:SfMaps.Layer>
</map:SfMaps>

Methods

OnBindingContextChanged()

Invoked whenever the binding context of the View changes.

Declaration

protected override void OnBindingContextChanged()