Skip to content
legend-symbol / 0.2.3

legend-symbol 0.2.3

Install from the command line:
Learn more about npm packages
$ npm install @watergis/legend-symbol@0.2.3
Install via package.json:
"@watergis/legend-symbol": "0.2.3"

About this version

legend-symbol

Note: This is a work in progress

An expressive map symbol (<svg/> icon) to represent a layer styled on a mapbox-gl-js map.

Supports the following layers types

  • circle
  • fill
  • line
  • symbol - as icon or text

screenshot of library in action

Usage

Here is an example using react. In the example below map is a instance of a mapbox-gl map and layer is the JSON representation of the layer you want to get a map symbol for.

import LegendSymbol from '@mgljs-contrib/legend-symbol/react';

function Foo () {
  // Where `map` is a mapbox-gl map instance.
  const style = map.getStyle();
  const layer = style.layers[2];
  const sprite = style.sprite;

  return (
    <LegendSymbol
      sprite={sprite}
      zoom={zoom}
      layer={layer}
    />
  );
}

Details


Assets

  • legend-symbol-0.2.3.tgz

Download activity

  • Total downloads 0
  • Last 30 days 0
  • Last week 0
  • Today 0

Recent versions

View all