Class WxLegendControl

Represents a control for displaying a weather legend on a map. The control shows a color gradient legend based on weather data values. It allows for drawing the legend with specific styles and clearing the canvas.

Hierarchy

  • WxLegendControl

Constructors

constructor

Properties

_canvas _div

Methods

clear drawLegend extender onAdd onRemove

Constructors

constructor

Properties

Private Readonly _canvas

_canvas: HTMLCanvasElement

Private Readonly _div

_div: HTMLDivElement

Methods

clear

drawLegend

  • Draws the legend on the canvas based on the provided color style. The legend includes a color gradient and ticks for data values.

    Parameters

    • style: WxColorStyleStrict

      The WxColorStyleStrict object defining the color style for the legend.

    Returns void

extender

  • Returns methods to integrate this legend control with a Leaflet map.

    Returns

    An object containing the onAdd and onRemove methods for Leaflet integration.

    Returns {
        onAdd: (() => HTMLDivElement);
        onRemove: (() => void);
    }

    • onAdd: (() => HTMLDivElement)
        • (): HTMLDivElement

        • Returns HTMLDivElement

    • onRemove: (() => void)
        • (): void

        • Returns void

onAdd

onRemove

Settings

Member Visibility

Theme

Generated using TypeDoc