Display the street labels following polylines for Leaflet
Switch branches/tags
Nothing to show
Clone or download
jdsantos Merge pull request #1 from filfreire/master
Small fix to README file ❤️
Latest commit dc866ef Dec 10, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Update issue templates Dec 4, 2018
dist Lib build process complete Dec 4, 2018
docs Screenshot in place of the gif Dec 4, 2018
src fix initialize function to work in leaflet 1+ Dec 4, 2018
.gitignore Initial commit Dec 3, 2018
CHANGELOG.md Initial commit Dec 3, 2018
LICENSE Initial commit Dec 3, 2018
README.md Small fix to readme Dec 7, 2018
component.json Initial commit Dec 3, 2018
package-lock.json Initial commit Dec 3, 2018
package.json Lib build process complete Dec 4, 2018

README.md

Leaflet.streetlabels

Leaflet.streetlabels

A Leaflet plugin for showing street labels along polylines.

It's working with Leaflet as a addition to the awesome work done by yakitoritabetai Leaflet.LabelTextCollision and Viglino Canvas-TextPath

This project structure is a shameless copy of the Leaflet.fullscreen Leaflet.fullscreen by Leaflet.

Demo

You can rush to the demo here.

Using this plugin

Include this plugin JS file on your page from the dist folder after Leaflet library, Canvas-TextPath and Leaflet.LabelTextCollision as follows:

Usage

// Create a new renderer as follows (use any options as necessary):
var streetLabelsRenderer = new L.StreetLabels({
      collisionFlg : true,
      propertyName : 'name',
      showLabelIf: function(layer) {
        return true; //layer.properties.type == "primary";
      },
      fontStyle: {
        dynamicFontSize: false,
        fontSize: 10,
        fontSizeUnit: "px",
        lineWidth: 4.0,
        fillStyle: "black",
        strokeStyle: "white",
      },
    })

// Create a new map and attach the renderer created above:
var map = new L.Map('map', {
    renderer : streetLabelsRenderer, //Custom Canvas Renderer
});

Building

npm install && npm run build

Supported Leaflet Versions

Leaflet 1.0 and later versions should be supported. Earlier versions probably won't work (not even tested anymore).