gxp.plugins.Playback¶

Config Options¶

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

actions

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.

actionTarget

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).

autoActivate

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

autoStart

Boolean Should playback begin as soon as possible.

controlOptions

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.

defaultAction

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

looped

Boolean Should playback start in continuous loop mode.

menuText

String Text for Playback menu item (i18n).

outputAction

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.

outputConfig

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.

outputTarget

Object or String Where to place the tool’s output (widgets.PlaybackPanel) Use ‘map’ as the default to display a transparent floating panel over the map.

playbackMode

String One of: ‘track’, ‘cumulative’, or ‘ranged’

showButtonText

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

toggleGroup

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

tooltip

String Text for Playback action tooltip (i18n).

Public Properties¶

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

Playback.active¶

Boolean Is the tool currently active?

Public Methods¶

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

Playback.activate()¶

Returns:	Boolean true when this tool was activated

Activates this tool.

Playback.addActions()¶

Parameters:	actions – Array Optional actions to add. If not provided, this.actions will be added.
Returns:	Array The actions added.

Playback.addOutput()¶

Parameters:	config – Object 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.

Playback.deactivate()¶

Returns:	Boolean true when this tool was deactivated

Deactivates this tool.

Playback.getState()¶

:returns {Object} - initial config plus any user configured settings

Tool specific implementation of the getState function

Playback.removeOutput()¶

Removes all output created by this tool

Playback.setTime()¶

Parameters:	time – {Date}
Returns:	{Boolean} - true if the time could be set to the supplied value false if the time is outside the current range of the DimManager control.

Set the time represented by the playback toolbar programatically

Events¶

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

activate

Fired when the tool is activated.

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

deactivate

Fired when the tool is deactivated.

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