Table of Contents

KeyService

KeyService is an Angular Factory in the Util module with the name keys.js. It provides an API to bind key presses to functions. To use these functions, see the documentation on injecting Angular services.

...

Binds the QuickHelpService to the KeyService. This is called for you when onos.js runs, so you won't have to call this yourself.

ks.bindQhs(qhs);

installOn

Installs the key listener on a d3 selection of an element and sets up global keybindings. This is called for you when onos.js runs, so you won't have to call this yourself.

ks.installOn(elem);

keyBindings

Get or set keybindings for a view. 

ks.keyBindings(x);

There are two options for setting up keybindings – giving an object with key mappings or a function reference for a general key handler.

Key Mappings

The general format for setting key mappings is to use the logical name of the key as the object property name, and an a two-element array as the object property value.

 var keys = {
	// the first array member is a function reference to be executed on keydown
	// the second array member is a string used for quick help / tooltips
	A: [aFunction, 'Description for aFunction'],
	B: [bFunction, 'Description for bFunction'],
 
	leftArrow: [leftFunction, 'Description for leftFunction'],
	altspace: [altFunctionspaceFunction, 'Description for altFunctionspaceFunction'],
 
	// the _helpFormat property tells the QuickHelpService how to display the help information
	// it's an array of arrays
	_helpFormat: [
		// list all of your bindings. '-' will create a separator
		// each array is a new section
		['A', '-', 'B'],
		['leftArrow', 'alt']
	]
};
ks.keyBindings(keys);       // bind the keys

The descriptions end up are displayed in the QuickHelp panel to give a helpful hint to the user as to what the button does. They may also be used as tooltip text.

The object property must be the logical name of the key that you want the function to be executed on. In addition to all of the letter and function (e.g. F12) keys, you can have the following object property names for other keys:

'enter', 'shift', 'ctrl', 'alt', 'esc', 'space', 'leftArrow', 'upArrow', 'rightArrow', 'downArrow', 'cmdLeft', 'cmdRight', 'equals', 'comma', 'dash', 'dot', 'slash', 'backQuote', 'backSlash'

Function Reference

...

See the section below for a complete list.

Function Reference

Additionally, you can provide a function to be executed for all keys for which there is no explicit binding. For example:

var keys = { ... };
 
function keyFallback(token, key, code, event) {
    $log.debug('Fallback keystroke:', token, key, code, event);
}
 
// map explicit key bindings
ks.keyBindings(keys);
 
// register a fallback function for any unmapped keys
ks.keyBindings(keyFallback);

Note that the fallback function receives 4 parameters:

• token - always the string "keyev"
• key - the logical name for the key
• code - the key code
• event - the KeyboardEvent (same as d3.event)

unbindKeys

Unbind keybindings for a view. You typically want to call this when your view is destroyed.

ks.unbindKeys();

gestureNotes

Get or set notes on the QuickHelp Panel about other view gestures besides keybindings.

ks.gestureNotes(g);

// array of arrays for formatting the notes on the QuickHelp Panel
ks.gestureNotes([
	// each array is one line
	// first member is the name of the gesture
	// second member is the description
	['click', 'select an item'],
	['cmdshift-click', 'selects multiple items'],
	['esc', 'deselect item(s)']
]);

...

ks.enableKeys(b);

Global Keybindings

There a few reserved keys that are shared among all views.

...

* You can still bind a function to the 'esc' key. Your function will be called after the quickhelp and navigation (the global functions) have been hidden. Your function should return true if it consumes the event, and false otherwise. In this way, successive <esc> key presses will cancel a chain of features. 

List of Logical Keystroke Names

...