var boostRelief = new itowns.control.BoostRelief({
     scale : {
         max : 30,
         step : 2
     },
     defaultBoost : 6
})

Extends

• itowns.control.Widget

Methods

getCollapsed(){Boolean}

Itowns/Controls/BoostRelief.js, line 129

Returns true if widget is collapsed (minimize), false otherwise

Returns:

collapsed

inherited getElement(){HTMLElement}

Itowns/Controls/Widget.js, line 55

Return the widget's container element.

Returns:

container element.

inherited getGlobe(){Object}

Itowns/Controls/Widget.js, line 115

Get the globe associated with the widget. Undefined if the widget is not added to a globe.

inherited getOptions(){Object}

Itowns/Controls/Widget.js, line 135

Get the options associated with the widget.

inherited getPosition(){String}

Itowns/Controls/Widget.js, line 105

Return the widget's element position.

Returns:

element position.

inherited getTarget(){HTMLElement}

Itowns/Controls/Widget.js, line 85

Return the widget's target div.

Returns:

target div.

setCollapsed(collapsed)

Itowns/Controls/BoostRelief.js, line 101

Collapse or display control main container

Name	Type	Description
collapsed	Boolean	True to collapse control, False to display it

setGlobe(globe)

Itowns/Controls/BoostRelief.js, line 82

Bind globe to control

Name	Type	Description
globe	GlobeViewExtended	the globe

inherited setOptions(options)

Itowns/Controls/Widget.js, line 145

Set the options of the control

Name	Type	Description
options	Object	Options to associate to the widget.

inherited setTarget(target, position)

Itowns/Controls/Widget.js, line 66

Associates the widget to a specified target div.

Name	Type	Description
target	HTMLElement | String	widget target div html element or target div id.
position	String	html position attribute.