Legend Control

Legend control shows the color legend for the raster layer

Example

Legend Control

import * as WeatherLayers from 'weatherlayers-gl';

const legendControl = new WeatherLayers.LegendControl({
  title: 'Wind',
  unitFormat: {
    unit: 'm/s',
  },
  palette: [
    [0, [255, 255, 255]],
    [5, [127, 255, 255]],
    [10, [127, 255, 127]],
    [15, [255, 255, 127]],
    [20, [255, 127, 127]],
    [25, [127, 0, 0]],
  ],
});
legendControl.addTo(document.getElementById('controls'));

Constructor

LegendControl(config: LegendConfig = {})

Config Properties

width

Type: number, optional

Default: 300

Width of the control.

ticksCount

Type: number, optional

Default: 6

Ticks to be displayed.

title

Type: string, required

Title to be displayed.

unitFormat

Type: UnitFormat, required

Unit definition to be used for formatting numbers.

palette

Type: color palette text or array, required

Palette used to interpolate values to colors.

Formats:

• text (string) - see Text format for details
• array ([number, PaletteColor][]) - PaletteColor is any object accepted by Chroma.js constructor

Methods

See Control for common Control methods.