HtmlForgeX

API Reference

Class

LeafletLegendSettings

Edit on GitHub
Namespace HtmlForgeX
Assembly HtmlForgeX
Source Containers/Maps/LeafletMap.Legend.Settings.cs:18
Modifiers sealed

Legend control settings for LeafletMap.

Inheritance

  • Object
  • LeafletLegendSettings

Methods

AddItem 2 overloads
public LeafletLegendSettings AddItem(String label, RGBColor color) #
Containers/Maps/LeafletMap.Legend.Settings.cs:27
Returns: LeafletLegendSettings

Adds a legend item (label + color).

Parameters

label System.String requiredposition: 0
color HtmlForgeX.TablerColor requiredposition: 1
AddItem(System.String label, HtmlForgeX.RGBColor color) #

Adds a legend item (label + color).

Parameters

label System.String required
color HtmlForgeX.RGBColor required
public LeafletLegendSettings AddItemHex(String label, String colorHex) #
Containers/Maps/LeafletMap.Legend.Settings.cs:32
Returns: LeafletLegendSettings
EditorBrowsable(2)

Adds a legend item using a custom hex color.

Parameters

label System.String requiredposition: 0
colorHex System.String requiredposition: 1
public LeafletLegendSettings Clear() #
Containers/Maps/LeafletMap.Legend.Settings.cs:41
Returns: LeafletLegendSettings

Clears legend items.

public LeafletMapSettings End() #
Containers/Maps/LeafletMap.Legend.Settings.cs:44
Returns: LeafletMapSettings

Return to parent settings builder.

public LeafletLegendSettings Position(LeafletControlPosition position) #
Containers/Maps/LeafletMap.Legend.Settings.cs:21
Returns: LeafletLegendSettings

Sets legend position.

Parameters

position HtmlForgeX.LeafletControlPosition requiredposition: 0
public LeafletLegendSettings Title(String title) #
Containers/Maps/LeafletMap.Legend.Settings.cs:18
Returns: LeafletLegendSettings

Sets legend title.

Parameters

title System.String requiredposition: 0