Resource Keys

Customizing String Resources

Common string resources such as command names, keyboard shortcuts, undo unit names, and UI labels can be customized. The key and value pairs are stored globally in the yfiles.resources variable.

The resources are subdivided into UI cultures. For example, resources for American English should be stored in yfiles.resources["en-US"]. By default, all resources are stored in yfiles.resources["invariant"]. This is also the fallback for all cultures if a specific key is not found.

To customize resources, create a variable with the name of the key and the desired value in the respective resource object. If the resource object is not yet initialized, create it first. The initialization of the yFiles for HTML resources is non-destructive. Custom values stored in yfiles.resources before initializing the yfiles library are not overwritten by defaults. For example, you can customize the key gesture for node grouping by changing the value of the resource key "GroupSelectionKey".

yfiles.resources["invariant"]["GroupSelectionKey"] = "Shift+G";

The customization of a resource has to be done before the commands are initialized, e.g. before the GraphComponent is instantiated.

Resources Defaults

The following table lists the resource defaults stored in yfiles.resources["invariant"] alphabetically.

Note that, in the table above, Action+Key defines a hotkey that uses <kbd>Ctrl</kbd> on non-Mac systems and ⌘ on macOS. For more details on keyboard shortcuts, refer to List of Keyboard Shortcuts.

Resources that describe keyboard shortcuts support key values as outlined in KeyboardEvent.key. These values are treated as case-insensitive since modifiers are handled separately.