Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mithron committed Aug 22, 2014
1 parent 9d10894 commit e37a26e
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,17 +15,21 @@ A control for LeafletJS which scrolls the map through the list of locations and
nextText : '->',
nextTitle : 'Next',
prevText : '<-',
prevTitle : 'Previous'});
prevTitle : 'Previous',
showList : false });

###locationsList
### locationsList
The array of objects containing locations in format { title: "", latlng: [,], zoom: } .The control will rotate over these locations on click. It assumes that the first location is by default selected, so Next location will be 1st and Prev location will be last in array. Than it scrolls in array, changing current location.

### nextText, nextTitle, prevText, prevTitle
Helpers for arrows - what will be displayed on arrows as popup and if no image specified for them. Surely you'll never need these, but who know?

### showList
Show a select box for quick jumps to the locations.

## Images

Images for arrows are in img folder. They are specified in css, so you can change them into what you want.

## Events
Events are added to interact with control from code. Events are fired on switching to next (the 'next' event) or to previous (the 'prev' event) location. Example shows how to do it.
Events are added to interact with control from code. Events are fired on switching to next (the 'next' event) or to previous (the 'prev' event) location. Also a 'changed' event fires every time the map jumps. Example shows how to do it.

0 comments on commit e37a26e

Please sign in to comment.