mapsglmaps/com.xweather.mapsgl.controls.legend

Package-level declarations

Types

data class ColorMaskOptions(var colorScale: ColorScaleOptions)

data class ColorScaleOptionsLegendDisabled(val stops: List<ColorStop>, val range: ClosedRange<Float>? = null)

Describes how a color scale is configured, which can either be a single scale or a collection of scales for specific data masks.

Legend

interface Legend

Describes the data and view-building hooks required for a legend. This is designed to be implemented by a data-holding class, often a data class, which can then be rendered by a Composable function.

LegendCode

enum LegendCode : Enum<LegendCode>

NOTE: This file is auto-generated and should not be edited directly! Last updated: 2025-11-14T18:31:03.868Z

LegendContainerView

class LegendContainerView @JvmOverloads constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0) : LinearLayout

A custom view that hosts a vertical stack of legend views.

LegendControl

class LegendControl

The LegendControl acts as a high-level manager for map legends within a Mapbox environment.

LegendControlView

class LegendControlView @JvmOverloads constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0) : FrameLayout

The main view that contains and manages the legend UI components.

LegendDefaults

data class LegendDefaults(val titleFontWeight: FontWeight = FontWeight.Bold, val titleColor: Color = Color.Black, val backgroundColor: Color = Color.White, val margins: PaddingValues = PaddingValues(horizontal = 3.dp, vertical = 4.dp), val insets: PaddingValues = PaddingValues(8.dp), val cornerRadius: Dp = 8.dp)

A data class holding default styling values for a legend component.

LegendView

class LegendView @JvmOverloads constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0) : LinearLayout

A custom Android View that displays a legend, built entirely programmatically without XML.