/ui/elements/helpDialog

The helpDialog module creates the help dialogs displayed during certain map interactions.

Methods

(inner) helpDialog A dialog that describes how certain map controls work. Any existing helpDialog will be removed first. The method will shortcircuit with the params argument being undefined. The method will also shortciurcuit if the mapp.user object has the hideHelp flag.(params)

Parameters:
NameTypeDescription
paramsObject

Config paramaters for the dialog.

Properties
NameTypeDescription
params.headerString | HTMLElement

The header displayed on the dialog.

params.contentString | HTMLElement

The content of the dialog.