InfoPanel API v7 - nodeGame/nodegame GitHub Wiki

status: complete
version: 7.x

Introduction

The InfoPanel API is a subset of the Window API. The Info Panel is a configurable extra panel at the top of the screen, normally placed between header and main frame.

Illustration

In the figure above, the InfoPanel is the area of between the header and the main frame, here displayng the "Round Results." In the header, you can see the InfoPanel toggle button labeled "History," which opens and closes the InfoPanel.

Generate the Info Panel

W.generateInfoPanel(root, options, force): Appends the Info Panel to the page, adds a reference inside the W object, and returns it. All input parameters are optional. The options object is passed to the Info Panel constructor, and it accepts the following options (defaults):
- 'className': a class name for the info panel div (''),
- 'isVisible': if TRUE, the info panel is open immediately (false),
- 'onStep:' an action ('clear', 'open', 'close') to perform every new step (null),
- 'onStage:' an action ('clear', 'open', 'close') to perform every new stage (null).

API methods

InfoPanel.clear(): Clears the content of the Info Panel
InfoPanel.destroy(): Removes the Info Panel from the DOM and the internal references to it
InfoPanel.toggle(): Toggles the visibility of the Info Panel
InfoPanel.getPanel(): Returns the HTML element of the panel (div)
InfoPanel.open(): Opens the Info Panel
InfoPanel.close(): Closes the Info Panel
InfoPanel.createToggleButton(buttonLabel): Creates an HTML button with a listener to toggle the InfoPanel

Examples:

   // Generate the info panel object.
   var infoPanel = W.generateInfoPanel();
   // The reference W.infoPanel is automatically created.

   // Generate the toggle button and append it to the header.
   this.historyButton = infoPanel.createToggleButton('History');
   W.getHeader().appendChild(this.historyButton);

   // Add a new div to the info panel.
   this.historyDiv = document.createElement('div');
   this.historyDiv.innerHTML = '<h3>Game history</h3>';
   infoPanel.infoPanelDiv.appendChild(this.historyDiv);

Sources

Info Panel

Go back to the wiki Home.

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.