Javascript API 7.x

Namespace: controldef

bu.street. controldef

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

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

Methods

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

Returns a default bu.ControlDefinition for a bu.control.Brightness.

Parameters:
Name Type Argument Description
controlOptions bu.control.SliderOptions <optional>

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

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

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

Returns a default bu.ControlDefinition for a bu.control.Contrast.

Parameters:
Name Type Argument Description
controlOptions bu.control.SliderOptions <optional>

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

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

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

Returns a default bu.ControlDefinition for a bu.control.Switcher that allow to identify features.

Parameters:
Name Type Argument Description
controlOptions bu.control.SwitcherOptions <optional>

Options for the control.
actionOptions bu.street.action.FeatureInfoOptions <optional>

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

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

Returns a default bu.ControlDefinition for a bu.control.Select that sets the viewer in a coordinates or an image ID.

Parameters:
Name Type Argument Description
controlOptions bu.control.SelectOptions <optional>

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

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

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

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

Parameters:
Name Type Argument Description
controlOptions bu.control.LayerSwitcherOptions <optional>

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

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

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

Returns a default bu.ControlDefinition for a bu.control.SingleButton that clears measurements from a viewer.

Parameters:
Name Type Argument Description
controlOptions bu.control.SingleButtonOptions <optional>

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

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

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

Returns a default bu.ControlDefinition for a bu.control.CheckBox that hides or shows label of measurements from a viewer.

Parameters:
Name Type Argument Description
controlOptions bu.control.CheckBoxOptions <optional>

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

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

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

Returns a default bu.ControlDefinition for a bu.control.Switcher that allow to switch between different measurement tools.

Parameters:
Name Type Argument Description
controlOptions bu.control.SwitcherOptions <optional>

Options for the control.
actionOptions bu.street.action.MeasurementsOptions <optional>

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

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

Returns a default bu.ControlDefinition for a bu.control.SingleButton that shows north.

Parameters:
Name Type Argument Description
controlOptions bu.control.SingleButtonOptions <optional>

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

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

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

Returns a default bu.ControlDefinition for a bu.control.Switcher that allow to open a street image.

Parameters:
Name Type Argument Description
controlOptions bu.control.SwitcherOptions <optional>

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

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

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

Returns a default bu.ControlDefinition for a bu.control.SingleButton that creates a screen shot of a street viewer.

Parameters:
Name Type Argument Description
controlOptions bu.control.SingleButtonOptions <optional>

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

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

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

Returns a default bu.ControlDefinition for a bu.control.Spinner.

Parameters:
Name Type Argument Description
controlOptions bu.control.SpinnerOptions <optional>

Options for the control.
actionOptions bu.street.action.SpinnerOptions <optional>

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

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

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

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

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

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

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

Returns a default bu.ControlDefinition for a bu.control.Label that shows viewer angles info.

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

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

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

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

Returns a default bu.ControlDefinition for a bu.control.Label that shows viewer common info.

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

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

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

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

Returns a default bu.ControlDefinition for a bu.control.Zoom.

Parameters:
Name Type Argument Description
controlOptions bu.control.ZoomOptions <optional>

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

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

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

Returns a default bu.ControlDefinition for a bu.control.ZoomSlider.

Parameters:
Name Type Argument Description
controlOptions bu.control.ZoomSliderOptions <optional>

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

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