new ElevationPath(options)
Name | Type | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options | Object |
options for function call.
|
Fires:
- elevationpath:drawstart
- elevationpath:drawend
- elevationpath:compute
- export:compute
Example
var measure = new ol.control.ElevationPath({
export : false,
stylesOptions : {
draw : {
finish : new ol.style.Stroke({
color : "rgba(0, 0, 0, 0.5)",
width : 2
})
},
}
displayProfileOptions : {
apply : ol.control.ElevationPath.DISPLAY_PROFILE_RAW,
}
});
// if you want to pluggued the control Export with options :
var measure = new ol.control.ElevationPath({
export : {
name : "export",
format : "geojson",
title : "Exporter",
menu : false
}
});
Exemples :
- displayProfileOptions.apply : null
- displayProfileOptions.apply : function (elevations, container, context) { // do some stuff... }
- displayProfileOptions.apply : ol.control.ElevationPath.DISPLAY_PROFILE_{LIB_AMCHARTS | LIB_D3 | RAW}
Extends
- ol.control.Control
Members
-
DEFAULT_STYLES
-
Styles applied by default if stylesOptions property is not set.
Methods
-
staticDISPLAY_PROFILE_BY_DEFAULT(data, container, context)
Controls/ElevationPath/ElevationPath.js, line 495 -
Display Profile function used by default : no additonal framework needed.
Name Type Description data Object elevations values for profile
container HTMLElement html container where to display profile
context Object this control object
-
staticDISPLAY_PROFILE_LIB_AMCHARTS(data, container, context)
Controls/ElevationPath/ElevationPath.js, line 432 -
display Profile using Amcharts framework. This method needs AmCharts libraries to be loaded.
Name Type Description data Object collection elevations
container HTMLElement container
context Object this control object
-
staticDISPLAY_PROFILE_LIB_D3(data, container, context)
Controls/ElevationPath/ElevationPath.js, line 455 -
display Profile using D3 javascript framework. This method needs D3 libraries to be loaded.
Name Type Description data Object elevations values for profile
container HTMLElement html container where to display profile
context Object this control object
-
staticDISPLAY_PROFILE_RAW(data, container, context)
Controls/ElevationPath/ElevationPath.js, line 478 -
display Profile without graphical rendering (raw service response)
Name Type Description data Object elevations values for profile
container HTMLElement html container where to display profile
context Object this control object
-
clean(remove)
Controls/ElevationPath/ElevationPath.js, line 704 -
clean
Name Type Description remove Boolean remove layer
-
getActive(){Boolean}
Controls/ElevationPath/ElevationPath.js, line 565 -
Returns true if widget is actived (drawing),
false otherwiseReturns:
- true or false
-
getContainer(){DOMElement}
Controls/ElevationPath/ElevationPath.js, line 634 -
Get container
-
getData(){Object}
Controls/ElevationPath/ElevationPath.js, line 600 -
Get elevation data
Returns:
- elevations
Example
{ type // "elevationpath" greaterSlope // pente max meanSlope // pente moyenne distancePlus // distance cumulée positive distanceMinus // distance cumulée négative ascendingElevation // dénivelé cumulée positive descendingElevation // dénivelé cumulée négative altMin // altitude min altMax // altitude max distance // distance totale unit // unité des mesures de distance points // elevations }
-
getGeoJSON(){String}
Controls/ElevationPath/ElevationPath.js, line 675 -
Get vector layer
Returns:
- GeoJSON format layer
-
getLayer(){ol.layer.Vector}
Controls/ElevationPath/ElevationPath.js, line 643 -
Get layer
-
getStyle(){ol.style}
Controls/ElevationPath/ElevationPath.js, line 696 -
Get default style
-
init()
Controls/ElevationPath/ElevationPath.js, line 728 -
This method is public.
It allows to init the control. -
setActive(active)
Controls/ElevationPath/ElevationPath.js, line 575 -
Actived widget drawing or not
Name Type Description active Boolean true / false
-
setData(data)
Controls/ElevationPath/ElevationPath.js, line 625 -
Set profile data
Name Type Description data * elevations
Example
{ greaterSlope // pente max meanSlope // pente moyenne distancePlus // distance cumulée positive distanceMinus // distance cumulée négative ascendingElevation // dénivelé cumulée positive descendingElevation // dénivelé cumulée négative altMin // altitude min altMax // altitude max distance // distance totale unit // unité des mesures de distance points // elevations }
-
setLayer(layer)
Controls/ElevationPath/ElevationPath.js, line 652 -
Set layer
Name Type Description layer Object ol.layer.Vector profil layer
-
setMap(map)
Controls/ElevationPath/ElevationPath.js, line 514 -
Attach control to map. Overloaded ol.control.Control.setMap() method.
Name Type Description map ol.Map Map.