Table Of Contents

Previous topic


Next topic



class gxp.plugins.Legend(config)

Provides an action to display a legend in a new window.

Config Options

Configuration properties in addition to those listed for Ext.util.Observable.


Array Custom actions for tools that do not provide their own. Array elements are expected to be valid Ext config objects or strings referencing a valid Ext component. Actions provided here may have additional menuText and buttonText properties. The former will be used as text when the action is used in a menu. The latter will be conditionally used on buttons, only if showButtonText is set to true. The native text property will unconditionally be used for buttons. Optional, only needed to create custom actions.


Object or String or Array Where to place the tool’s actions (e.g. buttons or menus)? Use null as the default since our tool has both output and action(s).


Boolean Set to false if the tool should be initialized without activating it. Default is true.


Object If this tool is associated with an OpenLayers.Control then this is an optional object to pass to the constructor of the associated OpenLayers.Control.


Number Optional index of an action that should be active by default. Only works for actions that are a GeoExt.Action instance.


String Text for legend menu item (i18n).


Number The actions array index of the action that should trigger this tool’s output. Only valid if actions is configured. Leave this unconfigured if none of the actions should trigger this tool’s output.


Object Optional configuration for the output container. This may be useful to override the xtype (e.g. “window” instead of “gx_popup”), or to provide layout configurations when rendering to an outputTarget.


String Where to add the tool’s output container? This can be any string that references an Ext.Container property on the portal, or “map” to access the viewer’s main map. If not provided, a window will be created. To reference one of the toolbars of an Ext.Panel, ”.tbar”, ”.bbar” or ”.fbar” has to be appended.


Show the buttonText an action is configured with, if used as a button. Default is false.


String If this tool should be radio-button style toggled with other tools, this string is to identify the toggle group.


String Text for legend action tooltip (i18n).

Public Properties

Public properties in addition to those listed for Ext.util.Observable.

Boolean Is the tool currently active?

Public Methods

Public methods in addition to those listed for Ext.util.Observable.

Returns:Boolean true when this tool was activated

Activates this tool.

Parameters:configObject configuration for the Ext.Component to be added to the outputTarget. Properties of this configuration will be overridden by the applications outputConfig for the tool instance. Tool plugins that want to reuse their output (after being closed by a window or crumb panel) can also provide an Ext.Component instance here, if it was previously created with addOutput.
Returns:Ext.Component The component added to the outputTarget.

Adds output to the tool’s outputTarget. This method is meant to be called and/or overridden by subclasses.

Returns:Boolean true when this tool was deactivated

Deactivates this tool.


Get the legend panel associated with this legend plugin.


:return {Object} Gets the configured tool state. Overwrite in subclasses to return anything other than a copy of the initialConfig property.


Removes all output created by this tool


Events in addition to those listed for Ext.util.Observable.


Fired when the tool is activated.

Listener arguments: * tool - gxp.plugins.Tool the activated tool


Fired when the tool is deactivated.

Listener arguments: * tool - gxp.plugins.Tool the deactivated tool