Difference between revisions of "Board18SnapMap"
(initial contents for this page) |
(add setUpKeys) |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{ReleaseNoticeX|2.1|Design_Document_board18SnapMap_Page}} | |||
The board18SnapMap.js file contains all the functions that | The board18SnapMap.js file contains all the functions that | ||
respond to various onclick events on the game board | respond to various onclick events on the game board | ||
and on the main and tray menues in the | |||
right click events are not used on | board18SnapMap page. But note that | ||
right click events are not used on the board18SnapMap page. | |||
==Function | == Function setUpKeys() == | ||
The | The setUpKeys function performs all of the bind | ||
operations for the keyboard shortcut events. | |||
{| class="wikitable" | |||
|+ Keyboard Shortcuts | |||
!KEY!!Action | |||
|- | |||
|H||Hide/Show | |||
|- | |||
|M||Goto Stock Chart | |||
|- | |||
|G||Return to Game | |||
|- | |||
|S||Return to SnapList | |||
|- | |||
|O||Goto Main Page | |||
|- | |||
|X||Logout | |||
|} | |||
==Function makeTrayItems()== | == Function hideShow()== | ||
The hideShow function will hide or show tiles on the map | |||
of the board18SnapMap page. | |||
== Function makeTrayItems() == | |||
The makeTrayItems function will use the | The makeTrayItems function will use the | ||
BD18.trays array to construct the items | BD18.trays array to construct the items | ||
to be displayed in the tray menu. | to be displayed in the tray menu. | ||
==Function registerTrayMenu()== | == Function registerTrayMenu() == | ||
The registerTrayMenu function creates the | The registerTrayMenu function creates the | ||
tray menu on the board18SnapMap page. It uses | tray menu on the board18SnapMap page. It uses | ||
| Line 21: | Line 41: | ||
makeTrayItems function. | makeTrayItems function. | ||
==Function makeMenus()== | == Function leftMenuEvent(key) == | ||
This function handles the selection of the leftMenu(Tray) | |||
and displays the proper BD18.tray. | |||
== Function makeMenus() == | |||
This makeMenus function is a stub to make board18SnapMap | This makeMenus function is a stub to make board18SnapMap | ||
compatable with board18Map2. | compatable with board18Map2.php | ||
== Function delayCheckForUpdate() == | |||
This delayCheckForUpdate function is a stub to make | |||
This delayCheckForUpdate function is a stub to make board18SnapMap | board18SnapMap compatable with board18Map2.php | ||
compatable with board18Map2. | |||
Latest revision as of 13:46, 2 June 2016
| This page has been updated to comply with Release 2.1.x of BOARD18. | Go Back |
The board18SnapMap.js file contains all the functions that respond to various onclick events on the game board and on the main and tray menues in the board18SnapMap page. But note that right click events are not used on the board18SnapMap page.
Function setUpKeys()
The setUpKeys function performs all of the bind operations for the keyboard shortcut events.
| KEY | Action |
|---|---|
| H | Hide/Show |
| M | Goto Stock Chart |
| G | Return to Game |
| S | Return to SnapList |
| O | Goto Main Page |
| X | Logout |
Function hideShow()
The hideShow function will hide or show tiles on the map of the board18SnapMap page.
Function makeTrayItems()
The makeTrayItems function will use the BD18.trays array to construct the items to be displayed in the tray menu.
Function registerTrayMenu()
The registerTrayMenu function creates the tray menu on the board18SnapMap page. It uses the jquery context menu plugin and the makeTrayItems function.
Function leftMenuEvent(key)
This function handles the selection of the leftMenu(Tray) and displays the proper BD18.tray.
Function makeMenus()
This makeMenus function is a stub to make board18SnapMap compatable with board18Map2.php
Function delayCheckForUpdate()
This delayCheckForUpdate function is a stub to make board18SnapMap compatable with board18Map2.php