Geoportal Extension for Itowns API Reference

Class: BoostRelief

itowns.control.BoostRelief

Control to manage globe layers : their order, visibility and relief, and display their informations (title, description, legends, metadata...)

new BoostRelief(brOptions)

Itowns/Controls/BoostRelief.js, line 32
Name Type Description
brOptions Object

control options

Name Type Default Description
scale Object optional

Defines the scale used to boost the relief

Name Type Description
min Number optional

Minimum of the scale - 1 by default

max Number optional

Maximum of the scale - 50 by default

step Number optional

Step of the scale - 1 by default

collapsed Boolean true optional

Specify if widget has to be collapsed (true) or not (false) on globe loading.

defaultBoost Boolean 1 optional

Default boost value applied to the widget and the elevation layers when loaded

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

Extends

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 54

Return the widget's container element.

Returns:
container element.

inherited getGlobe(){Object}

Itowns/Controls/Widget.js, line 104

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

inherited getPosition(){String}

Itowns/Controls/Widget.js, line 94

Return the widget's element position.

Returns:
element position.

inherited getTarget(){HTMLElement}

Itowns/Controls/Widget.js, line 84

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 setTarget(target, position)

Itowns/Controls/Widget.js, line 65

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.