mapsglmaps/com.xweather.mapsgl.controls.legend.Point/PointLegend

PointLegend

data class PointLegend(val id: String, var title: String? = null, val labelFontWeight: FontWeight = FontWeight.Normal, var titleFontSize: TextUnit = LegendDefaults.titleFontSize, var titleFontWeight: FontWeight = LegendDefaults.titleFontWeight, var titleColorValue: Color = LegendDefaults.titleColor, var labelFontSize: TextUnit = PointLegendDefaults.labelFontSize, var labelColor: Color = PointLegendDefaults.labelColor, var radius: Double = PointLegendDefaults.radius.value.toDouble(), var items: List<PointLegendItem> = emptyList(), var itemResolver: PointLegendFeatureResolver? = null, var layerId: String? = null, var units: MeasurementUnits = MeasurementUnits.IMPERIAL, var margins: Margin = Margin(width = 4.dp.value, height = 4.dp.value)) : Legend

Renders a legend composed of labeled point markers.

Parameters

Unique identifier used when registering the legend with a LegendControl.

title

Display title shown above the legend content.

titleColorValue

Color of the legend title.

labelFontSize

Font size for legend item labels.

labelColor

Color of the text labels.

radius

Radius for the circular glyph drawn for each legend item.

items

Static items rendered by the legend when no resolver is provided.

itemResolver

Optional resolver that converts queried features into dynamic legend items.

layerId

Optional layer identifier (or regex) used to scope dynamic legend updates.

units

Units currently applied to any measurement values drawn by the legend.

Constructors

PointLegend

constructor(id: String, title: String? = null, labelFontWeight: FontWeight = FontWeight.Normal, titleFontSize: TextUnit = LegendDefaults.titleFontSize, titleFontWeight: FontWeight = LegendDefaults.titleFontWeight, titleColorValue: Color = LegendDefaults.titleColor, labelFontSize: TextUnit = PointLegendDefaults.labelFontSize, labelColor: Color = PointLegendDefaults.labelColor, radius: Double = PointLegendDefaults.radius.value.toDouble(), items: List<PointLegendItem> = emptyList(), itemResolver: PointLegendFeatureResolver? = null, layerId: String? = null, units: MeasurementUnits = MeasurementUnits.IMPERIAL, margins: Margin = Margin(width = 4.dp.value, height = 4.dp.value))