cgxp.plugins.Help

ptype
cgxp_help
class cgxp.plugins.Help(config)

Provides an “help” button.

Example Use

Sample code showing how to add a Help plugin to a gxp.Viewer:

new gxp.Viewer({
    ...
    tools: [{
        ptype: "cgxp_help",
        actionTarget: "center.tbar",
        url: "http://example.com/help.html"
    }]
    ...
});

Config Options

Configuration properties.

actionConfig

Object Configuration object for the action created by this plugin.

helpactionText

String Text for the help button. Default is null (no text).

helpactiontooltipText

String The tooltip for the help button. (i18n).

url

String URL of help page to open.

Table Of Contents

Previous topic

cgxp.plugins.GoogleSource

Next topic

cgxp.plugins.LayerTree

This Page

Fork me on GitHub