<commit_before># leaflet-tilelayer-mask (v1.0)

Leaflet 1.0.x plugin, Leaflet-tilelayer-mask adds mask effect to tilelayer. Older version for Leaflet 0.7.x is available [here](https://github.com/frogcat/leaflet-tilelayer-mask/tree/v0.7).

![Leaflet-tilelayer-mask](http://frogcat.github.io/leaflet-tilelayer-mask/misc/screenshot.jpg)

## Demo

<http://frogcat.github.io/leaflet-tilelayer-mask/>

## Usage

```
// Create map
var map = L.map("map", {
 zoom : ...,
 center : ...
});

// Add background tile layer
L.tileLayer(...).addTo(map);

// Create foreground tile layer with mask
var fg = L.tileLayer.mask('http://www.finds.jp/ws/tmc/1.0.0/Kanto_Rapid-900913-L/{z}/{x}/{y}.png', {
  maskUrl : 'star.png', // optional
  maskSize : 1024  //optional
).addTo(map);

// Add event handler to update mask position
map.on("mousemove", function(e) {
 fg.setCenter(e.containerPoint);
});
```

## Options

Option   | Type              | Default          | Description
-------- | ----------------- | ---------------- | -----------------
maskUrl  | String            | #1               | Url of mask image
maskSize | L.point or Number | L.point(512,512) | mask size

Note #1 : Built in image 'data:image/png;base64,...' (white circle with soft edge)

## Methods<commit_msg>Update README.md, language added to usage example<commit_after># leaflet-tilelayer-mask (v1.0)

Leaflet 1.0.x plugin, Leaflet-tilelayer-mask adds mask effect to tilelayer. Older version for Leaflet 0.7.x is available [here](https://github.com/frogcat/leaflet-tilelayer-mask/tree/v0.7).

![Leaflet-tilelayer-mask](http://frogcat.github.io/leaflet-tilelayer-mask/misc/screenshot.jpg)

## Demo

<http://frogcat.github.io/leaflet-tilelayer-mask/>

## Usage

```javascript
// Create map
var map = L.map("map", {
 zoom : ...,
 center : ...
});

// Add background tile layer
L.tileLayer(...).addTo(map);

// Create foreground tile layer with mask
var fg = L.tileLayer.mask('http://www.finds.jp/ws/tmc/1.0.0/Kanto_Rapid-900913-L/{z}/{x}/{y}.png', {
  maskUrl : 'star.png', // optional
  maskSize : 1024  //optional
).addTo(map);

// Add event handler to update mask position
map.on("mousemove", function(e) {
 fg.setCenter(e.containerPoint);
});
```

## Options

Option   | Type              | Default          | Description
-------- | ----------------- | ---------------- | -----------------
maskUrl  | String            | #1               | Url of mask image
maskSize | L.point or Number | L.point(512,512) | mask size

Note #1 : Built in image 'data:image/png;base64,...' (white circle with soft edge)

## Methods
{'fraction_non_alphanumeric': 0.20622568093385213, 'fraction_numerical': 0.024124513618677044, 'mean_word_length': 2.5708333333333333, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 2, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '154354', 'n_tokens_mistral': 920, 'n_tokens_neox': 869, 'n_words': 192}