Class Legend

constructor

• new Legend(
      opts?: {
          kind?: "continuous" | "classed";
          source?: "default" | "palette" | "custom" | "gdal";
          stops?: LegendStop[];
          unit?: string;
      },
  ): Legend

  Parameters

  • Optionalopts: {
        kind?: "continuous" | "classed";
        source?: "default" | "palette" | "custom" | "gdal";
        stops?: LegendStop[];
        unit?: string;
    } = {}

  Returns Legend

formatLabel

formatValue

kind

source

stops

unit

toHtml

• toHtml(): string

  HTML for the legend. Continuous → a gradient bar with min/max; classed → coloured rows.

  Returns string

toJSON

• toJSON(): { kind: string; source: string; stops: LegendStop[]; unit: string }

  Returns { kind: string; source: string; stops: LegendStop[]; unit: string }

StaticfromColorScale

• fromColorScale(cs: ColorScale, opts?: { source?: string }): Legend

  Parameters

  • cs: ColorScale
  • Optionalopts: { source?: string } = {}

  Returns Legend