Skip to content

Fix Typo in readme #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mubashiralisiddiqui wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix Typo in readme #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
68a2b54
fix typo in readme add example to use options
mubashiralisiddiqui Feb 10, 2021
222c362
indent readme
mubashiralisiddiqui Feb 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ Leaflet.MousePosition is a simple mouse position control that you can drop into
![Screenshot](/screenshot/sample.png?raw=true)

## Using the Mouse Position Control

Insert the following line:

...
Expand All @@ -20,7 +19,7 @@ These are the available options:

`separator:` To separate longitude\latitude values. Defaults to ' : '

`emptystring:` Initial text to display. Defaults to 'Unavailable'
`emptyString:` Initial text to display. Defaults to 'Unavailable'

`numDigits:` Number of digits. Defaults to 5

Expand All @@ -35,7 +34,22 @@ These are the available options:
`wrapLng:` Controls if longitude values will be [wrapped](https://leafletjs.com/reference-1.5.0.html#latlng-wrap). Defaults to true.

`formatter:` A custom function to format the entire value. Arguments: numerical longitude value, numerical latitude value. Return value: formatted string.
Defaults to undefined. If defined will ignore: `lngFirst`, `lngFormatter`, `latFormatter` and `prefix`.
Defaults to undefined. If defined will ignore: `lngFirst`, `lngFormatter`, `latFormatter` and `prefix`.

### e.g

const options = {
position:'bottomleft',
separator: ':',
emptyString: 'default',
numDigits:5,
lngFirst:false,
lngFormatter: (num) => "Lng " + L.Util.formatNum(num, 3) + 'º ',
latFormatter: (num) => "Lat " + L.Util.formatNum(num, 3) + 'º ',
prefix:'',
wrapLng:true,
}
L.control.mousePosition(options).addTo(map);

## Public Methods:

Expand All @@ -51,3 +65,4 @@ MIT License (MIT)
[npm-image]: https://badge.fury.io/js/leaflet-mouse-position.svg
[npm-url]: https://www.npmjs.com/package/leaflet-mouse-position
[npm-downloads-image]: https://img.shields.io/npm/dt/leaflet-mouse-position.svg