Mapspace API Reference

Namespace: controldef

Mapspace.street. controldef

This is the namespace that contains access to Mapspace.ControlDefinition generators for the Mapspace.street.Viewer.

Source:
mapspace-street/control/bu.street.controldef.jsdoc

Methods

<static> DefaultControls()

Return an array of default Mapspace.ControlDefinition for a Mapspace.street.Viewer.

Source:
mapspace-street/control/controldefs.js
Returns:
Type
Array.<Mapspace.ControlDefinition>

<static> DefaultFeaturePanelActions(control, workspace, viewer, localStorageKey)

Returns the default Mapspace.action.Action to handle feature editions for a given Mapspace.control.FeaturePanel control. The target of these controls usually is outside the viewer and usually there is only one instance of the control in a web app.

Parameters:
Name Type Description
control Mapspace.control.FeaturePanel

The feature edition control.
workspace Mapspace.Workspace

The workspace.
viewer Mapspace.street.Viewer

The viewer.
localStorageKey string

The local storage key to use in the action.
Source:
mapspace-street/control/controldefs.js
Returns:
Type
Array.<Mapspace.action.Action>

<static> DefaultLayerPanelActions(control, workspace, viewer)

Returns the default Mapspace.action.Action to handle a given Mapspace.control.LayerPanel control. The target of these controls usually is outside the viewer and usually there is only one instance of the control in a web app.

Parameters:
Name Type Description
control Mapspace.control.LayerPanel

The layer panel control.
workspace Mapspace.Workspace

The workspace.
viewer Mapspace.street.Viewer

The viewer.
Source:
mapspace-street/control/controldefs.js
Returns:
Type
Array.<Mapspace.action.Action>

<static> DefaultProfile3dPanelActions(control, workspace, viewer, localStorageKey)

Returns the default Mapspace.action.Action to handle profile3d definition for a given Mapspace.control.Profile3dPanel control. The target of these controls usually is outside the viewer and usually there is only one instance of the control in a web app.

Parameters:
Name Type Description
control Mapspace.control.Profile3dPanel

The profile3d panel control.
workspace Mapspace.Workspace

The workspace.
viewer Mapspace.street.Viewer

The viewer.
localStorageKey string

The local storage key to use in the action.
Source:
mapspace-street/control/controldefs.js
Returns:
Type
Array.<Mapspace.action.Action>

<static> DefaultReportPanelActions(control, workspace, viewer, localStorageKey)

Returns the default Mapspace.action.Action to handle reporting for a given Mapspace.control.ReportPanel control. The target of these controls usually is outside the viewer and usually there is only one instance of the control in a web app.

Parameters:
Name Type Description
control Mapspace.control.ReportPanel

The REport panel control.
workspace Mapspace.Workspace

The workspace.
viewer Mapspace.street.Viewer

The viewer.
localStorageKey string

The local storage key to use in the action.
Source:
mapspace-street/control/controldefs.js
Returns:
Type
Array.<Mapspace.action.Action>

<static> DefaultSearchAction(control, viewer)

Returns the default Mapspace.action.Action to handle searches for a given Mapspace.control.Search control. The target of these controls usually is outside the viewer and usually there is only one instance of the control in a web app.

Parameters:
Name Type Description
control Mapspace.control.Control

The search control.
viewer Mapspace.street.Viewer

The viewer.
Source:
mapspace-street/control/controldefs.js
Returns:
Type
Mapspace.action.Action

<static> DefaultStreetPanelActions(control, workspace, viewer, localStorageKey)

Returns the default Mapspace.action.Action to handle Street geometry redefinition for a given Mapspace.control.StreetPanel control. The target of these controls usually is outside the viewer and usually there is only one instance of the control in a web app.

Parameters:
Name Type Description
control Mapspace.control.StreetPanel

The Street panel control.
workspace Mapspace.Workspace

The workspace.
viewer Mapspace.street.Viewer

The viewer.
localStorageKey string

The local storage key to use in the action.
Source:
mapspace-street/control/controldefs.js
Returns:
Type
Array.<Mapspace.action.Action>

<static> LayerSwitcher( [controlOptions] [, actionOptions])

Returns a default Mapspace.ControlDefinition for a Mapspace.control.LayerSwitcher.

Parameters:
Name Type Argument Description
controlOptions Mapspace.control.ControlOptions <optional>

Options for the control.
actionOptions Mapspace.action.ActionOptions <optional>

Options for the action.
Source:
mapspace-street/control/controldefs.js
Returns:
Type
Mapspace.ControlDefinition

<static> ViewerInfo( [controlOptions] [, actionOptions])

Returns a default Mapspace.ControlDefinition for a Mapspace.control.Label that shows information of the viewer.

Parameters:
Name Type Argument Description
controlOptions Mapspace.control.LabelOptions <optional>

Options for the control.
actionOptions Mapspace.street.action.ViewerInfoOptions <optional>

Options for the action.
Source:
mapspace-street/control/controldefs.js
Returns:
Type
Mapspace.ControlDefinition

<static> ViewerMenu( [controlOptions], actionOptions)

Returns an array of default Mapspace.ControlDefinition for a Mapspace.control.ViewerMenu and its subcontrols.

Parameters:
Name Type Argument Description
controlOptions Mapspace.control.ControlOptions <optional>

Options for the control. This options are only for the ViewerMenu, and not for the subcontrols.
actionOptions Mapspace.action.WorkspaceActionOptions

Options for the action. This options are only for the action of the ViewerMenu, and not for the actions of the subcontrols.
Source:
mapspace-street/control/controldefs.js
Returns:
Type
Array.<Mapspace.ControlDefinition>